Skip to main content

Get All Entities

This API gets all entities for a merchant

Request

GET - /api/v1/entities

Response

Success response code - 200 (ok)

KeyValueDescription
dataarray of objectsArray of all entity objects
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"
},
{
"id": "roma_88caBHKBUYBE7Y_05_10",
"name": "Second entity",
"status": "active",
"geography": "SG"
}
]
}