Retrieve admin API key

Retrieve a single organization API key

get/organization/admin_api_keys/{key_id}

Path parameters

key_idstring required

The ID of the API key.

Response

Details of the requested API key.

object'organization.admin_api_key' required

The object type, which is always organization.admin_api_key

idstring required

The identifier, which can be referenced in API endpoints

namestring nullable

The name of the API key

redacted_valuestring required

The redacted value of the API key

created_atinteger required

The Unix timestamp (in seconds) of when the API key was created

expires_atinteger nullable required

The Unix timestamp (in seconds) of when the API key expires

last_used_atinteger nullable

The Unix timestamp (in seconds) of when the API key was last used

Example response

{
  "id": "key_abc",
  "name": "Administration Key",
  "redacted_value": "sk-admin...def",
  "created_at": 1711471533,
  "expires_at": 1714063533,
  "last_used_at": 1711471534,
  "owner": {
    "type": "user",
    "object": "organization.user",
    "id": "sa_456",
    "name": "My Service Account",
    "created_at": 1711471533,
    "role": "owner"
  }
}

Changes

Changed in 9 of the 163 revisions of this API.6220

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 74cbcf73838f621See the full diff
    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      the response property became optional for the status

      response-property-became-optional

    • ▲

      response property last_used_at list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property name list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      the response's property format changed from int64 to unixtime for status

      response-property-type-changed

    • ▲

      the / response's property format changed from int64 to unixtime for status

      response-property-type-changed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      added the new organization.admin_api_key enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      the endpoint scheme security AdminApiKeyAuth was added to the API

      api-security-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      the endpoint scheme security basic_identity_edge was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security bearer_identity_edge was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security basic_identity_edge was added to the API

      api-security-added

    • ○

      the endpoint scheme security bearer_identity_edge was added to the API

      api-security-added

    • ○

      the endpoint scheme security basic_identity_edge was removed from the API

      api-security-removed

    • ○

      the endpoint scheme security bearer_identity_edge was removed from the API

      api-security-removed

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • ○

      endpoint added

      endpoint-added