Skip to main content
GET
List entities

Authorizations

api-key
string
header
required

Query Parameters

externalId
string

Return only the entity whose externalId matches (your own id).

metadata
object

Filter by metadata key/value pairs, e.g. metadata[crmId]=C-1. Matches entities whose metadata contains every supplied pair.

Response

200 - application/json

Entities (limitations omitted; fetch an entity's limitations separately).

data
object[]