Account Query

For account retrieval, the GET /account method is used. The user can query accounts based on description, a specific ID, or a list of IDs.

Querying a specific account

The user can retrieve a specific account using the GET /account/{id} method.

Example of querying a specific account:

GET /account/19720852-be40-489a-a3b3-985f51a0458c

Response example:

{
  "id": "19720852-be40-489a-a3b3-985f51a0458c",
  "description": "digital_account",
  "billing_plan_id": "fe38153f-36ed-42fb-a879-c46ea92b7ebc"
}

Querying accounts using parameters

The user can provide parameters to query one or multiple accounts simultaneously using the GET /account method. The method will return a list of accounts.

Example of querying accounts using parameters:

GET /account?description=digital_account

Response example:

{
  "accounts": [
    "a8f5f167-f44f-4964-e6c9-98dee827110c", 
    "3634bee6-1e59-f282-4f76-d61db9007f70", 
    "b67fa8e8-ef7b-f944-b6d9-1e53bb9eee4a"
  ]
}