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

​
Overview

The Get Account endpoint retrieves detailed information about a specific account by its ID. This endpoint provides comprehensive account details including plan information, settings, usage metrics, and metadata. Use this endpoint to understand your account’s current status, plan limits, and available features.
This endpoint is currently in beta and may change without notice.
Common Use Cases:
  • Account Overview: Get complete account information for dashboard displays and monitoring
  • Usage Monitoring: Track resource usage against plan limits and quotas
  • Plan Validation: Verify plan features before creating new resources
  • Settings Retrieval: Get account preferences and configuration settings
This endpoint provides detailed account information including current usage metrics. Use this to understand plan limits and available features before creating new resources. The response includes both current usage and plan limits to help you make informed decisions about resource allocation.

​
Additional Examples

curl -X GET "https://api.checklyhq.com/v1/accounts/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer cu_1234567890abcdef" \
  -H "X-Checkly-Account: 550e8400-e29b-41d4-a716-446655440000"

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

Path Parameters

​
accountId
string
required

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.