List approvals

GET/v1/api/store/{team_slug}/approvals

v1Operation ID v1_public_approvals_index

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_slugstringrequired

  Your team slug, shown as Team ID next to your API key in Profile.

  • Example your-team

Query parameters

• pageinteger

  The page to read, from 1.

  • Default 1
  • Minimum 1

Request body

This operation takes no request body.

Response

200Successful response.

• dataarray of objectsrequired
  Fields of each item (24)

  • approved_bystring

    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_userstring | null

    The hash id of the team member who completed it on the customer's behalf, if any.

  • completedboolean

    True once the customer finished, whether they approved or asked for changes.

  • completed_atstring (date-time) | null
  • created_atstring (date-time)
  • customer_idinteger | null

    A plain number for the customer, not a hash id: no operation takes it. Use order_id to reach the customer.

  • customer_last_viewed_datestring (date-time) | null
  • customer_namestring | null
  • idstring
  • job_idstring | null

    Job approvals only.

  • job_namestring

    An empty string for order approvals.

  • job_scoped_idstring

    The job number, such as JOB-1001. An empty string for order approvals.

  • notes_from_customerstring | null
  • notes_to_customerstring | null
  • order_external_typestring | null
  • order_idstring | null
  • order_namestring | null
  • order_object_typestring | null

    sales_order or quote.

    • One of: "sales_order", "quote"
  • order_quoteboolean

    True when the approval is on a quote.

  • order_scoped_idstring

    The order or quote number.

  • request_bystring | null

    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.

  • signaturestring | null

    The customer's signature, when they signed.

  • statusstring

    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"
  • typestring

    job: artwork approval for one job's mockups. order: approval of the whole order.

    • One of: "job", "order"
• statusintegerrequired
• successbooleanrequired
• paginationobject
  Child fields (6)

  • countintegerrequired
  • currentPageintegerrequired
  • linksobject | array of anyrequired

    Links to the neighbouring pages: previous and next, each present only when that page exists. An empty list, [], when there is only one page.

    Child fields (2)

    • nextstring (uri)

      The next page.

    • previousstring (uri)

      The previous page.

  • perPageintegerrequired
  • totalintegerrequired
  • totalPagesintegerrequired

Errors

• 401The API key is missing or wrong (unauthenticated).

• 403You 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.

• 404Not 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

• POSTFilter approvals by type or status/v1/api/store/{team_slug}/approvals/filter
• GETGet the approvals on an approval's order/v1/api/store/{team_slug}/approvals/{hash_id}
• PATCHEmail an approval request to the customer/v1/api/store/{team_slug}/approvals/{hash_id}/send_to_customer
• POSTAsk the customer to approve an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/approval

Example request

curl

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'

Example response 200

Response

{
  "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
}