Skip to main content

GET /requisitions

Summary

List requisitions

URL Parameters

  • None

Query Parameters

NameTypeRequiredDescription
pageintegerNoPage number (default 1)
limitintegerNoRecords per page (default 50, max 200)
statusenum(raised, approved, filled, cancelled, rejected)NoFilter by derived requisition status
projectstringNoFilter by project id
sitestringNoFilter by site id
costCodestringNoFilter by cost code id
tradestringNoFilter by trade id
agencystringNoFilter by agency id
querystringNoCase-insensitive search against requisition reference
fromstringNoCreated date filter start (YYYY-MM-DD)
tostringNoCreated date filter end (YYYY-MM-DD)
sortByenum(createdAt, updatedAt, reqRef, approvedDate)NoSort field
sortOrderenum(asc, desc)NoSort direction

Request Body Fields

No request body is accepted for this endpoint.

Request Example

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

Response Fields

FieldTypeDescription
idstringRequisition id
nanoidstringShort requisition id
referencestringRequisition reference
statusenum(raised, approved, filled, cancelled, rejected)Derived requisition status
quantitynumberRequested worker quantity
companyobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
projectobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
regionobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
sectorobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
siteobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
tradeobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
activityobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
startDatestringPlanned start date
endDatestringPlanned end date
approvedDatestringFinal approval timestamp
createdAtstringCreation timestamp
updatedAtstringLast update timestamp

Response Example (200)

{
"success": true,
"data": [
{
"id": "67bc36db80a1616ec3f48123",
"nanoid": "req01abcde",
"reference": "REQ-R1002",
"status": "raised",
"quantity": 4,
"company": {
"id": "67bc36db80a1616ec3f47001",
"name": "Requidex Construction Ltd"
},
"project": {
"id": "67bc36db80a1616ec3f47011",
"name": "Northern Rail Electrification"
},
"region": {
"id": "67bc36db80a1616ec3f47002",
"name": "North West"
},
"sector": {
"id": "67bc36db80a1616ec3f47003",
"name": "Rail"
},
"site": {
"id": "67bc36db80a1616ec3f47055",
"name": "Manchester Central"
},
"trade": {
"id": "67bc36db80a1616ec3f47077",
"name": "Electrician"
},
"activity": {
"id": "67bc36db80a1616ec3f47099",
"name": "Install containment"
},
"startDate": "2026-03-01T00:00:00.000Z",
"endDate": "2026-03-31T23:59:59.999Z",
"approvedDate": null,
"createdAt": "2026-02-20T11:10:00.000Z",
"updatedAt": "2026-02-20T11:10:00.000Z"
}
],
"meta": {
"page": 1,
"limit": 50,
"total": 1
}
}

Errors

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