--- title: "Search" method: POST path: "/v1/b2b/organizations/members/search" tags: ["Organizations"] --- # Search `POST /v1/b2b/organizations/members/search` ## Request - Base URL: `https://api.stytch.com` - URL: `https://api.stytch.com/v1/b2b/organizations/members/search` - Auth: HTTP basic **Warning**: 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/minute. Search for Members within specified Organizations. An array with at least one `organization_id` is required. Submitting an empty `query` returns all non-deleted Members within the specified Organizations. All fuzzy search filters require a minimum of three characters. ## Headers - `X-Stytch-Member-Session` string - `X-Stytch-Member-SessionJWT` string ## Request body - ApiOrganizationV1OrganizationsMembersSearchRequest: Request type - `organization_ids` string[], required: An array of organization_ids. At least one value is required. - `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: 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. - `query` ApiOrganizationV1SearchQuery - `operator` 'OR' | 'AND', required - `operands` object[], required: An array of operand objects that contains all of the filters and values to apply to your search query. ## Response `200` Successful response - ApiOrganizationV1OrganizationsMembersSearchResponse - `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. - `members` ApiOrganizationV1Member[], required: An array of [Member objects](https://stytch.com/docs/b2b/api/member-object). - `organization_id` string, required: Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience. - `member_id` string, required: Globally unique UUID that identifies a specific Member. The `member_id` is critical to perform operations on a Member, so be sure to preserve this value. You may use an external_id here if one is set for the member. - `email_address` string, required: The email address of the Member. - `status` string, required: The status of the Member. The possible values are: `pending`, `invited`, `active`, or `deleted`. - `name` string, required: The name of the Member. - `sso_registrations` ApiOrganizationV1SSORegistration[], required: An array of registered [SAML Connection](https://stytch.com/docs/b2b/api/saml-connection-object) or [OIDC Connection](https://stytch.com/docs/b2b/api/oidc-connection-object) objects the Member has authenticated with. - `connection_id` string, required: Globally unique UUID that identifies a specific SSO `connection_id` for a Member. - `external_id` string, required: The ID of the member given by the identity provider. - `registration_id` string, required: The unique ID of an SSO Registration. - `sso_attributes` object: An object for storing SSO attributes brought over from the identity provider. - `is_breakglass` boolean, required: Identifies the Member as a break glass user - someone who has permissions to authenticate into an Organization by bypassing the Organization's settings. A break glass account is typically used for emergency purposes to gain access outside of normal authentication procedures. Refer to the [Organization object](https://stytch.com/docs/b2b/api/organization-object) and its `auth_methods` and `allowed_auth_methods` fields for more details. - `member_password_id` string, required: Globally unique UUID that identifies a Member's password. - `oauth_registrations` ApiOrganizationV1OAuthRegistration[], required: A list of OAuth registrations for this member. - `provider_type` string, required: Denotes the OAuth identity provider that the user has authenticated with, e.g. Google, Microsoft, GitHub etc. - `provider_subject` string, required: The unique identifier for the User within a given OAuth provider. Also commonly called the `sub` or "Subject field" in OAuth protocols. - `member_oauth_registration_id` string, required: The unique ID of an OAuth registration. - `profile_picture_url` string: If available, the `profile_picture_url` is a URL of the User's profile picture set in OAuth identity the provider that the User has authenticated with, e.g. Google profile picture. - `locale` string: If available, the `locale` is the Member's locale set in the OAuth identity provider that the user has authenticated with. - `email_address_verified` boolean, required: Whether or not the Member's email address is verified. - `mfa_phone_number_verified` boolean, required: Whether or not the Member's phone number is verified. - `is_admin` boolean, required: Whether or not the Member has the `stytch_admin` Role. This Role is automatically granted to Members who create an Organization through the [discovery flow](https://stytch.com/docs/b2b/api/create-organization-via-discovery). See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/stytch-default) for more details on this Role. - `totp_registration_id` string, required: Globally unique UUID that identifies a TOTP instance. - `retired_email_addresses` ApiOrganizationV1RetiredEmail[], required: A list of retired email addresses for this member. A previously active email address can be marked as retired in one of two ways: - It's replaced with a new primary email address during an explicit Member update. - A new email address is surfaced by an OAuth, SAML or OIDC provider. In this case the new email address becomes the Member's primary email address and the old primary email address is retired. A retired email address cannot be used by other Members in the same Organization. However, unlinking retired email addresses allows them to be subsequently re-used by other Organization Members. Retired email addresses can be unlinked using the [Unlink Retired Email endpoint](https://stytch.com/docs/b2b/api/unlink-retired-member-email). - `email_id` string, required: The globally unique UUID of a Member's email. - `email_address` string, required: The email address of the Member. - `is_locked` boolean, required: Whether the Member is temporarily locked due to too many failed authentication attempts. See the [User Locking Guide](https://stytch.com/docs/resources/platform/user-locks) for more information. - `mfa_enrolled` boolean, required: Sets whether the Member is enrolled in MFA. If true, the Member must complete an MFA step whenever they wish to log in to their Organization. If false, the Member only needs to complete an MFA step if the Organization's MFA policy is set to `REQUIRED_FOR_ALL`. - `mfa_phone_number` string, required: The Member's phone number. A Member may only have one phone number. The phone number should be in E.164 format (i.e. +1XXXXXXXXXX). - `default_mfa_method` string, required: The Member's default MFA method. This value is used to determine which secondary MFA method to use in the case of multiple methods registered for a Member. The current possible values are `sms_otp` and `totp`. - `roles` ApiOrganizationV1MemberRole[], required: Explicit or implicit Roles assigned to this Member, along with details about the role assignment source. See the [RBAC guide](https://stytch.com/docs/b2b/guides/rbac/role-assignment) for more information about role assignment. - `role_id` string, required: The unique identifier of the RBAC Role, provided by the developer and intended to be human-readable. Reserved `role_id`s that are predefined by Stytch include: * `stytch_member` * `stytch_admin` Check out the [guide on Stytch default Roles](https://stytch.com/docs/b2b/guides/rbac/stytch-default) for a more detailed explanation. - `sources` ApiOrganizationV1MemberRoleSource[], required: A list of sources for this role assignment. A role assignment can come from multiple sources - for example, the Role could be both explicitly assigned and implicitly granted from the Member's email domain. - `type` string, required: The type of role assignment. The possible values are: `direct_assignment` – an explicitly assigned Role. Directly assigned roles can be updated by passing in the `roles` argument to the [Update Member](https://stytch.com/docs/b2b/api/update-member) endpoint. `email_assignment` – an implicit Role granted by the Member's email domain, regardless of their login method. Email implicit role assignments can be updated by passing in the `rbac_email_implicit_role_assignments` argument to the [Update Organization](https://stytch.com/docs/b2b/api/update-organization) endpoint. `sso_connection` – an implicit Role granted by the Member's SSO connection. This is currently only available for SAML connections and not for OIDC. If the Member has a SAML Member registration with the given connection, this role assignment will appear in the list. However, for authorization check purposes (in [sessions authenticate](https://stytch.com/docs/b2b/api/authenticate-session) or in any endpoint that enforces RBAC with session headers), the Member will only be granted the Role if their session contains an authentication factor with the specified SAML connection. SAML connection implicit role assignments can be updated by passing in the `saml_connection_implicit_role_assignments` argument to the [Update SAML connection](https://stytch.com/docs/b2b/api/update-saml-connection) endpoint. `sso_connection_group` – an implicit Role granted by the Member's SSO connection and group. This is currently only available for SAML connections and not for OIDC. If the Member has a SAML Member registration with the given connection, and belongs to a specific group within the IdP, this role assignment will appear in the list. However, for authorization check purposes (in [sessions authenticate](https://stytch.com/docs/b2b/api/authenticate-session) or in any endpoint that enforces RBAC with session headers), the Member will only be granted the role if their session contains an authentication factor with the specified SAML connection. SAML group implicit role assignments can be updated by passing in the `saml_group_implicit_role_assignments` argument to the [Update SAML connection](https://stytch.com/docs/b2b/api/update-saml-connection) endpoint. `scim_connection_group` – an implicit Role granted by the Member's SCIM connection and group. If the Member has a SCIM Member registration with the given connection, and belongs to a specific group within the IdP, this role assignment will appear in the list. SCIM group implicit role assignments can be updated by passing in the `scim_group_implicit_role_assignments` argument to the [Update SCIM connection](https://stytch.com/docs/b2b/api/update-scim-connection) endpoint. - `details` object: An object containing additional metadata about the source assignment. The fields will vary depending on the role assignment type as follows: `direct_assignment` – no additional details. `email_assignment` – will contain the email domain that granted the assignment. `sso_connection` – will contain the `connection_id` of the SAML connection that granted the assignment. `sso_connection_group` – will contain the `connection_id` of the SAML connection and the name of the `group` that granted the assignment. `scim_connection_group` – will contain the `connection_id` of the SAML connection and the `group_id` that granted the assignment. - `trusted_metadata` object: An arbitrary JSON object for storing application-specific data or identity-provider-specific data. - `untrusted_metadata` object: An arbitrary JSON object of application-specific data. These fields can be edited directly by the frontend SDK, and should not be used to store critical information. See the [Metadata resource](https://stytch.com/docs/b2b/api/metadata) for complete field behavior details. - `created_at` string: The timestamp of the Member's creation. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`. - `updated_at` string: The timestamp of when the Member was last updated. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`. - `scim_registration` ApiOrganizationV1SCIMRegistration - `connection_id` string, required: The ID of the SCIM connection. - `registration_id` string, required: The unique ID of a SCIM Registration. - `external_id` string: The ID of the member given by the identity provider. - `scim_attributes` ApiB2bScimV1SCIMAttributes - `user_name` string, required - `id` string, required - `external_id` string, required - `active` boolean, required - `groups` ApiB2bScimV1Group[], required - `value` string, required - `display` string, required - `display_name` string, required - `nick_name` string, required - `profile_url` string, required - `user_type` string, required - `title` string, required - `preferred_language` string, required - `locale` string, required - `timezone` string, required - `emails` ApiB2bScimV1Email[], required - `value` string, required - `type` string, required - `primary` boolean, required - `phone_numbers` ApiB2bScimV1PhoneNumber[], required - `value` string, required - `type` string, required - `primary` boolean, required - `addresses` ApiB2bScimV1Address[], required - `formatted` string, required - `street_address` string, required - `locality` string, required - `region` string, required - `postal_code` string, required - `country` string, required - `type` string, required - `primary` boolean, required - `ims` ApiB2bScimV1IMs[], required - `value` string, required - `type` string, required - `primary` boolean, required - `photos` ApiB2bScimV1Photo[], required - `value` string, required - `type` string, required - `primary` boolean, required - `entitlements` ApiB2bScimV1Entitlement[], required - `value` string, required - `type` string, required - `primary` boolean, required - `roles` ApiB2bScimV1Role[], required - `value` string, required - `type` string, required - `primary` boolean, required - `x509certificates` ApiB2bScimV1X509Certificate[], required - `value` string, required - `type` string, required - `primary` boolean, required - `name` ApiB2bScimV1Name - `formatted` string, required - `family_name` string, required - `given_name` string, required - `middle_name` string, required - `honorific_prefix` string, required - `honorific_suffix` string, required - `enterprise_extension` ApiB2bScimV1EnterpriseExtension - `employee_number` string, required - `cost_center` string, required - `division` string, required - `department` string, required - `organization` string, required - `manager` ApiB2bScimV1Manager - `value` string, required - `ref` string, required - `display_name` string, required - `external_id` string: The ID of the member given by the identity provider. - `lock_created_at` string: When the member lock was created, if there is one. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`. - `lock_expires_at` string: When the member lock expires, if there is one. Values conform to the RFC 3339 standard and are expressed in UTC, e.g. `2021-12-29T12:33:09Z`. - `results_metadata` ApiOrganizationV1ResultsMetadata, required - `total` integer, required: The total number of results returned by your search query. If totals have been disabled for your Stytch Workspace to improve search performance, the value will always be -1. - `next_cursor` string: The `next_cursor` string is returned when your search result contains more than one page of results. This value is passed into your next search call in the `cursor` field. - `organizations` object, required - `status_code` integer, 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. ## Other responses - `400`: Bad request - `401`: Unauthorized - `429`: Too Many Requests - `500`: Internal server error ## Changes - **2026-03-07** `110f26a94e5b`: 1 info - endpoint added - **2026-03-06** `9cab20b8eca7`: 1 breaking - api path removed without deprecation - **2026-01-09** `7dfcc14e566c`: 7 breaking, 1 info - the `query/operands/items/` request property type changed from `string` to `object` - the `members/items/roles/items/sources/items/details` response's property type changed from `string` to `object` for status `200` - the `members/items/sso_registrations/items/sso_attributes` response's property type changed from `string` to `object` for status `200` - the `members/items/trusted_metadata` response's property type changed from `string` to `object` for status `200` - …4 more - **2025-10-20** `a4801149ed74`: 2 info - added the new optional `header` request parameter `X-Stytch-Member-Session` - added the new optional `header` request parameter `X-Stytch-Member-SessionJWT` - **2025-09-17** `8270cf3a3d4c`: 3 info - added the media type `application/json` for the response with the status `401` - added the media type `application/json` for the response with the status `500` - added the non-success response with the status `429` [Operation history](https://skmtc.dev/stytch/apis/stytch-api/changes/v1/b2b/organizations/members/search/post.md) --- [API](https://skmtc.dev/stytch/apis/stytch-api.md) - [All operations](https://skmtc.dev/stytch/apis/stytch-api/llms.txt) - [OpenAPI document](https://skmtc.dev/stytch/apis/stytch-api/revisions/6d1ff7474803?raw)