API Keys
Get Api Key
GET
/
v1
/
organizations
/
api_keys
/
{api_key_id}
Headers
x-api-key
string
requiredYour unique Admin API key for authentication.
This key is required in the header of all Admin API requests, to authenticate your account and access Anthropic's services. Get your Admin API key through the Console.
anthropic-version
string
requiredThe version of the Anthropic API you want to use.
Read more about versioning and our version history here.
Path Parameters
api_key_id
string
requiredID of the API key.
Response
200 - application/json
id
string
requiredID of the API key.
type
enum<string>
default: api_keyrequiredObject type.
For API Keys, this is always "api_key"
.
Available options:
api_key
name
string
requiredName of the API key.
workspace_id
string | null
requiredID of the Workspace associated with the API key, or null if the API key belongs to the default Workspace.
created_at
string
requiredRFC 3339 datetime string indicating when the API Key was created.
created_by
object
requiredThe ID and type of the actor that created the API key.
partial_key_hint
string | null
requiredPartially redacted hint for the API key.
status
enum<string>
requiredStatus of the API key.
Available options:
active
, inactive
, archived
Was this page helpful?