PurchaseOrders

Lists the organization's purchase orders, oldest first, one page at a time.

Requires ViewPurchaseOrders. Deleted orders are never returned. Pagination: pass the previous response's nextCursor as after; limit defaults to 50 and is capped at 200. All filters combine with AND. Example: GET /api/v1/purchase-orders?status=Delivered&vendorId=7 lists what is waiting to be received from vendor 7. Response carries a weak ETag; resend it as If-None-Match to get 304 when nothing changed. Also available as CSV (Accept: text/csv or ?format=csv); paging cursor in X-Next-Cursor.

get/api/v1/purchase-orders

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/purchase-orders
  • Auth: HTTP bearer

Query parameters

statusstring

Order status name to match exactly (case-insensitive): Draft, Ordered, Shipped, PartialShipped, Delivered, PartialReceived, Received or Cancelled. Example: status=PartialReceived.

vendorIdinteger

Only orders placed with this vendor id. Example: vendorId=7.

updatedSincestring date-time

Only orders created or modified (a receipt counts) at or after this instant (ISO-8601 UTC, e.g. 2026-09-01T00:00:00Z). Use it to poll for changes.

afterstring

Cursor from the previous page's nextCursor (a purchase-order SyncId). Omit for the first page.

limitinteger

Page size, 1–200 (default 50).

format'csv'

Alternative to the Accept header: csv returns text/csv.

Response

A page of purchase orders and the cursor for the next page (null on the last page).

nextCursorstring nullable

SyncId of the last item; pass it back as ?after= to fetch the next page. null when this is the last page.

Changes

No recorded changes to this operation across all 1 revision of this API.