Get account by ID

curl --request GET \
  --url https://api.snappy.com/public-api/v3/accounts/{accountId} \
  --header 'X-Api-Key: <api-key>'

{
  "data": {
    "id": "a12bcd34",
    "name": "Snappy",
    "createdAt": "2022-12-06T09:50:38.536Z",
    "updatedAt": "2022-12-06T09:50:38.536Z",
    "companyId": "A1b2C3d4"
  }
}

Accounts

Get account by ID

Use this endpoint to retrieve the details of a specific Account by its identifier. Use this when you have an Account ID and need to confirm its name, Company membership, or timestamps.

Required fields:

accountId - the Account identifier, passed as a path parameter (alphanumeric)

Optional parameters:

Snappy-Company-Id header - optional company scoping

Please note:

Returns 404 if no Account exists for the supplied accountId, or if it’s not accessible to the calling API key.

Permissions

Requires: accounts:read

GET

accounts

{accountId}

Get account by ID

curl --request GET \
  --url https://api.snappy.com/public-api/v3/accounts/{accountId} \
  --header 'X-Api-Key: <api-key>'

{
  "data": {
    "id": "a12bcd34",
    "name": "Snappy",
    "createdAt": "2022-12-06T09:50:38.536Z",
    "updatedAt": "2022-12-06T09:50:38.536Z",
    "companyId": "A1b2C3d4"
  }
}

Authorizations

X-Api-Key

string

header

required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

X-Api-Key: YOUR_API_KEY

Headers

snappy-account-id

string

Optional account identifier for swag validation/filtering.

Example:

"acc123456"

snappy-company-id

string

Optional company identifier for swag validation/filtering.

Example:

"cmp123456"

Path Parameters

accountId

string

required

The id of the account.

Pattern: ^[A-Za-z0-9]+$

Example:

"xyz12345"

Response

Account details.

JSON:API single-resource envelope for an account.

data

object

required

Account object.

Show child attributes

Last modified on June 17, 2026

Create account

Billing Methods API: Account Funding Sources and Remaining Balances