Skip to content
AugentaDocsOpen console ↗
Retrieve an API key

Documentation

API reference
View Markdown

Retrieve an API key

GET/v1/orgs/{id}/keys/{keyId}

Read key metadata as its creator or an organization administrator. The secret and secret hash are never returned.

Authentication

Use your signed-in console session or a person's WorkOS access token for this setup operation. See authentication and permissions.

Request

Parameters

idstringrequired

path parameter.

Min length: 1

keyIdstringrequired

path parameter.

Min length: 1

Responses

API key resource.

objectstringalways present

The resource type. Always api_key.

Allowed: "api_key"

idstringalways present

Public credential identity used in administration routes. It is not the authentication secret.

Min length: 1

orgIdstringalways present

Owning Organization's Augenta ID.

Min length: 1

labelstringalways present

Human-readable credential name.

createdByUserIdstringalways present

Person who issued the credential.

createdAtstringalways present

Recorded credential creation time.

scopestringconditional

Scope metadata, when present.

workspaceIdsarrayconditional

Assigned Workspaces. An empty array permits one-shot Consolidate only.

Show item fields
workspaceIdstringconditional

Legacy single-Workspace assignment, when applicable.

connectorIdstringconditional

Legacy Connector-backed credential reference, when applicable.

lastActiveAtstringconditional

Last recorded authentication activity, when available.

revokedAtstringconditional

Recorded revocation time, when revoked.