Entities
Let's add some description in this file, this can also be done directly from gitbook if needed.
List entities in the same workspace.
Authorizations
Query parameters
pageany ofOptionalDefault:
Which page to fetch
1
notOptional
integer · min: 1Optional
pageSizeany ofOptionalDefault:
Page size to use
30
notOptional
integer · min: 1 · max: 30Optional
statusstring · enumOptionalPossible values:
Entity status
sortBystring · enumOptionalDefault:
Sort by attribute
createdAt
Possible values: sortOrderstring · enumOptionalDefault:
Sort order
asc
Possible values: Responses
200
Successful response
application/json
default
Error response
application/json
get
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-06-22T14:28:04.693Z",
"updatedAt": "2025-06-22T14:28:04.693Z"
}
]
}
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
GET /rest/entities/{id} HTTP/1.1
Host:
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": "text",
"legacyId": 1,
"name": "text",
"status": "ACTIVE",
"createdAt": "2025-06-22T14:28:04.693Z",
"updatedAt": "2025-06-22T14:28:04.693Z"
}
Last updated