Skip to main content

Get Account By Id

GET /v1/account/:id

Retrieves detailed information about a specific account using its unique identifier. The response includes account status, address details, contact information, metadata, and linked user or tenant references.

Response Example

{
"status": {
"active": true
},
"address": {
"postal": {
"line2": "",
"street": "Example Street 1",
"zip": "1111",
"city": "Example City",
"country": "Exampleland",
"state": "",
"editable": true,
"_id": "postal-id-1"
}
},
"email": {
"default": "example@domain.com"
},
"metadata": {
"last_login": "2025-09-03T12:56:09.095Z"
},
"_id": "account-db-id-1",
"number": "123456789",
"__v": 0,
"bankaccount": [],
"contacts": [],
"country": "EX",
"created": "2020-01-01T00:00:00.000Z",
"name": "Example Account",
"primaryuser": "user-id-1",
"tenant": "tenant-id-1",
"type": "customer",
"updated": "2025-09-03T12:56:09.106Z",
"integrations": [
{
"integrationId": "integration-id-1",
"objectId": "OBJ123456",
"_id": "integration-rel-id-1"
}
],
"partnerLevel": null,
"id": "account-id-1"
}