# List Users

**GET** `/users`

Base URL: `https://live.savewithsail.com/api/v1`

Returns all users under your partner account, optionally filtered by status.

## Authorization

- PartnerKey (http, bearer)

## Query parameters

- `status` (string)
  Filter to users with this status.
- `limit` (integer)
  Max results per page.
- `offset` (integer)
  Pagination offset.

## Responses

### 200

Users under your partner account.

- `data` (object[])
  - `id` (string)
    The Sail user id.
  - `external_user_id` (string)
    Echo of the `external_user_id` supplied at creation.
  - `status` ("active" | "inactive")
    Whether the user is active or inactive.
  - `created_at` (string<date-time>)
    When the user was created.
- `pagination` (object)
  Pagination metadata for this page.
  - `total` (integer)
    Total number of matching records, across all pages.
  - `limit` (integer)
    The `limit` used for this page.
  - `offset` (integer)
    The `offset` used for this page.
  - `has_more` (boolean)
    Whether additional pages remain after this one.

Example:

```json
{
  "data": [
    {
      "id": "usr_abc123",
      "external_user_id": "string",
      "status": "active",
      "created_at": "1970-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "total": 0,
    "limit": 0,
    "offset": 0,
    "has_more": true
  }
}
```

### default

Standard error envelope covering 400, 401, 403, 404, 429, and 500.

- `error` (object)
  The error detail.
  - `code` (string)
    Machine-readable code, e.g. `not_found`, `token_scope_mismatch`, `product_not_enabled`, `insufficient_key_scope`, `insufficient_token_scope`, `user_token_required`, `user_token_expired`, `invalid_user_token`, `invalid_key_configuration`, `connection_not_reconnectable`, `rate_limited`.
  - `message` (string)
    Human-readable error message. May change, so match on `error.code` instead.
  - `param` (string)
    The request field that caused the error, when applicable. Null otherwise.

Example:

```json
{
  "error": {
    "code": "string",
    "message": "string",
    "param": "string"
  }
}
```