Skip to main content

Get Account

GET /v1/accounts/{id}

Retrieves an account by its ID. The account must belong to the API key's node.

Headers

HeaderRequiredValue
AuthorizationYesBearer <token>
X-Target-ServerYesaccounts

Path Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesAccount ID

Response

200 OK

{
"id": "550e8400-e29b-41d4-a716-446655440000",
"name": "Main Account",
"node_id": "660e8400-e29b-41d4-a716-446655440000",
"type": "organisation",
"status": 1,
"created_at": "2025-01-01T00:00:00Z",
"updated_at": "2025-01-01T00:00:00Z",
"deleted_at": null
}

401 Unauthorized

Invalid or missing token.

404 Not Found

Account not found or does not belong to your node.

{
"code": 0,
"domain": 0,
"message": "account not found"
}

500 Internal Server Error