# Get a list of sites

**GET /api/v1/sites**

Retrieve all sites associated with the authenticated API token. If the API token is scoped to one site, only that site will be returned. If the API token is scoped to the entire account, all sites under that account will be returned.


## Servers
- https://publicapi.ekareinc.com: https://publicapi.ekareinc.com ()


## Authentication methods
- Api key auth


## Parameters


### Query parameters
- **per_page** (integer)
  Number of items per page.
- **fields** (string(csv))
  Comma-separated list of fields to be returned in the response. Only 'id', 'name', 'web', 'address', 'country', 'province', and 'created_at' columns are allowed.
- **filter** (object)
  Filter criteria to narrow down the list of sites. The filter parameter is an object with key-value pairs where the key is the field to filter by and the value is '{operator}{value}'. The operator is optional and defaults to '='. (e.g. '/sites?filter[id]=>100&filter[created_at]=>2021-01-01')
- **sort** (string)
  Field to sort the results by. Only 'id' and 'created_at' columns are allowed, prefixed with a minus sign (-) for descending order and without for ascending order.


## Responses
### 200
Successful operation

#### Body: application/json (object)
- **data** (array[object])

- **metadata** (object)


### 401
Unauthorized

#### Body: application/json (object)
- **error** (string)

- **message** (string)

- **error_code** (number)


### 403
Forbidden

#### Body: application/json (object)
- **error** (string)

- **message** (string)

- **error_code** (number)


### 422
Bad Request

#### Body: application/json (object)
- **error** (string)

- **message** (string)

- **error_code** (number)



[Powered by Bump.sh](https://bump.sh)