Skip to content
docs
Guides
ES
CatalogSpecifications
catalog:read

List specifications

Lists specifications by cursor, with search, level, type, and repeated ID filters.

GET/v1/catalog/specifications

Lists specifications by cursor, with search, level, type, and repeated ID filters.

Authorization

bearerAuth
AuthorizationBearer <token>

OAuth2 access token issued by Ecomiq Auth.

In: header

Query Parameters

limit?integer

Maximum number of results to return.

Formatint32
cursor?string

Opaque cursor from the previous response. Omit it on the first page.

search?string

Free-text filter. Which fields it covers depends on the resource.

sortBy?string

Field to sort by. Accepted values depend on the resource.

sortDirection?string

Sort direction: asc or desc.

Value in

  • "asc"
  • "desc"
level?string

Value in

  • "product"
  • "variant"
  • "store"
  • "seller"
  • "all"
type?string

Only this type.

Value in

  • "input"
  • "textArea"
  • "select"
  • "checkbox"
  • "colorPicker"
  • "datePicker"
  • "timePicker"
  • "dateTimePicker"
  • "file"
ids?array<ResourceId>

Only these identifiers.

Header Parameters

x-Store-Id?string

Store the request acts on. Not needed when the token is bound to a store.

Authorization*string

OAuth 2.0 bearer token.

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/v1/catalog/specifications" \  -H "x-Store-Id: <store-id>" \  -H "Authorization: Bearer <token>"
{  "data": [    {      "id": "7204558912004325301",      "storeId": "7204558912004325301",      "name": "Example resource",      "key": "example",      "aliases": [        "example"      ],      "isMultiple": false,      "isRequired": false,      "isFilterable": false,      "isSearchable": false,      "order": 1,      "status": "inactive",      "type": "input",      "level": "product",      "values": [        {          "id": "7204558912004325301",          "value": "example",          "name": "Example resource",          "isDefault": false,          "order": 1        }      ],      "metadata": {},      "createdOn": "2026-08-01T15:30:00Z"    }  ],  "hasNextPage": false,  "nextCursor": "example",  "totalCount": 1}