Passer au contenu principal
GET
List proposals

Autorisations

X-API-KEY
string
header
requis
OW-KEY
string
header
requis

OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.

Paramètres de requête

offset
integer

Number of records to skip.

Plage requise: x >= 0
limit
integer
défaut:10

Page size. Default 10, maximum 25.

Plage requise: 1 <= x <= 25
sort_by
string

Field to sort by: createdAt, updatedAt, totalAfterTax, id, workOrderId, locationId, supplierFacilityId, or buyerFacilityId. Omit for id ascending.

order
enum<string>

Sort direction.

Options disponibles:
asc,
desc

Matches part of the work order title. A numeric value also matches the proposal id or the work order id exactly.

status
string

One proposal status, lowercase: pending, awarded, declined. Drafts are never returned to buyers.

statuses
string

Several proposal statuses, lowercase (pending, awarded, declined). Comma-separated list with no spaces; matches any value listed.

workOrderId
integer

Proposals on one work order.

locationId
integer

Proposals for one location. Get location ids from GET /v1/buyer/location/locations.

locationIds
string

Proposals for these locations. Comma-separated list with no spaces; matches any value listed.

regionIds
string

Proposals for work orders at locations in these regions. Comma-separated list with no spaces; matches any value listed.

problemTypeIds
string

Proposals whose work order has one of these problem types. Comma-separated list with no spaces; matches any value listed.

woPriorityIds
string

Proposals whose work order has one of these priorities. Comma-separated list with no spaces; matches any value listed.

isCapex
enum<string>

true returns only proposals for work orders flagged as capital expenditure; false leaves them out.

Options disponibles:
true,
false
supplierFacilityId
integer

Proposals from one supplier. Get supplier facility ids from GET /v1/buyer/supplier_facilities.

supplierFacilityIds
string

Proposals from these suppliers. Comma-separated list with no spaces; matches any value listed.

createdAtStartDate
string

Earliest creation time to include, inclusive. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970. Send either end on its own for an open-ended range.

createdAtEndDate
string

Latest creation time to include. The whole end day is included: the time part is replaced with 23:59:59 on that date in timezone. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

approvedAtStartDate
string

Earliest award time to include, inclusive. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970. Send either end on its own for an open-ended range.

approvedAtEndDate
string

Latest award time to include. The whole end day is included: the time part is replaced with 23:59:59 on that date in timezone. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

workCompletedAtStartDate
string

Earliest completion time of the proposal's work order to include, inclusive. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970. Send either end on its own for an open-ended range.

workCompletedAtEndDate
string

Latest completion time of the proposal's work order to include. The whole end day is included: the time part is replaced with 23:59:59 on that date in timezone. Format MM/dd/yyyy HH:mm:ss: a local wall-clock time read in timezone, or UTC when timezone is omitted. Don't include an offset in the value: it is ignored. A non-empty value that doesn't parse, such as an ISO 8601 value or a date without a time, is rejected with 400. An empty value is read as 1 January 1970.

timezone
string

Optional IANA time zone name, such as America/Chicago or UTC, that this route's date filters are read in. Each date filter value is a local wall-clock time in this zone. When omitted, date filters are read in UTC. Names are case-sensitive. Fixed offsets (-05:00, GMT-5, Z, Etc/GMT+5), abbreviations (CST), and unknown names are rejected with 400. On a daylight saving change day, a time in the skipped hour moves forward by the length of the gap, and a time in the repeated hour means the standard-time (second) occurrence.

Exemple:

"America/Chicago"

Réponse

Success.

type
string
requis

Entity type marker, e.g. "Proposal".

data
object[]
requis
count
integer
requis

Total number of matching records (not just this page).

status
enum<string>
requis
Options disponibles:
ok