Skip to content
OTA-Pulse Docs

List Api Keys

GET
/api/api-keys
 
curl --request GET \
  --url 'https://example.com/api/api-keys?organization_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&page=1&page_size=20' \
  --header 'Authorization: Bearer <token>'

List API keys for organization (paginated)

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “ Query Parameters ”
organization_id
required
Organization Id
string format: uuid
page
Page
integer
default: 1 >= 1
page_size
Page Size
integer
default: 20 >= 1 <= 100

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
APIKeyListResponse

Paginated list of API keys

object
items
required
Items
Array<object>
APIKeyResponse

API key response (without the actual key)

object
created_at
required
Created At
string format: date-time
description
required
Any of:
string
expires_at
required
Any of:
string format: date-time
id
required
Id
string format: uuid
is_active
required
Is Active
boolean
key_prefix
required
Key Prefix
string
last_used_at
required
Any of:
string format: date-time
name
required
Name
string
organization_id
required
Organization Id
string format: uuid
scopes
required
Scopes
Array<string>
user_id
required
Any of:
string format: uuid
page
Page
integer
default: 1
page_size
Page Size
integer
default: 20
total
required
Total
integer
total_pages
Total Pages
integer
0
Example 
{
  "page": 1,
  "page_size": 20,
  "total_pages": 0
}

422

Section titled “ 422 ”

Validation Error

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