Filter approvals by type or status

POST/v1/api/store/{team_slug}/approvals/filter

v1Operation ID v1_public_approvals_filter

Lists approvals like GET /v1/api/store/{team_slug}/approvals, narrowed by type and status, with an optional sort. For example, everything still waiting on the customer: status in pending, sent-to-customer, viewed-by-customer.

Each filter is {key, operator, value} with operator in or nin and value a list. Several filters must all match. Send page in the body or the query string.

Permission

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

Business rules

• filters is optional. If you send it, it can't be empty. Leaving it out returns every approval, like the list. Filter keys are type and status only.
• value must be a list, even for one value.
• Sort keys: id, order_id, job_id, type, completed_at, created_at, status; direction asc or desc.

Path parameters

• team_slugstringrequired

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

  • Example your-team

Request body

application/json, optional.

• filtersarray of objects
  • At least 1 item
  Fields of each item (3)

  • keystringrequired
    • One of: "type", "status"
  • operatorstringrequired

    in: any of the values. nin: none of them.

    • One of: "in", "nin"
  • valuearray of stringsrequired

    For type: job, order. For status: the approval statuses.

• pageinteger
  • Minimum 1
• sortarray of objects
  Fields of each item (2)

  • directionstringrequired
    • One of: "asc", "desc"
  • keystringrequired
    • One of: "id", "order_id", "job_id", "type", "completed_at", "created_at", "status"

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.

• 422The request was refused and changed nothing. validation_failed lists what to fix in error.fields; other codes name a business rule, explained in error.message. A few checks answer with only {"message": "..."}. An operation that calls another service (a payment provider, a carrier, an accounting app) can answer connect_timeout ("Please retry again") when that service does not answer in time: the change may or may not have happened there, so read the record back before you retry.

  When

  filters is an empty list, a key or operator is not allowed, value is not a list, or a sort key or direction is not allowed (validation_failed, with the problem under error.fields).

  Fix

  Send at least one {key, operator, value} with an allowed key, in or nin, and a list, or leave filters out. Write direction in lower case.

Notes

• Without sort, the order of results is not defined. Send a sort, such as created_at desc, when you page.

Related

• GETList approvals/v1/api/store/{team_slug}/approvals

Example request

curl

curl -X POST 'https://secure.yoprint.com/v1/api/store/your-team/approvals/filter' \  -H 'Authorization: Bearer YOUR_API_KEY' \  -H 'Accept: application/json' \  -H 'X-Yoprint-Decimal-Format: exact-v1' \  -H 'Content-Type: application/json' \  -d '{    "filters": [      {        "key": "status",        "operator": "in",        "value": [          "pending",          "sent-to-customer",          "viewed-by-customer"        ]      }    ],    "sort": [      {        "direction": "desc",        "key": "created_at"      }    ]  }'

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
}