Skip to main content
GET
Search clients using SCIM or Lucene filter syntax

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de requête

q
string

Filter expression in SCIM or Lucene syntax (depending on parser parameter). SCIM examples: name eq "Auth0", name sw "auth" and app_type eq "spa". SCIM operators: eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or.

Supported Fields:

  • client_id - Auth0 client ID (case-sensitive, exact match)
  • external_client_id - URL of the Client ID Metadata Document (CIMD); case-sensitive, exact match
  • name - Client name (supports contains, starts-with, ends-with operators; sortable)
  • app_type - Application type (e.g. "spa", "native", "non_interactive")
  • is_first_party - Whether the client is first-party (boolean)
  • updated_at - Last update timestamp (supports date range operators; sortable)
  • metadata.{key} - Filter by client metadata key-value pairs (max 2-level key depth, values indexed up to 64 characters)
  • client_grant.organization_id - Filter by associated organization ID
  • client_grant.allow_any_organization - Filter by allow any organization setting
Maximum 5 filter operations per query. Results are eventually consistent and may not reflect recent updates.

Maximum string length: 1000
parser
enum<string>

Query parser to use for the filter expression. Use "scim" for SCIM filter syntax or "lucene" for Lucene query syntax (default).

Options disponibles:
scim,
lucene
fields
string

Comma-separated list of fields to include or exclude in the response. Works with the include_fields parameter to control projection mode. Maximum 50 fields.

Maximum string length: 1000
include_fields
boolean

Controls field projection mode. Set to true to include only fields specified in the fields parameter. Set to false to exclude fields specified in the fields parameter. Defaults to true if not specified.

take
integer

Maximum number of results to return per page (1-100). Defaults to 50.

Plage requise: 1 <= x <= 100
from
string

Cursor for the next page of results. Use the value from the next field in the previous response.

Maximum string length: 1000
sort
enum<string>

Field name to sort results by in ascending order. Defaults to insertion order (oldest first) if not provided.

Options disponibles:
name,
updated_at

Réponse

Clients successfully retrieved.

clients
object[]
requis

Array of client objects matching the search criteria.

next
string

Cursor for retrieving the next page of results. Absent when no more results are available.