Transfers

Lists the organization's inventory transfers, oldest first, one page at a time.

Requires ManageTransfers (the Transfers pages need it for reads too). 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/transfers?jobId=1042&status=Pending. The approval queue (what the Pending Approvals page lists, and what approve / reject accept) is GET /api/v1/transfers?approvalStatus=Pending&status=Pending. 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/transfers

Request

  • Base URL: https://app.flexonthejob.com
  • URL: https://app.flexonthejob.com/api/v1/transfers
  • Auth: HTTP bearer

Query parameters

jobIdinteger

Only transfers for this job id (see /api/v1/jobs).

statusstring

Transfer status name to match exactly (case-insensitive), e.g. Pending, InTransit, Completed, Cancelled.

approvalStatusstring

Approval state to match exactly (case-insensitive): Pending (awaiting a decision), Approved or Rejected. Transfers that never needed approval are excluded whenever this is set. Example: approvalStatus=Pending.

updatedSincestring date-time

Only transfers created or modified 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 transfer 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 transfers 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.