Get API Key

get /v1/organizations/api_keys/{api_key_id}

Get API Key

Path Parameters

• api_key_id: string

  ID of the API key.

Returns

• APIKey object { id, created_at, created_by, 6 more }

  • id: string

    ID of the API key.

  • created_at: string

    RFC 3339 datetime string indicating when the API Key was created.

  • created_by: object { id, type }

    The ID and type of the actor that created the API key.

    • id: string

      ID of the actor that created the object.

    • type: string

      Type of the actor that created the object.

  • expires_at: string

    RFC 3339 datetime string indicating when the API Key expires, or null if it never expires.

  • name: string

    Name of the API key.

  • partial_key_hint: string

    Partially redacted hint for the API key.

  • status: "active" or "inactive" or "archived" or "expired"

    Status of the API key.

    • "active"

    • "inactive"

    • "archived"

    • "expired"

  • type: "api_key"

    Object type.

    For API Keys, this is always "api_key".

    • "api_key"

  • workspace_id: string

    ID of the Workspace associated with the API key, or null if the API key belongs to the default Workspace.

Example

curl https://api.anthropic.com/v1/organizations/api_keys/$API_KEY_ID \
    -H 'anthropic-version: 2023-06-01' \
    -H "X-Api-Key: $ANTHROPIC_ADMIN_API_KEY"

Response

{
  "id": "apikey_01Rj2N8SVvo6BePZj99NhmiT",
  "created_at": "2024-10-30T23:58:27.427722Z",
  "created_by": {
    "id": "user_01WCz1FkmYMm4gnmykNKUu3Q",
    "type": "user"
  },
  "expires_at": "2024-10-30T23:58:27.427722Z",
  "name": "Developer Key",
  "partial_key_hint": "sk-ant-api03-R2D...igAA",
  "status": "active",
  "type": "api_key",
  "workspace_id": "wrkspc_01JwQvzr7rXLA5AGx3HKfFUJ"
}