Skip to main content
GET
Search organizations

Authorizations

Authorization
string
header
required

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

Query Parameters

q
string

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
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).

Available options:
scim,
lucene
take
integer

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

Required range: 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 only. Defaults to insertion order (oldest first) if not provided.

Available options:
name,
display_name,
created_at

Response

Organizations successfully retrieved.

organizations
object[]
required

Array of organization objects matching the search criteria.

next
string

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