Skip to main content
GET
/
v1
/
api-keys
/
{id}
Get API Key
curl --request GET \
  --url https://api.example.com/v1/api-keys/{id}
{
  "id": "key_abc123",
  "object": "api_key",
  "name": "Production server",
  "key_prefix": "sig_live_a1b2",
  "key_type": "live",
  "scopes": ["trademarks:read", "search:read", "portfolios:manage"],
  "rate_limit_tier": "standard",
  "metadata": { "environment": "production" },
  "last_used_at": "2026-04-09T18:12:00Z",
  "expires_at": null,
  "created_at": "2025-12-01T10:00:00Z",
  "revoked_at": null,
  "livemode": true,
  "request_id": "req_xyz"
}

​
Overview

Returns the metadata for a single API key. The raw key value is never included in the response — it is only shown once when the key is created or rotated. Requires the api-keys:manage scope.

​
Path Parameters

​
id
string
required
API key ID (key_...).

​
Response

​
id
string
API key ID.
​
object
string
Always api_key.
​
name
string
Human-readable name.
​
key_prefix
string
Key prefix (first few characters of the raw key, for identification).
​
key_type
string
Key type (live, test, etc.).
​
scopes
string[]
Scopes granted to this key.
​
rate_limit_tier
string
Rate limit tier.
​
metadata
object
Key-value metadata.
​
last_used_at
string
ISO 8601 timestamp of the last successful use.
​
expires_at
string
ISO 8601 expiry timestamp, when set.
​
created_at
string
ISO 8601 creation timestamp.
​
revoked_at
string
ISO 8601 revocation timestamp, if revoked.
{
  "id": "key_abc123",
  "object": "api_key",
  "name": "Production server",
  "key_prefix": "sig_live_a1b2",
  "key_type": "live",
  "scopes": ["trademarks:read", "search:read", "portfolios:manage"],
  "rate_limit_tier": "standard",
  "metadata": { "environment": "production" },
  "last_used_at": "2026-04-09T18:12:00Z",
  "expires_at": null,
  "created_at": "2025-12-01T10:00:00Z",
  "revoked_at": null,
  "livemode": true,
  "request_id": "req_xyz"
}

​
Code Examples

curl "https://api.signa.so/v1/api-keys/key_abc123" \
  -H "Authorization: Bearer sig_live_YOUR_KEY_HERE"

​
Errors

StatusTypeDescription
400validation_errorInvalid API key ID
401unauthorizedMissing or invalid API key
403forbiddenAPI key lacks api-keys:manage
404not_foundAPI key does not exist or belongs to another org