search-subscriptions-request.md

Search Subscriptions Request

Defines input parameters in a request to the SearchSubscriptions endpoint.

Structure

SearchSubscriptionsRequest

Fields

Name	Type	Tags	Description
cursor	string | undefined	Optional	When the total number of resulting subscriptions exceeds the limit of a paged response, specify the cursor returned from a preceding response here to fetch the next set of results. If the cursor is unset, the response contains the last page of the results. For more information, see Pagination.
limit	number | undefined	Optional	The upper limit on the number of subscriptions to return in a paged response. Constraints: >= 1
query	SearchSubscriptionsQuery | undefined	Optional	Represents a query, consisting of specified query expressions, used to search for subscriptions.
include	string[] | undefined	Optional	An option to include related information in the response. The supported values are: - actions: to include scheduled actions on the targeted subscriptions.

Example (as JSON)

{
  "query": {
    "filter": {
      "customer_ids": [
        "CHFGVKYY8RSV93M5KCYTG4PN0G"
      ],
      "location_ids": [
        "S8GWD5R9QB376"
      ],
      "source_names": [
        "My App"
      ]
    }
  },
  "cursor": "cursor6",
  "limit": 172,
  "include": [
    "include8",
    "include9"
  ]
}