# List Reimbursements

**GET** `/users/{user_id}/reimbursements`

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

Requires the `benefit_account` key scope. `receipt_url` is omitted on list reads.

## Authorization

- PartnerKey (http, bearer)

## Path parameters

- `user_id` (string, required)
  The Sail user id.

## Query parameters

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

## Responses

### 200

Reimbursements.

- `data` (object[])
  - `id` (string)
    The Sail reimbursement id.
  - `status` ("pending" | "submitted" | "processing" | "completed" | "failed")
    The reimbursement's current processing status.
  - `amount` (number<float>)
    Sum of the included expenses, USD.
  - `account_id` (string)
    The funding account. Join to /accounts/{account_id} for provider and balance context.
  - `expenses` (object[])
    The expenses included in this reimbursement.
    - `id` (string)
      The Sail expense id.
    - `name` (string)
      The expense's display name.
    - `amount` (number<float>)
      The expense's amount, USD.
    - `date` (string<date>)
      The expense's transaction date.
  - `receipt_url` (string)
    Reimbursement receipt document. Populated once `completed`; present on the single-resource GET only.
  - `submitted_at` (string<date-time>)
    When the reimbursement was submitted for processing.
  - `completed_at` (string<date-time>)
    When the reimbursement completed. Null while still in progress.
- `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": "reimb_8c1f",
      "status": "pending",
      "amount": 0,
      "account_id": "string",
      "expenses": [
        {
          "id": "string",
          "name": "string",
          "amount": 0,
          "date": "2024-01-01"
        }
      ],
      "receipt_url": "string",
      "submitted_at": "1970-01-01T00:00:00.000Z",
      "completed_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"
  }
}
```