Skip to main content
GET
Get your API account

Authorizations

Authorization
string
header
required

Partner API key (cpk_live_* / cpk_test_*) as a Bearer token.

Headers

X-Partner-API-Key
string | null

Your API key, as an alternative to the Authorization: Bearer header.

Response

Successful Response

Your API account and the scopes your key has been granted.

partner_id
string
required
Example:

"prt_123"

partner_type
enum<string>
required
Available options:
customer,
external
mode
enum<string>
required
Available options:
live,
test
display_name
string | null
Example:

"Example Fleet Management"

status
string
default:active
subscription_plan
string | null
Example:

"management"

granted_scopes
string[]
Example: