# List approvals

```http
GET https://secure.yoprint.com/v1/api/store/{team_slug}/approvals
```

- API version: v1
- Operation ID: `v1_public_approvals_index`
- Section: Sales › [Approvals](https://developer.yoprint.com/reference/approvals.md)
- Web page: https://developer.yoprint.com/reference/approvals/v1-approvals-index/
- Authentication: `Authorization: Bearer YOUR_API_KEY`

Lists customer approvals across all of your team's sales orders and quotes, newest first.

An approval asks the customer to sign off, in the customer portal, on either a job's artwork (`type` `job`) or the whole order (`type` `order`). The customer approves or asks for changes; `status` follows that. Approvals are created on the order (the sales order approval operations), not here.

Draft orders, deleted orders and Shopify orders are left out. The page size is your team's list size setting (50 unless changed); use `page` to read further. To filter by type or status, use `POST /v1/api/store/{team_slug}/approvals/filter`.

## Permission

Any member of the team. The list is not narrowed to orders you can see.

## Path parameters

- `team_slug` (string, required): Your team slug, shown as Team ID next to your API key in Profile. Example `your-team`.

## Query parameters

- `page` (integer, optional): The page to read, from 1. Default `1`. Minimum 1.

## Request body

This operation takes no request body.

### Example request

```bash
curl 'https://secure.yoprint.com/v1/api/store/your-team/approvals' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'X-Yoprint-Decimal-Format: exact-v1'
```

## Response

`200` Successful response.

Fields:

- `data` (array of objects, required)
  - Each item:
    - `approved_by` (string, optional): `user` when a team member completed it. Otherwise `customer`, even before anyone has approved it, and also when a Customer Portal contact approved it (Get an approval names the contact). One of: `"user"`, `"customer"`.
    - `approved_by_user` (string | null, optional): The hash id of the team member who completed it on the customer's behalf, if any.
    - `completed` (boolean, optional): True once the customer finished, whether they approved or asked for changes.
    - `completed_at` (string (date-time) | null, optional)
    - `created_at` (string (date-time), optional)
    - `customer_id` (integer | null, optional): A plain number for the customer, not a hash id: no operation takes it. Use `order_id` to reach the customer.
    - `customer_last_viewed_date` (string (date-time) | null, optional)
    - `customer_name` (string | null, optional)
    - `id` (string, optional)
    - `job_id` (string | null, optional): Job approvals only.
    - `job_name` (string, optional): An empty string for order approvals.
    - `job_scoped_id` (string, optional): The job number, such as `JOB-1001`. An empty string for order approvals.
    - `notes_from_customer` (string | null, optional)
    - `notes_to_customer` (string | null, optional)
    - `order_external_type` (string | null, optional)
    - `order_id` (string | null, optional)
    - `order_name` (string | null, optional)
    - `order_object_type` (string | null, optional): `sales_order` or `quote`. One of: `"sales_order"`, `"quote"`.
    - `order_quote` (boolean, optional): True when the approval is on a quote.
    - `order_scoped_id` (string, optional): The order or quote number.
    - `request_by` (string | null, optional): A team member's hash id, or null. Approvals created in the web app or through the API are null here: neither records who requested them.
    - `signature` (string | null, optional): The customer's signature, when they signed.
    - `status` (string, optional): `pending`: not sent yet. `sent-to-customer`: emailed. `viewed-by-customer`: the customer opened it. `need-changes`: the customer finished and asked for changes ("Review requested"). `completed`: approved. One of: `"pending"`, `"sent-to-customer"`, `"viewed-by-customer"`, `"need-changes"`, `"completed"`.
    - `type` (string, optional): `job`: artwork approval for one job's mockups. `order`: approval of the whole order. One of: `"job"`, `"order"`.
- `status` (integer, required)
- `success` (boolean, required)
- `pagination` (object, optional)
  - `count` (integer, required)
  - `currentPage` (integer, required)
  - `links` (object | array of any, required): Links to the neighbouring pages: `previous` and `next`, each present only when that page exists. An empty list, `[]`, when there is only one page.
    - `next` (string (uri), optional): The next page.
    - `previous` (string (uri), optional): The previous page.
  - `perPage` (integer, required)
  - `total` (integer, required)
  - `totalPages` (integer, required)

Example response:

```json
{
  "data": [
    {
      "approved_by": "customer",
      "approved_by_user": null,
      "completed": false,
      "completed_at": null,
      "created_at": "2026-11-03T09:30:00+00:00",
      "customer_id": 2001,
      "customer_last_viewed_date": null,
      "customer_name": "Northwind Apparel",
      "id": "Fi0zPeMlwKadEo",
      "job_id": "K6iF8n29iwOZnj",
      "job_name": "Front logo",
      "job_scoped_id": "JOB-1001",
      "notes_from_customer": null,
      "notes_to_customer": "Please check the logo size.",
      "order_external_type": null,
      "order_id": "V4keXwwxMQyXw7",
      "order_name": "Spring team shirts",
      "order_object_type": "sales_order",
      "order_quote": false,
      "order_scoped_id": "SO1001",
      "request_by": null,
      "signature": null,
      "status": "sent-to-customer",
      "type": "job"
    }
  ],
  "pagination": {
    "count": 1,
    "currentPage": 1,
    "links": [],
    "perPage": 50,
    "total": 1,
    "totalPages": 1
  },
  "status": 200,
  "success": true
}
```

## Errors

- `401` The API key is missing or wrong (`unauthenticated`).
- `403` You are not allowed to do this. `api_access_not_in_plan`: your team's plan doesn't include API access (Pro and above, with an active subscription or trial), so every request answers this until the team upgrades. When your role lacks the permission the operation needs, the body is only `{"message": "Insufficient Permission"}`. Other refusals use the error envelope, with `unauthorized` or `user_is_not_authorized`.
- `404` Not found. `page_not_found`: the team slug is unknown, you are not a member of the team, or an id in the path is not one of this team's. `code: null`, with a message that starts "No query results for": there is no record with that id.

## Notes

- `customer_id` here is a plain number, not the hash id other operations take. To reach the customer, read the order with `order_id`.
- `completed` is true for both approved and changes-requested approvals; read `status` to tell them apart.

## Related

- [Filter approvals by type or status](https://developer.yoprint.com/reference/approvals/v1-approvals-filter.md): `POST /v1/api/store/{team_slug}/approvals/filter`
- [Get the approvals on an approval's order](https://developer.yoprint.com/reference/approvals/v1-approvals-show.md): `GET /v1/api/store/{team_slug}/approvals/{hash_id}`
- [Email an approval request to the customer](https://developer.yoprint.com/reference/approvals/v1-approvals-send-to-customer.md): `PATCH /v1/api/store/{team_slug}/approvals/{hash_id}/send_to_customer`
- [Ask the customer to approve an order](https://developer.yoprint.com/reference/sales-order-approvals/v2-order-approval-store.md): `POST /v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval`