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

Get Custom Entities Metadata

Request

The metadata is a JSON Schema document that lists the Custom Entities defined in the PIM for the current tenant, together with their relationships. Use the returned denominators to query individual Custom Entity schemas via GET /CustomEntities('{denominator}')/$metadata.

Authentication

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

Response

200 OK — Returns the JSON Schema as a ServiceDocumentRepresentation.

Error Responses

  • 401 Unauthorized — Missing or invalid API key. Returned by the API gateway as { "message": "Unauthorized", "request_id": "d8aafa5b8f3e400b60bea0123dd33317" }.
  • 404 Not Found — Tenant not found.
  • 500 Internal Server Error — Unexpected technical error.

Example

Request:

GET /CustomEntities/$metadata HTTP/1.1
X-API-KEY: your-api-key-here

Response:

HTTP/1.1 200 OK
Content-Type: application/json
Headers
X-API-KEYstring

Tenant's API key (required)

GET
/CustomEntities/$metadata
curl -i -X GET \
  'https://api2.saleslayer.com/catalog/CustomEntities/$metadata' \
  -H 'X-API-KEY: string'

Responses

OK

Bodyapplication/json
valueany or null
Response
{
  "readLink": {
    "uri": "http://example.com"
  },
  "value": null
}