FileMaster

Edit File: list-disputes-request.md

# List Disputes Request

Defines the request parameters for the `ListDisputes` endpoint.

## Structure

`ListDisputesRequest`

## 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 results for the original query. For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination). | getCursor(): ?string | setCursor(?string cursor): void |
| `states` | [`?(string(DisputeState)[])`](../../doc/models/dispute-state.md) | Optional | The dispute states used to filter the result. If not specified, the endpoint returns all disputes. See [DisputeState](#type-disputestate) for possible values | getStates(): ?array | setStates(?array states): void |
| `locationId` | `?string` | Optional | The ID of the location for which to return a list of disputes. If not specified, the endpoint returns disputes associated with all locations. **Constraints**: *Minimum Length*: `1`, *Maximum Length*: `40` | getLocationId(): ?string | setLocationId(?string locationId): void |

## Example (as JSON)

```json
{
  "cursor": "cursor2",
  "states": [
    "INQUIRY_EVIDENCE_REQUIRED",
    "INQUIRY_PROCESSING",
    "INQUIRY_CLOSED"
  ],
  "location_id": "location_id8"
}
```

Back