Stytch · Schema

api_m2m_v1_m2m_clients_SearchRequest

Request type

AuthenticationIdentityPasswordlessSecurityB2BConnected AppsMCPAI AgentsDeveloper Tools

Properties

Name Type Description
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 usin
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 on
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 appl
View JSON Schema on GitHub

JSON Schema

stytch-api-m2m-v1-m2m-clients-searchrequest-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/api_m2m_v1_m2m_clients_SearchRequest",
  "title": "api_m2m_v1_m2m_clients_SearchRequest",
  "type": "object",
  "properties": {
    "cursor": {
      "type": "string",
      "description": "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": {
      "type": "integer",
      "format": "int32",
      "minimum": 0,
      "description": "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": {
      "$ref": "#/components/schemas/api_m2m_v1_M2MSearchQuery",
      "description": "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 results with no filtering applied."
    }
  },
  "description": "Request type"
}