> ## Documentation Index
> Fetch the complete documentation index at: https://docs.storerocket.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List locations

> Read a paginated list with supported filters and optional relationships.

Requires `location:read` and project API access. Returns a `data` array with pagination `links` and `meta`.

<ParamField path="project_id" type="string" required>The public project ID returned by [List projects](/api/projects).</ParamField>
<ParamField query="page" type="integer" default="1">Page to retrieve.</ParamField>
<ParamField query="limit" type="integer" default="15">Page size. Use 1 to 100; larger values use the default size.</ParamField>
<ParamField query="includeHours" type="integer">Send `1` to include the hours object, or null if there is no schedule.</ParamField>
<ParamField query="includeFilters" type="integer">Send `1` to include the filters array.</ParamField>
<ParamField query="includeFields" type="integer">Send `1` to include the custom-fields array.</ParamField>
<ParamField query="includeCallsToAction" type="integer">Send `1` to include the calls-to-action array.</ParamField>

Omit an include flag or use `0` to leave that relationship out. Use numeric `1`/`0`, rather than the string `false`.

<RequestExample>
  ```bash theme={null}
  curl --get 'https://storerocket.io/api/v2/projects/PROJECT_ID/locations' \
    -H 'Authorization: Bearer YOUR_TOKEN' \
    -H 'Accept: application/json' \
    --data-urlencode 'limit=25' \
    --data-urlencode 'city[eq]=Seattle' \
    --data-urlencode 'includeHours=1'
  ```
</RequestExample>

## Supported filters

| Field | Operators |
| - | - |
| `name` | `eq`, `ne`, `like` |
| `address` | `eq`, `like` |
| `city` | `eq`, `like` |
| `state` | `eq`, `like` |
| `country` | `eq`, `like` |
| `postalCode` | `eq` |

Use bracket notation, such as `city[eq]=Seattle` or `name[like]=Downtown`. `like` matches a substring. Supplied filters are combined.
The query field is `postalCode`, although the location response uses `postcode`. Plain `city=Seattle`, `postcode=98101`, and `visible` are not supported list filters.
Use `--data-urlencode` in curl for bracketed parameters.

## Response

Each element of `data` uses the [location response format](/api/locations/get#response-format). Follow `links.next` until it is null, or use `meta.current_page` and `meta.last_page`.

Errors: `401` authentication, `403` access/permission, `404` inaccessible project, `429` rate limit. See [errors](/api/errors).


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.