Skip to main content
POST
BatchGetEntityOverlays

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
entityIds
string[]

The entities to ask about: 1 to 1000 ids, no duplicates.

An entity_id is opaque. Take one from any listing or search response, or from synq.entities.resolve.v1.IdentifierResolveService if what you hold is a warehouse table name or a model name, and pass it back unchanged. Do not build one yourself or parse one apart — the format carries no meaning you can rely on and is not part of this contract.

Required array length: 1 - 1000 elements
Required string length: 1 - 2048

Response

200 - application/json

Success

entities
EntityOverlays · object[]

One entry per requested entity, in the order they were requested.