v2

latestOpenAPI 3.0.02026-07-261859071.2 MB

Accounts

Fetch user accounts

List account details based on supplied API key.

get/v1/accounts

Headers

x-checkly-accountstring

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

Response

Successful

idstring required

Checkly account ID.

namestring

The name of the account.

runtimeIdstring

The account default runtime ID.

planstring

The account plan type.

planDisplayNamestring

The human-readable display name of the account plan.

settingsSettings

The settings of the account.

alertSettingsAlertSettings

The alert settings of the account.

Example response

[
  {
    "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"
      }
    }
  }
]

All 185 operations