Skip to main content

Get Entity by Id

This API gets entity by id

Request

GET - /api/v1/entities/:id

Example Request Body:

Response

Success response code - 200 (ok)

KeyValueDescription
dataentity objectObject having entity data
data.idstringUnique identifier for the Entity
data.namestringName of the entity
data.statusstringEntity status
data.geographystringEntity geography

Example Response Body:

{
"data": {
"id": "roma_88caBHKBUYBE7Y_05_09",
"name": "First entity",
"status": "active",
"geography": "USA"
}
}