CommunityWebsiteDocumentationExchangeSupportDeveloper
HomeGuidesAPI Reference
CommunityWebsiteDocumentationExchangeSupportDeveloper
API Reference

List OAuth clients

get
https://{serverURL}/api/clients

Returns a paginated list of OAuth clients.

List filters are applied by ClientService.loadClientList:

  • phrase — case-insensitive partial match on clientId
  • clientId — exact match on clientId (also copied into phrase for partial match when used as a search term)
  • system — when present, filters system vs removable clients (true/empty string → system only)

Default page size is 25. Default sort is clientId ascending.
Response includes clients, meta, and may include viewConfig from the caller's data view preferences.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
Defaults to 25

Maximum number of records to return

int64
Defaults to 0

Offset records, the number of records to skip, for paginating requests

string
Defaults to clientId

Property name to sort by

string
enum
Defaults to asc

Sort direction, use 'desc' to reverse sort

Allowed:
string

Case-insensitive partial match on clientId

string

Exact match on clientId. When provided, the service also sets phrase from this value
for partial matching behavior used by some clients.

string

Filter by system client flag. When the parameter is present, true or empty string
selects system clients (removable == false); other values select removable clients.

Responses

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?