Skip to content
API Reference
/
/
Get Custom Entities Chang...

Get Custom Entities Changelog

Request

Returns the changelog entries for a Custom Entity type, identified by its denominator, as a collection. Supports OData query options to filter, order and page the results.

Authentication

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

OData Query Support

Supports $filter, $orderby, $top, $skip over the changelog fields. $select, $expand and $skipToken are not supported by this endpoint.

Response

200 OK — Collection of changelog entries for the specified Custom Entity type.

Error Responses

  • 400 Bad Request — Invalid OData expression.
  • 401 Unauthorized — Missing or invalid API key. Returned by the API gateway as { "message": "Unauthorized", "request_id": "d8aafa5b8f3e400b60bea0123dd33317" }.
  • 500 Internal Server Error — Unexpected technical error.

Example

Request:

GET /CustomEntities('Brand')/Changelog?$top=20 HTTP/1.1
X-API-KEY: your-api-key-here

Response:

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

Custom Entity denominator (natural language name from the PIM)

Query
$filterstring

OData $filter expression

$orderbystring

OData $orderby expression

$topinteger, (int64)

OData $top page size

$skipinteger, (int64)

OData $skip offset

Headers
X-API-KEYstring

Tenant's API key (required)

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

Responses

OK

Bodyapplication/json
@contextstring or null
valueany or null
@countinteger or null, (int64)
Response
{
  "@readLink": "string",
  "@nextLink": "string",
  "@deltaLink": "string",
  "@context": "string",
  "value": null,
  "@count": 0
}