GET /requisitions/{id}

Summary

Get requisition

URL Parameters

Name	Type	Required	Description
id	string	Yes	Requisition identifier

Query Parameters

Name	Type	Required	Description
includeStageTracking	boolean	No	Include worker recruitment stage tracking. Only returned when this is true and the company has stage tracking enabled in company config.

Request Example

cURL

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

JavaScript

const response = await fetch(
  "https://api.requidex.com/api/open/v1/requisitions/{id}",
  {
    method: "GET",
    headers: {
      Authorization: "Bearer <API_KEY>",
      Accept: "application/json",
    },
  },
);

const json = await response.json();

Python

import requests

response = requests.request(
    'GET',
    'https://api.requidex.com/api/open/v1/requisitions/{id}',
    headers={
        'Authorization': 'Bearer <API_KEY>',
        'Accept': 'application/json',
    },
    timeout=30,
)

print(response.json())

Go

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.requidex.com/api/open/v1/requisitions/{id}", 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
activity	object	Optional. Omitted when no activity is set. Show child attributes id string - Entity id name string - Entity name
agencies	array[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
approvedDate	string	Final approval timestamp when approved
approver	object	Show child attributes name string - User name email string - User email address
autoAssign	boolean	Whether auto-assignment is enabled for the requisition
company	object	Show child attributes id string - Entity id name string - Entity name
createdAt	string	Creation timestamp
endDate	string	Planned end date
id	string	Requisition id
project	object	Show child attributes id string - Entity id name string - Entity name
quantity	number	Requested worker quantity
reference	string	Requisition reference
region	object	Show child attributes id string - Entity id name string - Entity name
requestor	object	Show child attributes name string - User name email string - User email address
sector	object	Show child attributes id string - Entity id name string - Entity name
site	object	Show child attributes id string - Entity id name string - Entity name
stageTracking	array[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)
startDate	string	Planned start date
status	enum(raised, approved, filled, cancelled, rejected)	Derived requisition status
trade	object	Show child attributes id string - Entity id name string - Entity name
updatedAt	string	Last 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"
  }
}

Errors

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