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 (contains and ends-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).

GET https://{tenantDomain}/api/v2/organizations/search

Search organizations

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/organizations/search \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": "<string>",
    "name": "organization-1",
    "display_name": "Acme Users",
    "branding": {
      "logo_url": "<string>",
      "colors": {
        "primary": "<string>",
        "page_background": "<string>"
      }
    },
    "metadata": {},
    "token_quota": {
      "client_credentials": {
        "enforce": true,
        "per_day": 1073741824,
        "per_hour": 1073741824
      }
    },
    "third_party_client_access": "block",
    "is_app_entitlement_active": true
  }
]

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

クエリパラメータ

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

利用可能なオプション: scim, lucene

take · integer

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

必須範囲: 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.

利用可能なオプション: name, display_name, created_at

レスポンス

200

application/json

Organizations successfully retrieved.

object[]

object

id · string<organization-id>

Organization identifier.

Maximum string length: 50

name · string<organization-name> · デフォルト: organization-1

The name of this organization.

Required string length: 1 - 50

display_name · string · デフォルト: Acme Users

Friendly name of this organization.

Required string length: 1 - 255

branding · object

Theme defines how to style the login pages.

Show child attributes

metadata · object

Metadata associated with the organization, in the form of an object with string values (max 255 chars). Maximum of 25 metadata properties allowed.

Show child attributes

token_quota · object · EA

Show child attributes

third_party_client_access · enum<string> · GA

Controls whether this organization can be used in user flows with third-party clients. Defaults to block.

利用可能なオプション: block, allow

is_app_entitlement_active · boolean · EA

Whether app entitlement is active for this organization.