Skip to main content

GET /purchase-orders

Summary

List purchase orders

URL Parameters

  • None

Query Parameters

NameTypeRequiredDescription
companystringNoFilter by company id. If omitted, purchase orders for all linked companies are returned.
pageintegerNoPage number (default 1)
limitintegerNoRecords per page (default 50, max 200)
projectstringNoFilter by project id
sitestringNoFilter by site id
agencystringNoFilter by agency id
statusenum(active, inactive)NoFilter by purchase order status
querystringNoCase-insensitive search against purchase order reference
fromstringNoCreated date filter start (YYYY-MM-DD)
tostringNoCreated date filter end (YYYY-MM-DD)
sortByenum(createdAt, updatedAt, poRef, start, end, value)NoSort field (default createdAt)
sortOrderenum(asc, desc)NoSort direction (default desc)

Request Body Fields

No request body is accepted for this endpoint.

Request Example

curl -X GET 'https://api.requidex.com/api/open/v1/purchase-orders' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Accept: application/json'

Response Fields

FieldTypeDescription
idstringPurchase order id
statusstringPurchase order status
referencestringPurchase order reference
startDatestringPurchase order start date
endDatestringPurchase order end date
valuenumberPurchase order value
companyobject
Show child attributes
  • id string - Company id
  • name string - Company name
projectsarray[object]Project references with id and name
siteobject
Show child attributes
  • id string - Site id
  • name string - Site name
agencyobject
Show child attributes
  • id string - Agency id
  • name string - Agency name
tradesarray[object]Trade references with id and name
allTradesbooleanWhether the purchase order applies to all trades
tradeOptionstringTrade selection mode
tagobjectOnly included when a tag is set.
Show child attributes
  • id string - Tag id
  • name string - Tag name
revokedobjectOnly included when the purchase order has been revoked.
Show child attributes
  • user object - User reference with id and name
  • date string - Revocation timestamp
reinstatedobjectOnly included when the purchase order has been reinstated.
Show child attributes
  • user object - User reference with id and name
  • date string - Reinstatement timestamp
createdAtstringCreation timestamp
updatedAtstringLast update timestamp

Response Example (200)

{
"success": true,
"data": [
{
"id": "67bc36db80a1616ec3f48001",
"status": "active",
"reference": "PO-44321",
"startDate": "2026-01-01T00:00:00.000Z",
"endDate": "2026-06-30T23:59:59.999Z",
"value": 150000,
"company": {
"id": "67bc36db80a1616ec3f47001",
"name": "Requidex Construction Ltd"
},
"projects": [
{
"id": "67bc36db80a1616ec3f47011",
"name": "Project Alpha"
}
],
"site": {
"id": "67bc36db80a1616ec3f47055",
"name": "Manchester Central"
},
"agency": {
"id": "67bc36db80a1616ec3f47060",
"name": "Agency One"
},
"trades": [
{
"id": "67bc36db80a1616ec3f47031",
"name": "Electrician"
}
],
"allTrades": false,
"tradeOption": "specific",
"tag": {
"id": "67bc36db80a1616ec3f47099",
"name": "Rail"
},
"createdAt": "2026-01-10T12:00:00.000Z",
"updatedAt": "2026-02-20T14:03:12.111Z"
}
],
"meta": {
"page": 1,
"limit": 50,
"total": 1
}
}

Errors

HTTP StatusDescription
400Invalid filters or parameters
401Missing, invalid, revoked, or expired API key
403Forbidden due to scope or IP restrictions
404Company not found
405Method not allowed on Open API routes
429Rate limit exceeded
500Unexpected internal error