Skip to main content
GET
Every key this organisation has issued — its prefix, its scopes, its state and what it has

Headers

Range
string

Limiting and Pagination

Range-Unit
string
default:items

Limiting and Pagination

Prefer
enum<string>

Preference

Available options:
count=none

Query Parameters

id
string
name
string
key_prefix
string
service_account_id
string
service_account_code
string
service_account_name
string
scopes
string
is_narrowed
string
reader_id
string
reader_code
string
expires_at
string
status
string
last_used_at
string
never_used
string
revoked_at
string
revoked_reason
string
revoked_by_name
string
superseded_at
string
rotated_from_id
string
rotated_from_prefix
string
successor_id
string
successor_prefix
string
exchanges_7d
string
refusals_7d
string
created_at
string
created_by_name
string
row_version
string
select
string

Filtering Columns

order
string

Ordering

offset
string

Limiting and Pagination

limit
string

Limiting and Pagination

Response

OK

created_at
string<timestamp with time zone>
created_by_name
string<character varying>
Maximum string length: 200
exchanges_7d
integer<bigint>
expires_at
string<timestamp with time zone>
id
string<uuid>
is_narrowed
boolean<boolean>
key_prefix
string<character varying>
Maximum string length: 20
last_used_at
string<timestamp with time zone>
name
string<character varying>
Maximum string length: 150
never_used
boolean<boolean>
reader_code
string<character varying>
Maximum string length: 60
reader_id
string<uuid>

Note: This is a Foreign Key to readers.id.

refusals_7d
integer<bigint>
revoked_at
string<timestamp with time zone>
revoked_by_name
string<character varying>
Maximum string length: 200
revoked_reason
string<character varying>
Maximum string length: 200
rotated_from_id
string<uuid>

Note: This is a Foreign Key to api_keys.id.

rotated_from_prefix
string<character varying>
Maximum string length: 20
row_version
integer<bigint>
scopes
string[]
service_account_code
string<character varying>
Maximum string length: 60
service_account_id
string<uuid>

Note: This is a Foreign Key to service_accounts.id.

service_account_name
string<character varying>
Maximum string length: 150
status
string<text>
successor_id
string<uuid>

Note: This is a Primary Key.

successor_prefix
string<character varying>
Maximum string length: 20
superseded_at
string<timestamp with time zone>