Skip to content
Vocapable Developers

List this tenant's API keys

GET
/v1/api-keys
curl --request GET \
  --url 'https://api.vocapable.com/v1/api-keys?limit=50' \
  --header 'Authorization: Bearer <token>'

Cursor-paginated like every other list endpoint (docs/04-api.md §1).

It used to answer a bare JSON array - the one exception on the surface - which broke a generated client’s generic list walker on the first resource most developers touch.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 50 >= 1 <= 200
cursor
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CursorPage[ApiKeySummary]
object
data
required
Data
Array<object>
ApiKeySummary

A key as its owning tenant sees it. The secret is never present.

object
id
required
Id
string
name
Any of:
string
display_prefix
required
Display Prefix
string
mode
required
Mode
string
Allowed values: live test
scopes
required
Scopes
Array<string>
created_at
required
Created At
string format: date-time
expires_at
Any of:
string format: date-time
revoked_at
Any of:
string format: date-time
next_cursor
Any of:
string
has_more
Has More
boolean
Example
{
  "data": [
    {
      "mode": "live"
    }
  ],
  "has_more": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}