Search for Members

POSThttps://test.stytch.com/v1/b2b/organizations/members/search

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.

Our RBAC implementation offers out-of-the-box handling of authorization checks for this endpoint. If you pass in a header containing a session_token or a session_jwt for an unexpired Member Session, we will check that the Member Session has permission to perform the search action on the stytch.member Resource. In addition, enforcing RBAC on this endpoint means that you may only search for Members within the calling Member's Organization, so the organization_ids argument may only contain the organization_id of the Member Session passed in the header.

If the Member Session does not contain a Role that satisfies the requested permission, or if the organization_ids argument contains an organization_id that the Member Session does not belong to, a 403 error will be thrown. Otherwise, the request will proceed as normal.

To learn more about our RBAC implementation, see our RBAC guide.


Body parameters


organization_ids*array[strings]

cursorstring

limitint

queryobject

Header parameters


X-Stytch-Member-Sessionstring

X-Stytch-Member-SessionJWTstring

Response fields


request_idstring

status_codeint

results_metadataobject

membersarray[objects]

organizationsmap<string, object>
curl --request POST \
  --url https://test.stytch.com/v1/b2b/organizations/members/search \
  -u 'PROJECT_ID:SECRET' \
  -H 'Content-Type: application/json' \
  -H "X-Stytch-Member-Session: mZAYn5aLEqKUlZ_Ad9U_fWr38GaAQ1oFAhT8ds245v7Q" \
  -d '{
    "organization_ids": ["organization-test-07971b06-ac8b-4cdb-9c15-63b17e653931"]
  }'

RESPONSE

200
{
  "status_code": 200,
  "request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
  "results_metadata": {
		"next_cursor": null,
		"total": 5
	},
  "members": [
    ...
  ]
  "organizations": <
    ...
  >
}

Common Error Types