# List Products

- **URL:** https://marketplace.gohighlevel.com/docs/ghl/products/list-invoices
- **Summary:** The 'List Products' API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information.

[Skip to main content](https://marketplace.gohighlevel.com/docs/ghl/products/list-invoices#__docusaurus_skipToContent_fallback)

Version: v3

List Products
=============

GET 

https://services.leadconnectorhq.com/products/

Copy for LLMView as MarkdownOpen in ClaudeOpen in ChatGPTOpen in Cursor

The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information.

### Requirements

#### Scope(s)

`products.readonly`

#### Auth Method(s)

`OAuth Access Token``Private Integration Token`

#### Token Type(s)

`Sub-Account Token``Agency Token`

Request[​](https://marketplace.gohighlevel.com/docs/ghl/products/list-invoices#request "Direct link to request")

### Header Parameters

**Version** stringrequired

**Possible values:** \[`v3`\]

API Version

### Query Parameters

**limit** number

The maximum number of items to be included in a single page of results

Default value:`0`

**Example:** `20`

**offset** number

The starting index of the page, indicating the position from which the results should be retrieved.

Default value:`0`

**Example:** `0`

**locationId** stringrequired

LocationId is the id of the sub-account

**Example:** `3SwdhCu3svxI8AKsPJt6`

**search** string

The name of the product for searching.

**Example:** `Awesome product`

**collectionIds** string

Filter by product category Ids. Supports comma separated values

**collectionSlug** string

The slug value of the collection by which the collection would be searched

**expand** string\[\]

Name of an entity whose data has to be fetched along with product. Possible entities are tax, stripe and paypal. If not mentioned, only ID will be returned in case of taxes

**productIds** string\[\]

List of product ids to be fetched.

**storeId** string

fetch and project products based on the storeId

**Example:** `3SwdhCu3svxI8AKsPJt6`

**includedInStore** boolean

Separate products by which are included in the store and which are not

**Example:** `true`

**availableInStore** boolean

If the product is included in the online store

**Example:** `true`

**sortOrder** string

**Possible values:** \[`asc`, `desc`\]

The order of sort which should be applied for the date

**Example:** `desc`

Responses[​](https://marketplace.gohighlevel.com/docs/ghl/products/list-invoices#responses "Direct link to Responses")

*   200
*   400
*   401
*   422

Successful response

*   application/json

*   Schema
*   Example (auto)

**Schema**

**products** object\[\]required

An array of products

*   Array \[\
    \
\
**_id**stringrequired\
\
The unique identifier for the product.\
\
**Example:** `655b33a82209e60b6adb87a5`\
\
**description**string\
\
product description\
\
**Example:** `This is a really awesome product`\
\
**variants** object\[\]\
\
An array of variants for the product.\
\
*   Array \[\
    \
\
**id**stringrequired\
\
A unique identifier for the variant.\
\
**Example:** `38s63qmxfr4`\
\
**name**stringrequired\
\
The name of the variant.\
\
**Example:** `Size`\
\
**options** object\[\]required\
\
An array of options for the variant.\
\
*   Array \[\
    \
\
**id**stringrequired\
\
The unique identifier for the option.\
\
**Example:** `h4z7u0im2q8`\
\
**name**stringrequired\
\
The name of the option.\
\
**Example:** `XL`\
\
*   \]\
    \
\
*   \]\
    \
\
**locationId**stringrequired\
\
The unique identifier for the location.\
\
**Example:** `3SwdhCsvxI8Au3KsPJt6`\
\
**name**stringrequired\
\
The name of the product.\
\
**Example:** `Awesome Product`\
\
**productType**stringrequired\
\
The type of the product (e.g., PHYSICAL).\
\
**Example:** `PHYSICAL`\
\
**availableInStore**boolean\
\
Indicates whether the product is available in-store.\
\
**Example:** `true`\
\
**createdAt**string<date-time>required\
\
The creation timestamp of the product.\
\
**Example:** `2023-11-20T10:23:36.515Z`\
\
**updatedAt**string<date-time>required\
\
The last update timestamp of the product.\
\
**Example:** `2024-01-23T09:57:04.846Z`\
\
**statementDescriptor**string\
\
The statement descriptor for the product.\
\
**Example:** `abcde`\
\
**image**string\
\
The URL for the product image.\
\
**Example:** `https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png`\
\
**collectionIds**string\[\]\
\
An array of category Ids for the product\
\
**Example:** `["65d71377c326ea78e1c47df5","65d71377c326ea78e1c47d34"]`\
\
**isTaxesEnabled**boolean\
\
The field indicates whether taxes are enabled for the product or not.\
\
**Default value:** `false`\
\
**Example:** `true`\
\
**taxes**string\[\]\
\
An array of ids of Taxes attached to the Product. If the expand query includes tax, the taxes will be of type `ProductTaxDto`. Please refer to the `ProductTaxDto` for additional details.\
\
**Example:** `["654492a4e6bef380114de15a"]`\
\
**automaticTaxCategoryId**string\
\
Tax category ID for Automatic taxes calculation.\
\
**Example:** `65d71377c326ea78e1c47df5`\
\
**label** object\
\
The Product label details\
\
**title**stringrequired\
\
The content for the product label.\
\
**Example:** `Featured`\
\
**startDate**string\
\
Start date in YYYY-MM-DDTHH:mm:ssZ format\
\
**Example:** `2024-06-26T05:43:35.000Z`\
\
**endDate**string\
\
Start date in YYYY-MM-DDTHH:mm:ssZ format\
\
**Example:** `2024-06-30T05:43:39.000Z`\
\
**slug**string\
\
The slug of the product by which the product will be navigated\
\
**Example:** `washing-machine`\
\
*   \]
    

**total** object\[\]required

list products status

*   Array \[\
    \
\
**total**numberrequired\
\
Total number of products\
\
**Example:** `20`\
\
*   \]
    

    {  "products": [    {      "_id": "655b33a82209e60b6adb87a5",      "description": "This is a really awesome product",      "variants": [        {          "id": "38s63qmxfr4",          "name": "Size",          "options": [            {              "id": "h4z7u0im2q8",              "name": "XL"            }          ]        }      ],      "locationId": "3SwdhCsvxI8Au3KsPJt6",      "name": "Awesome Product",      "productType": "PHYSICAL",      "availableInStore": true,      "createdAt": "2023-11-20T10:23:36.515Z",      "updatedAt": "2024-01-23T09:57:04.846Z",      "statementDescriptor": "abcde",      "image": "https://storage.googleapis.com/ghl-test/3SwdhCsvxI8Au3KsPJt6/media/65af8d5df88bdb4b1022ee90.png",      "collectionIds": [        "65d71377c326ea78e1c47df5",        "65d71377c326ea78e1c47d34"      ],      "isTaxesEnabled": true,      "taxes": [        "654492a4e6bef380114de15a"      ],      "automaticTaxCategoryId": "65d71377c326ea78e1c47df5",      "label": {        "title": "Featured",        "startDate": "2024-06-26T05:43:35.000Z",        "endDate": "2024-06-30T05:43:39.000Z"      },      "slug": "washing-machine"    }  ],  "total": [    {      "total": 20    }  ]}
> Common reference appendix (shared error/status catalog): see [../_shared-appendix.md](../_shared-appendix.md).
**name:** [Authorization](https://marketplace.gohighlevel.com/docs/ghl/products/products-api#authentication)
**type:** http**scopes:** `products.readonly`**scheme:** bearer**bearerFormat:** JWT**in:** header**description:** Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

*   curl
*   nodejs
*   python
*   php
*   java
*   go
*   ruby
*   powershell

*   CURL

    curl -L 'https://services.leadconnectorhq.com/products/?locationId=3SwdhCu3svxI8AKsPJt6&search=Awesome%20product&storeId=3SwdhCu3svxI8AKsPJt6&includedInStore=true&availableInStore=true&sortOrder=desc' \-H 'Accept: application/json' \-H 'Authorization: Bearer <Authorization>'

RequestCollapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Security SchemeLocation-AccessAgency-Access

Bearer Token

Parameters

locationId — queryrequired

Version — headerrequired\---v3

Show optional parameters

limit — query

offset — query

search — query

collectionIds — query

collectionSlug — query

expand — queryAdd item

productIds — queryAdd item

storeId — query

includedInStore — query\---truefalse

availableInStore — query\---truefalse

sortOrder — query\---ascdesc

Send API Request

ResponseClear

Click the `Send API Request` button above and see the response here!