Entities
Last updated
Last updated
Let's add some description in this file, this can also be done directly from gitbook if needed.
List entities in the same workspace.
Which page to fetch
1
Page size to use
30
Entity status
Sort by attribute
createdAt
Possible values: Sort order
asc
Possible values: 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-21T03:39:22.590Z",
"updatedAt": "2025-06-21T03:39:22.590Z"
}
]
}
Find an entity by ID.
Id of the target entity
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-21T03:39:22.590Z",
"updatedAt": "2025-06-21T03:39:22.590Z"
}