Skip to main content

Get Account by ID or Number

GET /api/v1/accounts/{accountIdOrNumber}

Description

Retrieve account details by account ID or account number.

Path Parameters

NameTypeDescription
accountIdOrNumberstringThe account ID or account number (path)

Query Parameters

NameTypeDescription
accountTenantIdsstringTenant IDs separated by commas (query)

Example

GET /api/v1/accounts/{accountIdOrNumber}?accountTenantIds=tenantId1,tenantId2

Response Code: 200 - OK

Description

Successful response.

Headers

Content-TypeValue
apiKey{{apiKey}}
useridstring

🔑 Authentication bearer

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request GET \ 
--url /api/v1/accounts/{accountIdOrNumber} \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!