Get categories with view and cursor Retrieve a paginated list of child categories from the specified catalog using cursor-based pagination and view filtering.

post

https://api-us.bluestonepim.com/pim/catalogs/{id}/nodes/cursor/view

This endpoint allows you to efficiently browse large category trees by specifying a cursor
position and view configuration, supporting filtering by archive state and context.

For more detailed information on managing catalogs and categories in Bluestone PIM, refer to the Create and
manage catalogs and categories article.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The internal ID of the catalog.

Example: 634c26e14cedfd0001775e9f

Query Params

archiveState

string

Specifies the archive state of the entity. The default value is active.

Body Params

The request body containing cursor position and view configuration.

count

int32

1 to 100

Specifies the number of products to return in the result set. Used together with a cursor ID to fetch the next batch of results.

cursor

string | null

views

array | null

Specifies the list of entities views* to be included in the response.

*A view is a subset of category data, like METADATA, ASSETS and DESCRIPTION, to be included in the response, if no views are specified in the request, only category IDs will be returned.

Note: The METADATA view includes these properties in the response:

    "metadata": {
        "name": {
          "value": {
            "en": "Category 11"
          }
        },
        "number": "11",
        "parentId": "69cbbb0eddb0f6ae88c55e47",
        "readOnly": false
      }

views

Headers

context

string

Specifies the context in which to operate. If omitted, the default context en is used.

In Bluestone PIM, the context is generally synonymous with the language setting. The context determines how product information is tailored and presented based on language or other local specifications.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: The default context is identified by the ID "en". IDs for additional contexts begin with a lowercase "L", not with the digit "1", followed by a number. This naming convention helps distinguish between default and custom contexts within Bluestone PIM.

context-fallback

boolean

Specifies whether to enable the fallback mechanism for the context. If omitted, the default value true will be used. When set to true, the system will provide a default translation or relevant information if the requested context's specific translation is missing.

For more detailed information on how context relates to language settings in Bluestone PIM, refer to the Languages and Context documentation.

Note: Setting the context-fallback parameter to false disables the fallback mechanism. In this configuration, if a translation or specific context information is not available, the system will not provide an alternative or default content. This ensures that only content that matches the exact context ID requested is returned, potentially leading to cases where no content is available if the specific translation is missing.

Responses

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK This response indicates a successful retrieval of the category nodes. The response body contains the list of child categories along with a cursor pointing to the last element for subsequent requests.

400Bad Request This response indicates that the server could not understand the request due to invalid syntax. It is typically triggered by client-side input errors such as improperly formatted requests, missing required fields, or invalid data values.

404Not Found This response indicates that the requested resource could not be found on the server. It typically occurs when no resource matches the requested URI, or the resource identifier used in the request does not exist.