Interface GetClientsRequest

Hierarchy

  • GetClientsRequest

Properties

app_type? fields? from? include_fields? include_totals? is_first_party? is_global? page? per_page? q? take?

Properties

Optional app_type

app_type?: string

Optional filter by a comma-separated list of application types.

Optional fields

fields?: string

Comma-separated list of fields to include or exclude (based on value provided for include_fields) in the result. Leave empty to retrieve all fields.

Optional from

from?: string

Optional Id from which to start selection.

Optional include_fields

include_fields?: boolean

Whether specified fields are to be included (true) or excluded (false).

Optional include_totals

include_totals?: boolean

Return results inside an object that contains the total result count (true) or as a direct array of results (false, default).

Optional is_first_party

is_first_party?: boolean

Optional filter on whether or not a client is a first-party client.

Optional is_global

is_global?: boolean

Optional filter on the global client parameter.

Optional page

page?: number

Page index of the results to return. First page is 0.

Optional per_page

per_page?: number

Number of results per page. Default value is 50, maximum value is 100

Optional q

q?: string

Advanced Query in Lucene syntax.
Permitted Queries:

  • client_grant.organization_id:{organization_id}
  • client_grant.allow_any_organization:true
Additional Restrictions:
  • Cannot be used in combination with other filters
  • Requires use of the from and take paging parameters (checkpoint paginatinon)
  • Reduced rate limits apply. See Rate Limit Configurations
Note: Recent updates may not be immediately reflected in query results

Optional take

take?: number

Number of results per page. Defaults to 50.

Settings

Member Visibility

Theme

On This Page