Get details for all accounts

List account details based on supplied API key.

GET /v1/accounts

Fetch user accounts

cURL

curl --request GET \
  --url https://api.checklyhq.com/v1/accounts \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "d43967ee-81db-4e0b-a18c-06be5c995288",
    "name": "Checkly",
    "runtimeId": "2022.10",
    "plan": "team",
    "planDisplayName": "Team",
    "addons": {
      "communicate": {
        "tier": "starter",
        "tierDisplayName": "Communicate Starter"
      },
      "resolve": {
        "tier": "starter",
        "tierDisplayName": "Communicate Starter"
      }
    },
    "settings": {},
    "alertSettings": {}
  }
]

Authorizations

Authorization · string · header · required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

x-checkly-account · string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Response

200

application/json

Successful

id · string · required

Checkly account ID.

Example:

"d43967ee-81db-4e0b-a18c-06be5c995288"

name · string

The name of the account.

Example:

"Checkly"

runtimeId · string

The account default runtime ID.

Example:

"2022.10"

plan · string

The account plan type.

Example:

"team"

planDisplayName · string

The human-readable display name of the account plan.

Example:

"Team"

addons · object

The add-ons available to the account.

Show child attributes

settings · object

The settings of the account.

alertSettings · object

The alert settings of the account.