Get Accounts

GET {{baseUrl}}/api/accounts/

Retrieve the account(s) associated with a given private API key. This will return 1 account object within the array.

You can use this to retrieve account-specific data (contact information, timezone, currency, Public API key, etc.) or test if a Private API Key belongs to the correct account prior to performing subsequent actions with the API.

Rate limits:
Burst: 1/s
Steady: 15/m

Scopes: accounts:read

Request Params

HEADERS

RESPONSES

status: OK

{"data":[{"type":"account","id":"\u003cstring\u003e","attributes":{"contact_information":{"default_sender_name":"\u003cstring\u003e","default_sender_email":"\u003cstring\u003e","website_url":"\u003cstring\u003e","organization_name":"\u003cstring\u003e","street_address":{"address1":"\u003cstring\u003e","address2":"\u003cstring\u003e","city":"\u003cstring\u003e","region":"\u003cstring\u003e","country":"\u003cstring\u003e","zip":"\u003cstring\u003e"}},"industry":"\u003cstring\u003e","timezone":"\u003cstring\u003e","preferred_currency":"\u003cstring\u003e","public_api_key":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"}},{"type":"account","id":"\u003cstring\u003e","attributes":{"contact_information":{"default_sender_name":"\u003cstring\u003e","default_sender_email":"\u003cstring\u003e","website_url":"\u003cstring\u003e","organization_name":"\u003cstring\u003e","street_address":{"address1":"\u003cstring\u003e","address2":"\u003cstring\u003e","city":"\u003cstring\u003e","region":"\u003cstring\u003e","country":"\u003cstring\u003e","zip":"\u003cstring\u003e"}},"industry":"\u003cstring\u003e","timezone":"\u003cstring\u003e","preferred_currency":"\u003cstring\u003e","public_api_key":"\u003cstring\u003e"},"links":{"self":"\u003curi\u003e"}}],"links":{"self":"\u003curi\u003e","first":"\u003curi\u003e","last":"\u003curi\u003e","prev":"\u003curi\u003e","next":"\u003curi\u003e"}}