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

​
Overview

The Get Current Account endpoint returns detailed information about the account associated with your API key. This endpoint provides comprehensive account details including plan information, settings, and usage statistics.
This endpoint is currently in beta and may change without notice.
Common Use Cases:
  • Account Information Display
  • Plan Verification
  • Usage Monitoring
  • Account Settings Validation
This endpoint returns information about the account specified in the X-Checkly-Account header. Use this to get comprehensive details about your current account context.

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.