Search organizations
Retrieve details of organizations matching a search criteria. It is possible to:
- Specify a search criteria for organizations
- Search via
name - Search via
display_name - Substring matching (
containsandends-with) requires at least 3 characters - Use wildcards
The q query parameter can be used to get organizations that match the specified criteria on name OR display_name.
This endpoint supports SCIM or Lucene filter syntax with low-latency, cursor-based pagination. Use the parser parameter to specify “scim” or “lucene” syntax (default: “lucene”).
Results are eventually consistent and may not reflect recent updates immediately.
Sortable fields: name, display_name, created_at (ascending only). Defaults to insertion order (oldest first).
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter expression in SCIM or Lucene syntax (depending on parser parameter, default: Lucene). Lucene examples: name:acme*, display_name:*auth*. SCIM examples: name eq "Auth0", display_name sw "auth" and created_at gt "2024-01-01". SCIM operators: eq, ne, sw, ew, co, pr, gt, ge, lt, le, and, or.
Supported Fields:
- id - Organization ID (case-sensitive, exact match)
- name - Organization name (supports contains, starts-with, ends-with operators; sortable)
- display_name - Organization display name (supports contains, starts-with, ends-with operators; sortable)
- created_at - Creation timestamp (supports date range operators; sortable)
- metadata.{key} - Filter by organization metadata key-value pairs
1000Query parser to use for the filter expression. Use "scim" for SCIM filter syntax or "lucene" for Lucene query syntax (default).
scim, lucene Maximum number of results to return per page (1-100). Defaults to 50.
1 <= x <= 100Cursor for the next page of results. Use the value from the next field in the previous response.
1000Field name to sort results by in ascending order only. Defaults to insertion order (oldest first) if not provided.
name, display_name, created_at Response
Organizations successfully retrieved.
- object[]
- object
Organization identifier.
50The name of this organization.
1 - 50Friendly name of this organization.
1 - 255Theme defines how to style the login pages.
Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.
Controls whether this organization can be used in user flows with third-party clients. Defaults to block.
block, allow Whether app entitlement is active for this organization.