Skip to main content
POST
/
v1
/
b2b
/
organizations
/
search
Search
curl --request POST \
  --url https://api.stytch.com/v1/b2b/organizations/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "cursor": "<string>",
  "limit": 1,
  "query": {
    "operator": "OR",
    "operands": [
      {}
    ]
  }
}
'
{
  "request_id": "<string>",
  "organizations": [
    {
      "organization_id": "<string>",
      "organization_name": "<string>",
      "organization_logo_url": "<string>",
      "organization_slug": "<string>",
      "sso_jit_provisioning": "<string>",
      "sso_jit_provisioning_allowed_connections": [
        "<string>"
      ],
      "sso_active_connections": [
        {
          "connection_id": "<string>",
          "display_name": "<string>",
          "identity_provider": "<string>"
        }
      ],
      "email_allowed_domains": [
        "<string>"
      ],
      "email_jit_provisioning": "<string>",
      "email_invites": "<string>",
      "auth_methods": "<string>",
      "allowed_auth_methods": [
        "<string>"
      ],
      "mfa_policy": "<string>",
      "rbac_email_implicit_role_assignments": [
        {
          "domain": "<string>",
          "role_id": "<string>"
        }
      ],
      "mfa_methods": "<string>",
      "allowed_mfa_methods": [
        "<string>"
      ],
      "oauth_tenant_jit_provisioning": "<string>",
      "claimed_email_domains": [
        "<string>"
      ],
      "first_party_connected_apps_allowed_type": "<string>",
      "allowed_first_party_connected_apps": [
        "<string>"
      ],
      "third_party_connected_apps_allowed_type": "<string>",
      "allowed_third_party_connected_apps": [
        "<string>"
      ],
      "custom_roles": [
        {
          "role_id": "<string>",
          "description": "<string>",
          "permissions": [
            {
              "resource_id": "<string>",
              "actions": [
                "<string>"
              ]
            }
          ]
        }
      ],
      "trusted_metadata": {},
      "created_at": "<string>",
      "updated_at": "<string>",
      "organization_external_id": "<string>",
      "sso_default_connection_id": "<string>",
      "scim_active_connection": {
        "connection_id": "<string>",
        "display_name": "<string>",
        "bearer_token_last_four": "<string>",
        "bearer_token_expires_at": "<string>"
      },
      "allowed_oauth_tenants": {}
    }
  ],
  "results_metadata": {
    "total": 123,
    "next_cursor": "<string>"
  },
  "status_code": 123
}
Searches across and returns an array of Organization objects. If no body parameters are provided, the response includes all organizations with no filtering applied. All fuzzy search filters require a minimum of three characters.
This endpoint is not recommended for use in login flows. Scaling issues may occur, as search performance may vary from ~150 milliseconds to 9 seconds depending on query complexity and rate limits are set to 100 requests/second.

​
Filter Reference

Each query operand requires a filter_name and filter_value. The table below shows all available filters, their value types, and descriptions.
Filter NameValue TypeDescriptionExample
organization_idsarray[string]Filter by one or more exact organization IDs.["organization-test-16d9ba61-97a1-4ba4-9720-b03761dc50c6"]
organization_slugsarray[string]Filter by one or more exact organization slugs.["acme-corp"]
organization_slug_fuzzystringFuzzy search for organization by slug. Requires a minimum of three characters."acme"
organization_name_fuzzystringFuzzy search for organization by name. Requires a minimum of three characters."Acme"
member_emailsarray[string]Filter by one or more exact member email addresses.["member@example.com"]
member_email_fuzzystringFuzzy search for organization by member email address. Requires a minimum of three characters."john"
allowed_domainsarray[string]Filter by one or more exact allowed email domains.["example.com"]
allowed_domain_fuzzystringFuzzy search for organization by allowed email domain. Requires a minimum of three characters."exam"
claimed_email_domainsarray[string]Filter by one or more exact claimed email domains.["acme.com"]
has_active_sso_connectionbooleanFilter organizations by whether they have an active SSO connection (SAML, OIDC, or external).true
sso_connection_idstringFilter by exact SSO connection ID (SAML, OIDC, or external)."saml-connection-test-1234567890"

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

Request type

​
cursor
string

The cursor field allows you to paginate through your results. Each result array is limited to 1000 results. If your query returns more than 1000 results, you will need to paginate the responses using the cursor. If you receive a response that includes a non-null next_cursor in the results_metadata object, repeat the search call with the next_cursor value set to the cursor field to retrieve the next page of results. Continue to make search calls until the next_cursor in the response is null.

​
limit
integer<int32>

The number of search results to return per page. The default limit is 100. A maximum of 1000 results can be returned by a single search request. If the total size of your result set is greater than one page size, you must paginate the response. See the cursor field.

Required range: x >= 0
​
query
object

The optional query object contains the operator, i.e. AND or OR, and the operands that will filter your results. Only an operator is required. If you include no operands, no filtering will be applied. If you include no query object, it will return all Organizations with no filtering applied.

Response

Successful response

​
request_id
string
required

Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.

​
organizations
object[]
required

An array of Organization objects.

​
results_metadata
object
required

The search results_metadata object contains metadata relevant to your specific query like total and next_cursor.

​
status_code
integer<int32>
required

The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.