v56

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01142337440.5 KB

GlobalAPIKeyService

API Keys

Get the global API key

Retrieves the account's global API key. The token is included only when the caller's scopes dominate the key's.

get/v1/account/global_api_key

Response

state'STATE_UNSPECIFIED' | 'STATE_ENABLED' | 'STATE_DISABLED' enum required

The current lifecycle state of the API key. Output only. Keys are created STATE_ENABLED; use the :disable and :enable actions to transition between states.

Example response

{
  "metadata": {
    "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
    "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
  },
  "info": {
    "createdBy": {
      "metadata": {
        "accountId": "account_01HXKD2E5NQM3T9AYWCFTJHJVF",
        "profileId": "profile_01HXKD2E5NQM3T9AYWCFS0AP08"
      }
    }
  }
}