GET
/
v1
/
accounts
[beta] Fetch user accounts
curl --request GET \
  --url https://api.checklyhq.com/v1/accounts \
  --header 'Authorization: <api-key>'
[
  {
    "id": "d43967ee-81db-4e0b-a18c-06be5c995288",
    "name": "Checkly",
    "runtimeId": "2022.10",
    "settings": {},
    "alertSettings": {}
  }
]

​
Overview

The List Accounts endpoint returns all accounts accessible with your API key. This endpoint is useful for retrieving information about accounts you have access to, managing multi-account setups, and discovering available accounts when setting up integrations.
This endpoint is currently in beta and may change without notice.
Common Use Cases:
  • Multi-Account Management
  • Account Discovery
  • Plan Information
  • Account Audit
This endpoint requires authentication and returns accounts accessible with your current API key. The account specified in the X-Checkly-Account header must be one you have access to. Use this endpoint to discover and manage multiple accounts in your Checkly setup.

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

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"

​
settings
object

The settings of the account.

​
alertSettings
object

The alert settings of the account.