Skip to main content
GET
List an organization's API clients

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose API clients you want to list.

Format: UUID

Query Parameters

next
string

Cursor returned as next by the previous page. Omit for the first page.

limit
integer
default:15

Page size.

Required range: x >= 1
order
enum<string>
default:DESC

Sort direction by creation date (case-insensitive): DESC newest first, ASC oldest first.

Available options:
ASC,
DESC
status
enum<string>

Only API clients in this status. Omit to list active and deactivated ones alike.

Available options:
ACTIVE,
DEACTIVATED
description
string

Only API clients whose description or clientId contains this text (case-insensitive).

Maximum string length: 200
startDate
string

Only API clients created at or after this instant (ISO 8601 date or date-time).

endDate
string

Only API clients created at or before this instant (ISO 8601 date or date-time).

Response

Successful response

A page of API clients.

next
string | null
required

Cursor for the next page: send it as the next query parameter. null on the last page.

Example:

"NmEzZjljMjFlNGIwN2Q1YThjMTJmM2U5"

items
object[]
required

The API clients on this page.