Skip to main content
POST
/
v1
/
b2b
/
organizations
/
members
/
search
C#
// POST /v1/b2b/organizations/members/search
const stytch = require('stytch');

const client = new stytch.B2BClient({
  project_id: '${projectId}',
  secret: '${secret}',
});

const params = {
  organization_ids: ["${organizationId}"],
};

const options = {
  authorization: {
    session_token: '${sessionToken}',
  },
};

client.Organizations.Members.Search(params, options)
  .then(resp => { console.log(resp) })
  .catch(err => { console.log(err) });
{
  "request_id": "<string>",
  "members": [
    {
      "organization_id": "<string>",
      "member_id": "<string>",
      "email_address": "<string>",
      "status": "<string>",
      "name": "<string>",
      "sso_registrations": [
        {
          "connection_id": "<string>",
          "external_id": "<string>",
          "registration_id": "<string>",
          "sso_attributes": {}
        }
      ],
      "is_breakglass": true,
      "member_password_id": "<string>",
      "oauth_registrations": [
        {
          "provider_type": "<string>",
          "provider_subject": "<string>",
          "member_oauth_registration_id": "<string>",
          "profile_picture_url": "<string>",
          "locale": "<string>"
        }
      ],
      "email_address_verified": true,
      "mfa_phone_number_verified": true,
      "is_admin": true,
      "totp_registration_id": "<string>",
      "retired_email_addresses": [
        {
          "email_id": "<string>",
          "email_address": "<string>"
        }
      ],
      "is_locked": true,
      "mfa_enrolled": true,
      "mfa_phone_number": "<string>",
      "default_mfa_method": "<string>",
      "roles": [
        {
          "role_id": "<string>",
          "sources": [
            {
              "type": "<string>",
              "details": {}
            }
          ]
        }
      ],
      "trusted_metadata": {},
      "untrusted_metadata": {},
      "created_at": "<string>",
      "updated_at": "<string>",
      "scim_registration": {
        "connection_id": "<string>",
        "registration_id": "<string>",
        "external_id": "<string>",
        "scim_attributes": {
          "user_name": "<string>",
          "id": "<string>",
          "external_id": "<string>",
          "active": true,
          "groups": [
            {
              "value": "<string>",
              "display": "<string>"
            }
          ],
          "display_name": "<string>",
          "nick_name": "<string>",
          "profile_url": "<string>",
          "user_type": "<string>",
          "title": "<string>",
          "preferred_language": "<string>",
          "locale": "<string>",
          "timezone": "<string>",
          "emails": [
            {
              "value": "<string>",
              "type": "<string>",
              "primary": true
            }
          ],
          "phone_numbers": [
            {
              "value": "<string>",
              "type": "<string>",
              "primary": true
            }
          ],
          "addresses": [
            {
              "formatted": "<string>",
              "street_address": "<string>",
              "locality": "<string>",
              "region": "<string>",
              "postal_code": "<string>",
              "country": "<string>",
              "type": "<string>",
              "primary": true
            }
          ],
          "ims": [
            {
              "value": "<string>",
              "type": "<string>",
              "primary": true
            }
          ],
          "photos": [
            {
              "value": "<string>",
              "type": "<string>",
              "primary": true
            }
          ],
          "entitlements": [
            {
              "value": "<string>",
              "type": "<string>",
              "primary": true
            }
          ],
          "roles": [
            {
              "value": "<string>",
              "type": "<string>",
              "primary": true
            }
          ],
          "x509certificates": [
            {
              "value": "<string>",
              "type": "<string>",
              "primary": true
            }
          ],
          "name": {
            "formatted": "<string>",
            "family_name": "<string>",
            "given_name": "<string>",
            "middle_name": "<string>",
            "honorific_prefix": "<string>",
            "honorific_suffix": "<string>"
          },
          "enterprise_extension": {
            "employee_number": "<string>",
            "cost_center": "<string>",
            "division": "<string>",
            "department": "<string>",
            "organization": "<string>",
            "manager": {
              "value": "<string>",
              "ref": "<string>",
              "display_name": "<string>"
            }
          }
        }
      },
      "external_id": "<string>",
      "lock_created_at": "<string>",
      "lock_expires_at": "<string>"
    }
  ],
  "results_metadata": {
    "total": 123,
    "next_cursor": "<string>"
  },
  "organizations": {},
  "status_code": 123
}
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.
Search for within specified .
RBAC Enforced APIIf a Member Session is passed in the Authorization headers, Stytch will enforce that the Member has permission to take the Action on the Resource prior to honoring the request.To learn more, see the RBAC guide.
Submitting an empty query returns all non-deleted Members within the specified Organizations. By default, this endpoint will not return deleted Members. To include deleted Members in the search results, explicitly include the deleted status in the statuses filter.
All fuzzy search filters require a minimum of three characters.

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Stytch-Member-Session
string

A Stytch session that can be used to run the request with the given member's permissions.

​
X-Stytch-Member-SessionJWT
string

A Stytch Session JSON Web Token (JWT) that can be used to run the request with the given member's permissions.

Body

application/json

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

​
members
object[]
required

An array of Member objects.

​
results_metadata
object
required

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

​
organizations
object
required
​
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.