Own Shopify? Customize your docs with AI search, analytics, and more.

Claim your docs

GET

Retrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

https://shopify.com/admin/api/2020-01/custom_collections.json

https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-01

Access Token Required: API Key

Query Params

limitstring

The maximum number of results to retrieve. (default: 50, maximum: 250)

idsstring

Show only collections specified by a comma-separated list of IDs.

since_idstring

Restrict results to after the specified ID.

titlestring

Show custom collections with a given title.

product_idstring

Show custom collections that include a given product.

handlestring

Filter by custom collection handle.

updated_at_minstring

Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).

updated_at_maxstring

Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).

published_at_minstring

Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).

published_at_maxstring

Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).

published_statusstring

Show custom collectsion with a given published status. (default: any) published: Show only published custom collections. unpublished: Show only unpublished custom collections. any: Show custom collections of any published status.

fieldsstring

Show only certain fields, specified by a comma-separated list of field names.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://shopify.com/admin/api/2020-01/custom_collections.json' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

GET

Retrieves a list of custom collections. Note: As of version 2019-10, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.

https://shopify.com/admin/api/2020-01/custom_collections.json

https://shopify.dev/docs/admin-api/rest/reference/products/customcollection#index-2020-01

Access Token Required: API Key

Query Params

limitstring

The maximum number of results to retrieve. (default: 50, maximum: 250)

idsstring

Show only collections specified by a comma-separated list of IDs.

since_idstring

Restrict results to after the specified ID.

titlestring

Show custom collections with a given title.

product_idstring

Show custom collections that include a given product.

handlestring

Filter by custom collection handle.

updated_at_minstring

Show custom collections last updated after date (format: 2014-04-25T16:15:47-04:00).

updated_at_maxstring

Show custom collections last updated before date (format: 2014-04-25T16:15:47-04:00).

published_at_minstring

Show custom collections published after date (format: 2014-04-25T16:15:47-04:00).

published_at_maxstring

Show custom collections published before date (format: 2014-04-25T16:15:47-04:00).

published_statusstring

Show custom collectsion with a given published status. (default: any) published: Show only published custom collections. unpublished: Show only unpublished custom collections. any: Show custom collections of any published status.

fieldsstring

Show only certain fields, specified by a comma-separated list of field names.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'https://shopify.com/admin/api/2020-01/custom_collections.json' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}