Next Commerce
API ReferenceProducts

Categories List

Retrieve a list of categories.

GET
/categories/

Authorization

oauth2 catalogue:read
AuthorizationBearer <token>

Generate an Access Token through Settings > API Access for single store access or use the Authorization Code flow with your partner App Client ID. Use required permission scopes for API endpoint access. Example Authorization: Bearer 123

In: header

Scope: catalogue:read

Query Parameters

cursor?string

The pagination cursor value.

Header Parameters

X-29next-API-Version*string
Default"2024-04-01"
Value in"2024-04-01"

Response Body

application/json

curl -X GET "https://example.29next.store/api/admin/categories/" \
  -H "X-29next-API-Version: 2024-04-01" \
  -H "Authorization: Bearer "
{
  "next": "http://api.example.org/accounts/?cursor=cD00ODY%3D\"",
  "previous": "http://api.example.org/accounts/?cursor=cj0xJnA9NDg3",
  "results": [
    {
      "description": "string",
      "external_tax_code": "string",
      "id": 0,
      "image": "http://example.com",
      "is_public": true,
      "meta_description": "string",
      "meta_title": "string",
      "name": "string",
      "slug": "string",
      "template": "string"
    }
  ]
}