FileMaster

Edit File: search-events-request.md

# Search Events Request

Searches [Event](../../doc/models/event.md)s for your application.

## Structure

`SearchEventsRequest`

## Fields

| Name | Type | Tags | Description | Getter | Setter |
| --- | --- | --- | --- | --- | --- |
| `cursor` | `?string` | Optional | A pagination cursor returned by a previous call to this endpoint. Provide this cursor to retrieve the next set of events for your original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). **Constraints**: *Maximum Length*: `256` | getCursor(): ?string | setCursor(?string cursor): void |
| `limit` | `?int` | Optional | The maximum number of events to return in a single page. The response might contain fewer events. The default value is 100, which is also the maximum allowed value. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). Default: 100 **Constraints**: `>= 1`, `<= 100` | getLimit(): ?int | setLimit(?int limit): void |
| `query` | [`?SearchEventsQuery`](../../doc/models/search-events-query.md) | Optional | Contains query criteria for the search. | getQuery(): ?SearchEventsQuery | setQuery(?SearchEventsQuery query): void |

## Example (as JSON)

```json
{
  "cursor": "cursor8",
  "limit": 176,
  "query": {
    "filter": {
      "event_types": [
        "event_types2",
        "event_types3"
      ],
      "merchant_ids": [
        "merchant_ids1",
        "merchant_ids2"
      ],
      "location_ids": [
        "location_ids4"
      ],
      "created_at": {
        "start_at": "start_at4",
        "end_at": "end_at8"
      }
    },
    "sort": {
      "field": "DEFAULT",
      "order": "DESC"
    }
  }
}
```

Back