Skip to main content

GET /purchase-orders/{id}

Agency-scoped keys

This endpoint is not available for agency-scoped API keys.

Summary

Get purchase order

URL Parameters

NameTypeRequiredDescription
idstringYesPurchase order identifier

Query Parameters

  • None

Request Example

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

Response Fields

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

Response Example (200)

{
"success": true,
"data": {
"id": "67bc36db80a1616ec3f48001",
"status": "inactive",
"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"
},
"revoked": {
"user": {
"id": "67bc36db80a1616ec3f49998",
"name": "Alex Carter"
},
"date": "2026-02-01T10:00:00.000Z"
},
"createdAt": "2026-01-10T12:00:00.000Z",
"updatedAt": "2026-02-20T14:03:12.111Z"
}
}

Errors

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