GET /purchase-orders
Summary
List purchase orders
URL Parameters
- None
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| company | string | No | Filter by company id. If omitted, purchase orders for all linked companies are returned. |
| page | integer | No | Page number (default 1) |
| limit | integer | No | Records per page (default 50, max 200) |
| project | string | No | Filter by project id |
| site | string | No | Filter by site id |
| agency | string | No | Filter by agency id |
| status | enum(active, inactive) | No | Filter by purchase order status |
| query | string | No | Case-insensitive search against purchase order reference |
| from | string | No | Created date filter start (YYYY-MM-DD) |
| to | string | No | Created date filter end (YYYY-MM-DD) |
| sortBy | enum(createdAt, updatedAt, poRef, start, end, value) | No | Sort field (default createdAt) |
| sortOrder | enum(asc, desc) | No | Sort direction (default desc) |
Request Body Fields
No request body is accepted for this endpoint.
Request Example
- cURL
- JavaScript
- Python
- Go
curl -X GET 'https://api.requidex.com/api/open/v1/purchase-orders' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Accept: application/json'
const response = await fetch("https://api.requidex.com/api/open/v1/purchase-orders", {
method: "GET",
headers: {
Authorization: "Bearer <API_KEY>",
Accept: "application/json",
},
});
const json = await response.json();
import requests
response = requests.request(
'GET',
'https://api.requidex.com/api/open/v1/purchase-orders',
headers={
'Authorization': 'Bearer <API_KEY>',
'Accept': 'application/json',
},
timeout=30,
)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.requidex.com/api/open/v1/purchase-orders", nil)
req.Header.Set("Authorization", "Bearer <API_KEY>")
req.Header.Set("Accept", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
payload, _ := io.ReadAll(resp.Body)
fmt.Println(string(payload))
}
Response Fields
| Field | Type | Description |
|---|---|---|
| id | string | Purchase order id |
| status | string | Purchase order status |
| reference | string | Purchase order reference |
| startDate | string | Purchase order start date |
| endDate | string | Purchase order end date |
| value | number | Purchase order value |
| company | object | Show child attributes
|
| projects | array[object] | Project references with id and name |
| site | object | Show child attributes
|
| agency | object | Show child attributes
|
| trades | array[object] | Trade references with id and name |
| allTrades | boolean | Whether the purchase order applies to all trades |
| tradeOption | string | Trade selection mode |
| tag | object | Only included when a tag is set. Show child attributes
|
| revoked | object | Only included when the purchase order has been revoked. Show child attributes
|
| reinstated | object | Only included when the purchase order has been reinstated. Show child attributes
|
| createdAt | string | Creation timestamp |
| updatedAt | string | Last 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 Status | Description |
|---|---|
| 400 | Invalid filters or parameters |
| 401 | Missing, invalid, revoked, or expired API key |
| 403 | Forbidden due to scope or IP restrictions |
| 404 | Company not found |
| 405 | Method not allowed on Open API routes |
| 429 | Rate limit exceeded |
| 500 | Unexpected internal error |