Skip to content
Esc
↑↓navigate↵open⌘Jpreview

List Categories

Retrieves a paginated list of categories for an app with optional search, sorting, and filtering capabilities

GET/api/v1/{team_slug}/{app_slug}/categories
Authorization
AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters
app_slugstringrequired

App slug

team_slugstringrequired

Team slug

Query parameters
searchstring

Search on category name

pageinteger

Page number (default is 1)

per-pageinteger

Amount of products per page. Minimum 0 and max 100 (default is 20)

sort-orderstring

Sort order. Should be one of ASC or DESC. Default DESC

sort-keystring

The key to sort on. Can be one of name, sort_order, created-at, updated-at (Default is created-at)

idstring[]

Filter by category IDs (can be repeated)

attribute-idstring[]

Filter by attribute IDs

Responses
200

Categories list

datagithub_com_enadhq_nabbit_internal_pkg_webserver_models.Category[]required
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Category
attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute
created_atstring
descriptionstring | null
filterableboolean | null
idstring
keystring
namestring | null
template_keystring
template_namestring
translatableboolean | null
translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.AttributeTranslations
Show properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]
namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]
updated_atstring | null
valuesobject | null
childrengithub_com_enadhq_nabbit_internal_pkg_webserver_models.Category[]
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Category
Circular reference to github_com_enadhq_nabbit_internal_pkg_webserver_models.Category.
cover_urlstring
created_atstring
descriptionstring
google_product_category_idstring | null
idstring
namestring
parent_idstring
redirectsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Redirects[] | null
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Redirects
idstring
item_idstring | null
localestring
new_slugstring
old_slugstring
typegithub_com_enadhq_nabbit_internal_pkg_webserver_models.RedirectType
Allowed:productpagecollectioncategoryproduct_bundle
seogithub_com_enadhq_nabbit_internal_pkg_webserver_models.CategorySEO | null
Show properties
Any of:
github_com_enadhq_nabbit_internal_pkg_webserver_models.CategorySEO
meta_descriptionstring
meta_titlestring
null
null
slugstring
sort_orderinteger
statusstring
translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.CategoryTranslations
Show properties
descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]
Show properties
Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Translation
idstring
localestring
valuestring
meta_descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]
meta_titlegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]
namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null
sluggithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[] | null
updated_atstring | null
uristring | null
successboolean
totalinteger
total_pagesinteger
400

Invalid request (e.g. bad UUID, validation error)

detailsstring[]
messagestring
successbooleanrequired
401

Unauthorized access

detailsstring[]
messagestring
successbooleanrequired
500

Internal server error

detailsstring[]
messagestring
successbooleanrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.enad.io/api/v1/string/string/categories' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "attributes": [
        {
          "created_at": "string",
          "description": "string",
          "filterable": true,
          "id": "string",
          "key": "string",
          "name": "string",
          "template_key": "string",
          "template_name": "string",
          "translatable": true,
          "translations": {
            "description": [
              {
                "id": "string",
                "locale": "string",
                "value": "string"
              }
            ],
            "name": [
              {
                "id": "string",
                "locale": "string",
                "value": "string"
              }
            ]
          },
          "updated_at": "string",
          "values": {
            "property1": {
              "field_id": "string",
              "id": "string",
              "image_id": "string",
              "image_object": {
                "alt": "string",
                "app_id": "string",
                "blurhash": "string",
                "copyright": "string",
                "custom": {
                  "property1": "string",
                  "property2": "string"
                },
                "folder_id": "string",
                "id": "string",
                "parent_id": "string",
                "public": true,
                "status": "string",
                "title": "string",
                "url": "string"
              },
              "translations": {
                "value": [
                  {
                    "id": "string",
                    "locale": "string",
                    "value": "string"
                  }
                ]
              },
              "type": "string",
              "value": "string"
            },
            "property2": {
              "field_id": "string",
              "id": "string",
              "image_id": "string",
              "image_object": {
                "alt": "string",
                "app_id": "string",
                "blurhash": "string",
                "copyright": "string",
                "custom": {
                  "property1": "string",
                  "property2": "string"
                },
                "folder_id": "string",
                "id": "string",
                "parent_id": "string",
                "public": true,
                "status": "string",
                "title": "string",
                "url": "string"
              },
              "translations": {
                "value": [
                  {
                    "id": "string",
                    "locale": "string",
                    "value": "string"
                  }
                ]
              },
              "type": "string",
              "value": "string"
            }
          }
        }
      ],
      "children": [
        {}
      ],
      "cover_url": "string",
      "created_at": "string",
      "description": "string",
      "google_product_category_id": "string",
      "id": "string",
      "name": "string",
      "parent_id": "string",
      "redirects": [
        {
          "id": "string",
          "item_id": "string",
          "locale": "string",
          "new_slug": "string",
          "old_slug": "string",
          "type": "product"
        }
      ],
      "seo": {
        "meta_description": "string",
        "meta_title": "string"
      },
      "slug": "string",
      "sort_order": 0,
      "status": "string",
      "translations": {
        "description": [
          {
            "id": "string",
            "locale": "string",
            "value": "string"
          }
        ],
        "meta_description": [
          {
            "id": "string",
            "locale": "string",
            "value": "string"
          }
        ],
        "meta_title": [
          {
            "id": "string",
            "locale": "string",
            "value": "string"
          }
        ],
        "name": [
          {
            "id": "string",
            "locale": "string",
            "value": "string"
          }
        ],
        "slug": [
          {
            "id": "string",
            "locale": "string",
            "value": "string"
          }
        ]
      },
      "updated_at": "string",
      "uri": "string"
    }
  ],
  "success": true,
  "total": 0,
  "total_pages": 0
}