List API keys · SocialTap API reference

The account's keys, newest first, revoked ones included; never their secrets. Free.

Auth: an API key with the account:read scope, or the dashboard session.

Test mode: A test key sees and manages test keys only.

Example

cURL

curl 'https://staging.socialtap.dev/v1/api_keys' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

Authorizations

x-api-keystringheaderrequired

Your API key, with the account:read scope. Authentication

Query parameters

Name	Type	Description	Example
`mode` optional	`string`	Only keys of this mode. A test key always sees test keys only. One of `live`, `test`	—
`limit` optional	`integer` min 1 max 100	Keys per page (default and maximum 100).	—
`cursor` optional	`string` max 200 chars	page.next_cursor of the previous page.	—

modestring

Only keys of this mode. A test key always sees test keys only.

One oflivetest

limitintegermin 1max 100

Keys per page (default and maximum 100).

cursorstringmax 200 chars

page.next_cursor of the previous page.

Response

application/json

200

List API keys

Field	Type	Description
`data`	`object[]`	This page's items.
`data[].created_at`	`string` (date-time)	When the key was created, RFC 3339 UTC.
`data[].expires_at`	`string` (date-time) or `null`	When the key stops working, RFC 3339 UTC; null when it never expires.
`data[].id`	`string`	Key ID (key_…): manage the key with it. It is not the secret.
`data[].ip_allowlist`	`string[]`	IP addresses or CIDR ranges (IPv4 or IPv6) the key works from; [] = any.
`data[].last_used_at`	`string` (date-time) or `null`	About when the key was last used (updated at most hourly); null when never.
`data[].mode`	`string`	live keys spend credits on real requests; test keys answer from recorded responses, free. One of `live`, `test`
`data[].name`	`string`	Your label for the key.
`data[].object`	`string`	Always api_key. One of `api_key`
`data[].prefix`	`string`	The secret's first characters, to recognize it.
`data[].revoked_at`	`string` (date-time) or `null`	When the key was revoked; null while it is not.
`data[].scopes`	`string[]`	What the key may call: endpoints (data endpoints), jobs, account:read (account, usage, ledger, keys), admin (account settings and key management; includes account:read). One of `endpoints`, `jobs`, `account:read`, `admin`
`data[].spend_limit`	`object` or `null`	The key's spend limit and what it used this interval; null when the key has none.
`data[].spend_limit.amount`	`integer`	Most credits the key may spend per interval.
`data[].spend_limit.interval`	`string`	Calendar day or month, UTC. One of `day`, `month`
`data[].spend_limit.resets_at`	`string` (date-time)	Start of the next interval, RFC 3339 UTC.
`data[].spend_limit.used`	`integer`	Credits the key spent this interval, plus what its requests in flight hold.
`data[].status`	`string`	pending: created by an agent signup and waiting for the owner's email confirmation (it can only read GET /v1/account). expired: past expires_at. One of `active`, `pending`, `expired`, `revoked`
`meta`	`object`	The shared route meta (see the API reference introduction).
`page`	`object`
`page.end_reason`	`string` or `null`	Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is. One of `end`, `platform_limit`, `max_pages`
`page.has_more`	`boolean`	True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.
`page.next_cursor`	`string` or `null`	Pass as cursor, with the same other parameters, to get the next page; null at the end.
`page.next_cursor_expires_at`	`string` (date-time) or `null`	When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

dataobject[]

This page's items.

Show 13 child fields

created_atstring date-time

When the key was created, RFC 3339 UTC.

expires_atstring date-timenullable

When the key stops working, RFC 3339 UTC; null when it never expires.

idstring

Key ID (key_…): manage the key with it. It is not the secret.

ip_allowliststring[]

IP addresses or CIDR ranges (IPv4 or IPv6) the key works from; [] = any.

last_used_atstring date-timenullable

About when the key was last used (updated at most hourly); null when never.

modestring

live keys spend credits on real requests; test keys answer from recorded responses, free.

One oflivetest

namestring

Your label for the key.

objectstring

Always api_key.

One ofapi_key

prefixstring

The secret's first characters, to recognize it.

revoked_atstring date-timenullable

When the key was revoked; null while it is not.

scopesstring[]

What the key may call: endpoints (data endpoints), jobs, account:read (account, usage, ledger, keys), admin (account settings and key management; includes account:read).

One ofendpointsjobsaccount:readadmin

spend_limitobjectnullable

The key's spend limit and what it used this interval; null when the key has none.

Show 4 child fields

amountinteger

Most credits the key may spend per interval.

intervalstring

Calendar day or month, UTC.

One ofdaymonth

resets_atstring date-time

Start of the next interval, RFC 3339 UTC.

usedinteger

Credits the key spent this interval, plus what its requests in flight hold.

statusstring

pending: created by an agent signup and waiting for the owner's email confirmation (it can only read GET /v1/account). expired: past expires_at.

One ofactivependingexpiredrevoked

metaobject

The shared route meta (see the API reference introduction).

pageobject

Show 4 child fields

end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

400

400 Bad Request.

Code	HTTP	Retry	Meaning	What to do
`invalid_input`	400	No	The request parameters are missing or malformed, or the URL is not a supported link for this endpoint.	Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names.
`invalid_cursor`	400	No	The cursor is malformed, expired, belongs to another endpoint, or the other parameters differ from the request that issued it.	Repeat the original request without cursor to start the list again.

invalid_inputNo retry

The request parameters are missing or malformed, or the URL is not a supported link for this endpoint.

Fix the parameter named in param (the message says how); for a link of the wrong kind, call the endpoint the message names.

invalid_cursorNo retry

The cursor is malformed, expired, belongs to another endpoint, or the other parameters differ from the request that issued it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized.

Code	HTTP	Retry	Meaning	What to do
`unauthorized`	401	No	The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired).	Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url).

unauthorizedNo retry

The x-api-key header is missing, unknown or revoked (or, on the dashboard's routes, the session cookie is missing or expired).

Send a valid API key in the x-api-key header; without one, get a key at details.signup_url (AI agents: POST details.agent_signup_url).

403

403 Forbidden.

Code	HTTP	Retry	Meaning	What to do
`forbidden`	403	No	The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code.	Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope), have the owner confirm the emailed link, create a new key, or call from an allowed IP.

forbiddenNo retry

The API key is valid but may not make this request: its account is suspended, its scopes do not include the route, it is waiting for its owner's email confirmation, it is past its expiry, or the request came from an IP its allowlist does not include. A running job stops the same way when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item (a private item is private_or_unavailable, also 403): branch on the code.

Do what details.reason says: if suspended, contact support; otherwise use a key whose scopes cover the route (details.required_scope), have the owner confirm the emailed link, create a new key, or call from an allowed IP.

429

429 Too Many Requests.

Code	HTTP	Retry	Meaning	What to do
`rate_limited`	429	Yes, later	The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.	Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

rate_limitedYes, later

The account exceeded its runaway-protection ceiling: plans do not limit request rate, but a high per-account safety ceiling stops broken client loops. Support raises it on request. Without an API key (signup, the MCP server's tool listing and find_endpoint), requests are limited per IP address instead.

Wait for the number of seconds in the retry-after header, then retry; ask support to raise the ceiling if your sustained traffic needs more (calls without an API key: use one).

Test mode

A test key sees and manages test keys only.

operationId api_keys.list