Filter Custom Entities

API Reference

Request

Filters the items of a Custom Entity type, identified by its denominator, returning the matching resources as a collection. Supports OData query options for selecting, expanding, filtering, ordering and paging the results.

Authentication

Requires a valid API key in the X-API-KEY header.

Headers

Accept-Language

Indicates the preferred natural language and locale for the localized content:

culture-code (e.g. es, en-us) — returns content localized in the specified culture.
null / not set — returns content localized in the default culture.
* — currently disabled.

Multiple culture codes or q-factor weighting are not supported.

OData Query Support

The endpoint supports a subset of OData v4.01 URI conventions. The full list of available properties can be obtained from GET /CustomEntities('{denominator}')/$metadata.

`$select`

Comma-separated list of Custom Entity properties (implicit or custom) to include in the result. Selection of properties inside embedded resources/collections is not supported.

Example: abcd_description
Example: abcd_description,abcd_tags

`$expand`

Comma-separated list of embedded collections to include in the result (when applicable). By default, embedded collections are not included. Only embedded collections are supported (not embedded resources).

`$filter`

Boolean expression applied on root resource properties. Filtering on nested resource properties is not supported.

Logical operators: eq, ne, gt, lt, ge, le, or, and, in
String functions: contains, startswith, endswith
Supported value types: integer, big integer, double, decimal, string, date, datetimeoffset

`$orderby`

Sorting expression on a single root resource property. Multiple properties and embedded properties are not supported. Format: PROPERTY (asc|desc). Default direction is asc.

Example: abcd_description asc

`$top`

Page size. Maximum and default is 100 items.

`$skip`

Offset for the limit-and-offset paging strategy (used together with $top). Recommended when $orderby is required.

`$skipToken`

Continuation token for the continuation-token paging strategy. Faster than limit-and-offset but does not support $orderby.

Response

200 OK — Returns a CollectionRepresentation with the matching Custom Entity resources.

Error Responses

400 Bad Request — Invalid OData expression or query parameter.
401 Unauthorized — Missing or invalid API key. Returned by the API gateway as { "message": "Unauthorized", "request_id": "d8aafa5b8f3e400b60bea0123dd33317" }.
404 Not Found — Tenant or Custom Entity not found.
500 Internal Server Error — Unexpected technical error.

Example

Request:

GET /CustomEntities('Brand')?$select=abcd_description&$top=10 HTTP/1.1
X-API-KEY: your-api-key-here
Accept-Language: es

Response:

HTTP/1.1 200 OK
Content-Type: application/json

Path

customEntityDenominatorstringrequired

Custom Entity denominator (natural language name as defined in the PIM)

Query

$filterstring

$orderbystring

$skipinteger, (int64)

$skipTokenstring

$topinteger, (int64)

$selectstring

$expandstring

X-API-KEYstring

Tenant's API key (required)

Accept-Languagestring

Preferred localization culture (e.g. es, en-us)

GET

/CustomEntities('{customEntityDenominator}')

curl -i -X GET \
  'https://api2.saleslayer.com/catalog/CustomEntities('\''{customEntityDenominator}'\'')?%24filter=string&%24orderby=string&%24skip=0&%24skipToken=string&%24top=0&%24select=string&%24expand=string' \
  -H 'Accept-Language: string' \
  -H 'X-API-KEY: string'

Responses

Bodyapplication/json

@readLinkstring or null

@nextLinkstring or null

@deltaLinkstring or null

@contextstring or null

valueany or null

@countinteger or null, (int64)

Response

{
  "@readLink": "string",
  "@nextLink": "string",
  "@deltaLink": "string",
  "@context": "string",
  "value": null,
  "@count": 0
}