Skip to main content

GET /requisitions

Summary

List requisitions

URL Parameters

  • None

Query Parameters

NameTypeRequiredDescription
companystringNoFilter by company id(s). Pass a single id or comma-separated ids. If omitted, data for all companies linked to the API key is returned.
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
includeStageTrackingbooleanNoInclude worker recruitment stage tracking. Only returned when this is true and the company has stage tracking enabled in company config.
querystringNoCase-insensitive search against requisition reference
dateFieldenum(createdAt, approvedDate, startDate, endDate, dateAccepted)NoDate field that from/to apply to. dateAccepted filters agency accepted dates. Default: createdAt.
fromstringNoDate filter start (YYYY-MM-DD); applies to dateField
tostringNoDate filter end (YYYY-MM-DD); applies to dateField
sortByenum(createdAt, updatedAt, reqRef, approvedDate)NoSort field
sortOrderenum(asc, desc)NoSort direction
fieldsstringNoComma-separated list of response fields or dot-path nested fields to return

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
activityobjectOptional. Omitted when no activity is set.
Show child attributes
  • id string - Entity id
  • name string - Entity name
agenciesarray[object]
Show child attributes
  • id string - Agency id
  • name string - Agency name
  • offered integer - Number of workers offered by this agency
  • assigned integer - Number of non-cancelled workers assigned to this agency
  • dateReceived string - Timestamp when this agency received the requisition
  • dateAccepted string - Timestamp when this agency accepted the requisition
approvedDatestringFinal approval timestamp when approved
approverobject
Show child attributes
  • name string - User name
  • email string - User email address
autoAssignbooleanWhether auto-assignment is enabled for the requisition
companyobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
createdAtstringCreation timestamp
endDatestringPlanned end date
idstringRequisition id
projectobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
quantitynumberRequested worker quantity
referencestringRequisition reference
regionobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
requestorobject
Show child attributes
  • name string - User name
  • email string - User email address
sectorobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
siteobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
stageTrackingarray[object]Optional. Returned only when includeStageTracking=true and the company has stage tracking enabled in company config. Agency-scoped keys only receive records for their scoped agency.
Show child attributes
  • worker object - Worker id and name
  • agency object - Agency id and name
  • submittedAt string - Worker submission timestamp
  • isRejected boolean - Whether the submitted worker was rejected
  • stage enum - Current stage (submitted, cvReviewed, interviewed, offerMade, offerAccepted, offerRejected, assigned)
  • stageLabel string - Human-readable current stage
  • history array[object] - Stage history entries (stage, stageLabel, at, byUserId, byName, comments)
startDatestringPlanned start date
statusenum(raised, approved, filled, cancelled, rejected)Derived requisition status
tradeobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
updatedAtstringLast update timestamp

Response Example (200)

{
"success": true,
"data": [
{
"id": "67bc36db80a1616ec3f48123",
"reference": "REQ-R1002",
"status": "raised",
"quantity": 4,
"autoAssign": true,
"requestor": {
"name": "Riley Requestor",
"email": "riley.requestor@example.com"
},
"approver": {
"name": "Avery Approver",
"email": "avery.approver@example.com"
},
"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"
},
"agencies": [
{
"id": "67bc36db80a1616ec3f47101",
"name": "Northline Labour Desk",
"offered": 1,
"assigned": 1,
"dateReceived": "2026-02-21T09:00:00.000Z",
"dateAccepted": "2026-02-21T10:00:00.000Z"
},
{
"id": "67bc36db80a1616ec3f47102",
"name": "Summit Trades",
"offered": 2,
"assigned": 1,
"dateReceived": "2026-02-22T09:00:00.000Z",
"dateAccepted": "2026-02-22T10:00:00.000Z"
}
],
"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",
"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