Get All Entities
This API gets all entities for a merchant
Request
GET - /api/v1/entities
Response
Success response code - 200 (ok)
Key | Value | Description |
---|---|---|
data | array of objects | Array of all entity objects |
data.id | string | Unique identifier for the Entity |
data.name | string | Name of the entity |
data.status | string | Entity status |
data.geography | string | Entity 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"
}
]
}