Entities

Let's add some description in this file, this can also be done directly from gitbook if needed.

List entities

get

List entities in the same workspace.

Authorizations

Query parameters

pageany ofOptional

Which page to fetch

Default: 1

notOptional

or

integer · min: 1Optional

pageSizeany ofOptional

Page size to use

Default: 30

notOptional

or

integer · min: 1 · max: 30Optional

statusstring · enumOptional

Entity status

Possible values:

sortBystring · enumOptional

Sort by attribute

Default: createdAtPossible values:

sortOrderstring · enumOptional

Sort order

Default: ascPossible values:

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /rest/entities HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "page": 1,
  "next": 1,
  "prev": 1,
  "pageSize": 1,
  "total": 1,
  "results": [
    {
      "id": "text",
      "legacyId": 1,
      "name": "text",
      "status": "ACTIVE",
      "createdAt": "2025-05-30T23:28:09.004Z",
      "updatedAt": "2025-05-30T23:28:09.004Z"
    }
  ]
}

Get a single entity

get

Find an entity by ID.

Authorizations

Path parameters

idstringRequired

Id of the target entity

Responses

200

Successful response

application/json

default

Error response

application/json

get

HTTPcURLJavaScriptPython

GET /rest/entities/{id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "text",
  "legacyId": 1,
  "name": "text",
  "status": "ACTIVE",
  "createdAt": "2025-05-30T23:28:09.004Z",
  "updatedAt": "2025-05-30T23:28:09.004Z"
}