Skip to content

Get a single entity

Find an entity by ID.

GET/entities/{id}

Path parameters

NameTypeDescriptionRequired
id
string
Id of the target entity

Response schema

{
// Entity ID
id: string;
// Legacy internal unique identifier (for retro-compatibility)
legacyId: number;
// Entity name
name: string;
// Entity status
status: "ACTIVE" | "INACTIVE";
// Creation timestamp
createdAt: string;
// Last modification timestamp
updatedAt: string;
}

Examples

bash
curl \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {jwt}" \
  "$API_BASE_URL/entities/{id}"
ts
const url = "<base-url>/entities/{id}";

const headers = {
  "Content-Type": "application/json",
  Authorization: "Bearer <jwt>"
};

fetch(url, { headers }).then(res => {
  console.log(res)
});
python
import requests

url = "<base-url>/entities/{id}"

headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer <jwt>"
}

print(requests.get(url, headers=headers))