# List Catalog Items Search

This method searches for items in your [product catalog](https://support.pandadoc.com/en/articles/9714691-product-catalog).

Use the `query` parameter to search in title, SKU, description, category name, custom fields name and value. You can also search for items by their type, billing type, and category id.

Order search results, in both ascending and descending order, by these item properties:

- SKU
- Name
- Price
- Modification date

Use the `exclude_uuids` parameter to exclude particular uuids from the search request.


# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "PandaDoc Public API",
    "description": "PandaDoc API spans a broad range of functionality to help you build incredible documents automation experiences inside your product.\n\nPandaDoc API is organized around REST. Our API has predictable resource-oriented URLs and uses standard HTTP response codes, authentication, and verbs.\n\n## Getting started\n\nYou can start testing PandaDoc API with a sandbox key on our [Enterprise](https://www.pandadoc.com/pricing/) plan, either active or in trial.\n\nGenerate your [sandbox key](https://developers.pandadoc.com/reference/sandbox-key) on the Developer Dashboard with predefined [rate limits](https://developers.pandadoc.com/reference/limits). Or contact our solutions expert if you work with high-transaction volumes.\n\n## Guides\n\nIf you’re just getting started with PandaDoc, you may want to jump straight into one of our [getting started guides](https://developers.pandadoc.com/docs/getting-started) for the feature you’re most interested in, whether that’s:\n\n- [Create from template](https://developers.pandadoc.com/docs/create-send-document),\n- [Upload and send a local PDF](https://developers.pandadoc.com/docs/upload-and-send-a-local-pdf),\n- or [Listening for changes in document status](https://developers.pandadoc.com/docs/listen-document-status-changes).\n\nWe also recommend you to discover our dynamic content generation on a fly: [Create from a template with content placeholder](https://developers.pandadoc.com/docs/create-with-content-placeholders-from-template).\n",
    "termsOfService": "https://www.pandadoc.com/master-services-agreement/",
    "contact": {
      "name": "PandaDoc API Support",
      "url": "https://developers.pandadoc.com/",
      "email": "api-track@pandadoc.com"
    },
    "license": {
      "name": "MIT",
      "url": "https://github.com/PandaDoc/pandadoc-openapi-specification/blob/main/LICENSE"
    },
    "version": "7.18.2"
  },
  "servers": [
    {
      "url": "https://api.pandadoc.com",
      "description": "Public API"
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "oauth2": []
    }
  ],
  "tags": [
    {
      "name": "Product catalog",
      "description": "Operations for managing product catalog items, including creation and retrieval."
    }
  ],
  "paths": {
    "/public/v2/product-catalog/items/search": {
      "get": {
        "tags": [
          "Product catalog"
        ],
        "summary": "List Catalog Items Search",
        "operationId": "searchCatalogItems",
        "description": "This method searches for items in your [product catalog](https://support.pandadoc.com/en/articles/9714691-product-catalog).\n\nUse the `query` parameter to search in title, SKU, description, category name, custom fields name and value. You can also search for items by their type, billing type, and category id.\n\nOrder search results, in both ascending and descending order, by these item properties:\n\n- SKU\n- Name\n- Price\n- Modification date\n\nUse the `exclude_uuids` parameter to exclude particular uuids from the search request.\n",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "description": "Page number.",
            "schema": {
              "type": "number"
            },
            "example": 1
          },
          {
            "name": "per_page",
            "in": "query",
            "description": "Items per page.",
            "schema": {
              "type": "number"
            },
            "example": 10
          },
          {
            "name": "query",
            "in": "query",
            "description": "Search query. Searches the following fields: Title, SKU, description, category name, custom fields name and value.\n",
            "schema": {
              "type": "string"
            },
            "example": "coffee"
          },
          {
            "name": "order_by",
            "in": "query",
            "description": "Ordering principle for displaying search results.",
            "schema": {
              "type": "string",
              "enum": [
                "sku",
                "-sku",
                "title",
                "-title",
                "price",
                "-price",
                "date_modified",
                "-date_modified"
              ]
            },
            "example": "-date_modified"
          },
          {
            "name": "types",
            "in": "query",
            "description": "Filter by catalog item types.",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/ProductCatalogTypeEnum"
              }
            },
            "example": [
              "regular"
            ]
          },
          {
            "name": "billing_types",
            "in": "query",
            "description": "Filter by billing types.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "one_time",
                  "recurring"
                ]
              }
            },
            "example": [
              "one_time"
            ]
          },
          {
            "name": "exclude_uuids",
            "in": "query",
            "description": "A list of item uuids to be excluded from search.",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "example": [
              "1725f759-3a1c-64e3-2daa-f67eafa589d7",
              "06cb0ce9-094b-1f38-2fe6-0a9d226cd22c"
            ]
          },
          {
            "name": "category_id",
            "in": "query",
            "description": "Category id.",
            "schema": {
              "type": "string"
            },
            "example": "06cb0ce9-094b-1f38-2fe6-0a9d226cd22c"
          },
          {
            "name": "no_category",
            "in": "query",
            "schema": {
              "type": "boolean"
            },
            "example": true
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated catalog items",
            "content": {
              "application/json": {
                "examples": {
                  "List Catalog Items": {
                    "value": {
                      "items": [
                        {
                          "billing_cycle": null,
                          "billing_type": "one_time",
                          "bundle_items_count": 0,
                          "workspace_id": "n7SK7prHeoWJsmb9VkrPve",
                          "category_id": "0ac5f88a-bdd6-4836-304d-28d042b8d3a2",
                          "category_name": "Sample product",
                          "created_by": "FA5QAu8UGA3oVDQZuPL75B",
                          "currency": "USD",
                          "custom_fields": [],
                          "date_created": "2023-02-01T10:55:07+00:00",
                          "date_modified": "2023-02-01T10:55:07+00:00",
                          "description": "Its exceptionally effective vacuum brewing method extracts all precious oils of your favorite coffee. In addition, the brewing time and temperature are perfectly calibrated, ensuring a perfect cup of coffee with each brew.",
                          "image_src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/81361512-488e-42c8-8c13-5e61b8a27638/1.jpeg",
                          "images": [
                            {
                              "src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/81361512-488e-42c8-8c13-5e61b8a27638/1.jpeg",
                              "order": 0,
                              "is_main": true
                            },
                            {
                              "src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/a0aca18e-8074-4698-aadb-3f41c1bd6a88/2.jpeg",
                              "order": 1,
                              "is_main": false
                            }
                          ],
                          "max_tier_value": null,
                          "min_tier_value": null,
                          "modified_by": "FA5QAu8UGA3oVDQZuPL75B",
                          "price": 250,
                          "pricing_method": 0,
                          "sku": "coffee_maker",
                          "title": "Siphon vacuum coffee maker",
                          "type": "regular",
                          "uuid": "1725f759-3a1c-64e3-2daa-f67eafa589d7",
                          "highlights": null,
                          "tiers": null,
                          "cost": 100
                        },
                        {
                          "billing_cycle": null,
                          "billing_type": "one_time",
                          "bundle_items_count": 0,
                          "workspace_id": "n7SK7prHeoWJsmb9VkrPve",
                          "category_id": "0ac5f88a-bdd6-4836-304d-28d042b8d3a2",
                          "category_name": "Sample product",
                          "created_by": "FA5QAu8UGA3oVDQZuPL75B",
                          "currency": "USD",
                          "custom_fields": [],
                          "date_created": "2023-02-01T10:55:07+00:00",
                          "date_modified": "2023-02-01T10:55:07+00:00",
                          "description": "Double-layer Filter: Dual layers of 304 stainless steel allow fine oils from coffee powder to infuse themselves into your coffee, creating a richer, fuller flavor and no coffee ground deposits",
                          "image_src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/b593eb9a-74cd-40a0-8c38-6a9d39248d3d/3.jpeg",
                          "images": [
                            {
                              "src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/b593eb9a-74cd-40a0-8c38-6a9d39248d3d/3.jpeg",
                              "order": 0,
                              "is_main": true
                            },
                            {
                              "src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/ea09bd4a-c619-4b3e-8f99-f1a2180a97a8/4.jpeg",
                              "order": 1,
                              "is_main": false
                            },
                            {
                              "src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/6e6312f8-787d-4453-8772-ac81f481be00/5.jpeg",
                              "order": 2,
                              "is_main": false
                            }
                          ],
                          "max_tier_value": null,
                          "min_tier_value": null,
                          "modified_by": "FA5QAu8UGA3oVDQZuPL75B",
                          "price": 100,
                          "pricing_method": 0,
                          "sku": "coffee_brewer",
                          "title": "Jittermaster coffee brewer",
                          "type": "regular",
                          "uuid": "06cb0ce9-094b-1f38-2fe6-0a9d226cd22c",
                          "highlights": null,
                          "tiers": null,
                          "cost": 50
                        },
                        {
                          "billing_cycle": null,
                          "billing_type": "one_time",
                          "bundle_items_count": 0,
                          "workspace_id": "n7SK7prHeoWJsmb9VkrPve",
                          "category_id": "0ac5f88a-bdd6-4836-304d-28d042b8d3a2",
                          "category_name": "Sample product",
                          "created_by": "FA5QAu8UGA3oVDQZuPL75B",
                          "currency": "USD",
                          "custom_fields": [],
                          "date_created": "2023-02-01T10:55:07+00:00",
                          "date_modified": "2023-03-17T14:19:12+00:00",
                          "description": "<p>Meticulously crafted in Italy these classic glass coffee mugs or tea cups will complete any barware collection. Contemporary sleek drinking glasses designed to enhance any décor.</p>",
                          "image_src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/6267265d-2b29-4471-8181-c7544e35a69a/6.jpeg",
                          "images": [
                            {
                              "src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/6267265d-2b29-4471-8181-c7544e35a69a/6.jpeg",
                              "order": 0,
                              "is_main": true
                            }
                          ],
                          "max_tier_value": 30,
                          "min_tier_value": 20,
                          "modified_by": "FA5QAu8UGA3oVDQZuPL75B",
                          "price": null,
                          "pricing_method": 1,
                          "sku": "coffee_mug_v2",
                          "title": "Coffee Magic Mug",
                          "type": "regular",
                          "uuid": "ff137b79-e7f6-5710-17d3-c9ea81dac6b6",
                          "highlights": null,
                          "tiers": [
                            {
                              "value": 30,
                              "min_qty": 1
                            },
                            {
                              "value": 20,
                              "min_qty": 21
                            }
                          ],
                          "cost": 5
                        },
                        {
                          "billing_cycle": 1,
                          "billing_type": "recurring",
                          "bundle_items_count": 0,
                          "workspace_id": "n7SK7prHeoWJsmb9VkrPve",
                          "category_id": "0ac5f88a-bdd6-4836-304d-28d042b8d3a2",
                          "category_name": "Sample product",
                          "created_by": "FA5QAu8UGA3oVDQZuPL75B",
                          "currency": "USD",
                          "custom_fields": [],
                          "date_created": "2023-02-01T10:55:07+00:00",
                          "date_modified": "2023-02-01T10:55:07+00:00",
                          "description": "Enjoy a new light roast coffee each month. Box of white chocolate. Up to 20% off retail prices. Pause or cancel anytime.",
                          "image_src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/e818970c-5aa8-4645-941f-04ab0ab5b9b0/7.png",
                          "images": [
                            {
                              "src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/e818970c-5aa8-4645-941f-04ab0ab5b9b0/7.png",
                              "order": 0,
                              "is_main": true
                            }
                          ],
                          "max_tier_value": null,
                          "min_tier_value": null,
                          "modified_by": "FA5QAu8UGA3oVDQZuPL75B",
                          "price": 19,
                          "pricing_method": 0,
                          "sku": "light_coffee",
                          "title": "Light Roast Collection",
                          "type": "regular",
                          "uuid": "646ebcc2-58ba-8eb1-faaa-a93e4542b37b",
                          "highlights": null,
                          "tiers": null,
                          "cost": 5
                        },
                        {
                          "billing_cycle": 1,
                          "billing_type": "recurring",
                          "bundle_items_count": 0,
                          "workspace_id": "n7SK7prHeoWJsmb9VkrPve",
                          "category_id": "0ac5f88a-bdd6-4836-304d-28d042b8d3a2",
                          "category_name": "Sample product",
                          "created_by": "FA5QAu8UGA3oVDQZuPL75B",
                          "currency": "USD",
                          "custom_fields": [],
                          "date_created": "2023-02-01T10:55:07+00:00",
                          "date_modified": "2023-02-01T10:55:07+00:00",
                          "description": "Enjoy a new dark roast coffee each month. Box of white chocolate. Up to 20% off retail prices. Pause or cancel anytime.",
                          "image_src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/6cb41994-5a6e-4253-bc4c-f5e90bb9d7f8/8.png",
                          "images": [
                            {
                              "src": "https://catalog-images.prod.pandadoc-static.com/images/bg78StVWLHzp3tYiubszPb/6cb41994-5a6e-4253-bc4c-f5e90bb9d7f8/8.png",
                              "order": 0,
                              "is_main": true
                            }
                          ],
                          "max_tier_value": null,
                          "min_tier_value": null,
                          "modified_by": "FA5QAu8UGA3oVDQZuPL75B",
                          "price": 19,
                          "pricing_method": 0,
                          "sku": "dark_coffee",
                          "title": "Dark Roast Collection",
                          "type": "regular",
                          "uuid": "0d80ccaf-37e1-ce94-c339-d1f0405c3a62",
                          "highlights": null,
                          "tiers": null,
                          "cost": 5
                        }
                      ],
                      "has_more_items": false,
                      "total": 5
                    }
                  }
                },
                "schema": {
                  "$ref": "#/components/schemas/ListCatalogItemsSearchResponse"
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400BadRequestV2"
          },
          "401": {
            "$ref": "#/components/responses/401AuthErrorV2"
          },
          "403": {
            "$ref": "#/components/responses/403PermissionDeniedV2"
          },
          "429": {
            "$ref": "#/components/responses/429TooManyRequestsV2"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "description": "The `Authorization` header must contain the API key. The value should be prefixed with `API-Key` followed by a space and the actual API key.\n",
        "x-default": "API-Key 3039ba033eb1410caa0a2227158d63c9d6502cd8"
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://app.pandadoc.com/oauth2/authorize",
            "tokenUrl": "https://api.pandadoc.com/oauth2/access_token",
            "refreshUrl": "https://api.pandadoc.com/oauth2/access_token",
            "scopes": {
              "read+write": "Use `read+write` to create, send, delete, and download documents, and `read` to view templates and document details."
            }
          }
        },
        "description": "Send the authenticating user to the PandaDoc OAuth2 request URL. We recommend a button or a link titled\n\"Connect to PandaDoc\" if you are connecting users from a custom application. Users will see the \"Authorize Application\" screen.\nWhen the user clicks \"Authorize\", PandaDoc redirects the user back to your site with an authorization code inside the URL.\n\nhttps://app.pandadoc.com/oauth2/authorize?client_id={client_id}&redirect_uri={redirect_uri}&scope=read+write&response_type=code\n\n`client_id` and `redirect_uri` values should match your application settings.\n"
      }
    },
    "schemas": {
      "ProductCatalogTypeEnum": {
        "type": "string",
        "default": "regular",
        "enum": [
          "regular",
          "bundle"
        ],
        "example": "regular"
      },
      "ProductCatalogSearchCatalogItemResponse": {
        "type": "object",
        "properties": {
          "billing_cycle": {
            "type": "integer",
            "nullable": true
          },
          "billing_type": {
            "type": "string"
          },
          "bundle_items_count": {
            "type": "integer"
          },
          "workspace_id": {
            "type": "string"
          },
          "category_id": {
            "type": "string",
            "nullable": true
          },
          "category_name": {
            "type": "string",
            "nullable": true
          },
          "created_by": {
            "type": "string"
          },
          "cost": {
            "type": "number",
            "nullable": true
          },
          "currency": {
            "type": "string"
          },
          "custom_fields": {
            "type": "array",
            "nullable": true,
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "value": {
                  "type": "string",
                  "nullable": true
                }
              }
            }
          },
          "date_created": {
            "type": "string",
            "format": "date-time"
          },
          "date_modified": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          },
          "description": {
            "type": "string",
            "nullable": true
          },
          "image_src": {
            "type": "string",
            "nullable": true
          },
          "images": {
            "type": "array",
            "nullable": true,
            "items": {
              "type": "object",
              "properties": {
                "is_main": {
                  "type": "boolean",
                  "nullable": true
                },
                "order": {
                  "type": "number"
                },
                "src": {
                  "type": "string"
                }
              }
            }
          },
          "max_tier_value": {
            "type": "number",
            "nullable": true
          },
          "min_tier_value": {
            "type": "number",
            "nullable": true
          },
          "modified_by": {
            "type": "string"
          },
          "price": {
            "type": "number",
            "nullable": true
          },
          "pricing_method": {
            "type": "integer"
          },
          "sku": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "tiers": {
            "type": "array",
            "nullable": true,
            "items": {
              "type": "object",
              "properties": {
                "min_qty": {
                  "type": "number"
                },
                "value": {
                  "type": "number"
                }
              }
            }
          },
          "type": {
            "$ref": "#/components/schemas/ProductCatalogTypeEnum"
          },
          "uuid": {
            "type": "string",
            "format": "uuid"
          },
          "highlights": {
            "type": "object",
            "additionalProperties": {
              "type": "object"
            },
            "nullable": true
          }
        }
      },
      "ListCatalogItemsSearchResponse": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ProductCatalogSearchCatalogItemResponse"
            }
          },
          "has_more_items": {
            "type": "boolean"
          },
          "total": {
            "type": "number"
          }
        }
      }
    },
    "responses": {
      "400BadRequestV2": {
        "description": "Bad Request error",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "code": {
                  "type": "string",
                  "example": "bad_request"
                },
                "details": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string"
                      },
                      "pointer": {
                        "type": "string",
                        "description": "JSON Pointer.",
                        "nullable": true
                      },
                      "data": {
                        "description": "Details data.",
                        "type": "object",
                        "nullable": true,
                        "minProperties": 0,
                        "additionalProperties": true
                      }
                    },
                    "required": [
                      "code"
                    ]
                  },
                  "example": []
                }
              }
            }
          }
        }
      },
      "401AuthErrorV2": {
        "description": "Authentication error",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "code": {
                  "type": "string",
                  "example": "unauthorized"
                },
                "details": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string"
                      },
                      "pointer": {
                        "type": "string",
                        "description": "JSON Pointer.",
                        "nullable": true
                      },
                      "data": {
                        "description": "Details data.",
                        "type": "object",
                        "nullable": true,
                        "minProperties": 0,
                        "additionalProperties": true
                      }
                    },
                    "required": [
                      "code"
                    ]
                  },
                  "example": []
                }
              }
            }
          }
        }
      },
      "429TooManyRequestsV2": {
        "description": "Too many requests error",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "code": {
                  "type": "string",
                  "example": "too_many_requests"
                },
                "details": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string"
                      },
                      "pointer": {
                        "type": "string",
                        "description": "JSON Pointer.",
                        "nullable": true
                      },
                      "data": {
                        "description": "Details data.",
                        "type": "object",
                        "nullable": true,
                        "minProperties": 0,
                        "additionalProperties": true
                      }
                    },
                    "required": [
                      "code"
                    ]
                  },
                  "example": []
                }
              }
            }
          }
        }
      },
      "403PermissionDeniedV2": {
        "description": "Permission error",
        "content": {
          "application/json": {
            "schema": {
              "properties": {
                "code": {
                  "type": "string",
                  "example": "forbidden"
                },
                "details": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "code": {
                        "type": "string"
                      },
                      "pointer": {
                        "type": "string",
                        "description": "JSON Pointer.",
                        "nullable": true
                      },
                      "data": {
                        "description": "Details data.",
                        "type": "object",
                        "nullable": true,
                        "minProperties": 0,
                        "additionalProperties": true
                      }
                    },
                    "required": [
                      "code"
                    ]
                  },
                  "example": []
                }
              }
            }
          }
        }
      }
    }
  }
}
```