GET /projects/{id}

Caller

Company

Company-scoped API keys can optionally include the project config object in the response.

Agency

Agency-scoped API keys can retrieve connected projects. The config object is never returned for agency-scoped callers.

Summary

Get project

URL Parameters

Name	Type	Required	Description
id	string	Yes	Project identifier

Query Parameters

Company

Name	Type	Required	Description
includeConfig	boolean	No	Include the project config object in the response

Agency

Name	Type	Required	Description
includeConfig	boolean	No	Ignored for agency-scoped callers; config is hidden

Request Example

Company

cURL

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

JavaScript

const response = await fetch("https://api.requidex.com/api/open/v1/projects/{id}?includeConfig=true", {
  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/projects/{id}?includeConfig=true',
    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/projects/{id}?includeConfig=true", 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))
}

Agency

cURL

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

JavaScript

const response = await fetch("https://api.requidex.com/api/open/v1/projects/{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/projects/{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/projects/{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
active	boolean	Whether project is active
code	string	Project code
company	object	Show child attributes id string - Entity id name string - Entity name
config	object	Project config object. Only returned for company-scoped callers when includeConfig=true. Show child attributes inheritCompanyFinance boolean - Whether the project uses company finance details for billing name, VAT number, company registration number, UTR, and CIS status inheritCompanyBilling boolean - Whether the project uses the company billing address autoAssign boolean - Whether auto-assignment is enabled useUplifts boolean - Whether project uplift rules override company uplift rules rateUplifts array - Uplift rules Show child attributes description string - Uplift label type string - Uplift type key uplift number - Uplift percentage timesheetAdjustment object - Timesheet adjustment permissions Show child attributes project boolean supplier boolean enhancedUplifts object - Enhanced uplift settings Show child attributes enabled boolean mode string weekly object - Weekly uplift threshold settings Show child attributes threshold number - Weekly hours threshold enforce boolean - Whether the threshold must be worked before uplifts apply reduce boolean - Whether authorised absences reduce the threshold nightThreshold number - Weekly night-shift hours threshold nightEnforce boolean - Whether the night-shift threshold must be worked before night-shift uplifts apply backshiftThreshold number - Weekly backshift hours threshold backshiftEnforce boolean - Whether the backshift threshold must be worked before backshift uplifts apply blockThresholds object - Optional weekly threshold overrides keyed by uplift block index, with numeric hour values nightBlockThresholds object - Optional night-shift threshold overrides keyed by uplift block index, with numeric hour values backshiftBlockThresholds object - Optional backshift threshold overrides keyed by uplift block index, with numeric hour values days object - Day-by-day uplift configuration Show child attributes mon object - Monday uplift settings Show child attributes enabled boolean dayShift object - Day shift settings Show child attributes startTime number breakAssumption number blocks array - Uplift blocks Show child attributes startHour number endHour number upliftPercentage number nightShift object - Night shift settings Show child attributes startTime number breakAssumption number blocks array - Uplift blocks Show child attributes startHour number endHour number upliftPercentage number backShift object - Backshift settings Show child attributes startTime number breakAssumption number blocks array - Uplift blocks Show child attributes startHour number endHour number upliftPercentage number tue object - Tuesday uplift settings. Same child attributes as mon. wed object - Wednesday uplift settings. Same child attributes as mon. thu object - Thursday uplift settings. Same child attributes as mon. fri object - Friday uplift settings. Same child attributes as mon. sat object - Saturday uplift settings. Same child attributes as mon. sun object - Sunday uplift settings. Same child attributes as mon. bankHol object - Bank holiday uplift settings. Same child attributes as mon. workingRuleAgreement object - Working rule agreement settings Show child attributes enabled boolean accommodation object with enabled, dailyAmount, absence flags, preferredLabel, showInTotalsSeparately, and nested lodge settings
createdAt	string	Creation timestamp
dates	object	Optional project date window Show child attributes start string end string
email	string	Project contact email
id	string	Project id
name	string	Project name
phone	object	Show child attributes countryCode string - Country dialing code number string - Phone number
region	object	Show child attributes id string - Entity id name string - Entity name
sector	object	Show child attributes id string - Entity id name string - Entity name
singleSite	boolean	Whether project is single-site
siteCount	integer	Number of sites linked to project
updatedAt	string	Last update timestamp

Response Example (200)

{
  "success": true,
  "data": {
    "id": "67bc36db80a1616ec3f4739e",
    "name": "Northern Rail Electrification",
    "code": "NRE-001",
    "email": "pm@requidex.com",
    "phone": {
      "countryCode": "+44",
      "number": "1234567890"
    },
    "active": true,
    "singleSite": false,
    "siteCount": 3,
    "company": {
      "id": "67bc36db80a1616ec3f47001",
      "name": "Requidex Construction Ltd"
    },
    "region": {
      "id": "67bc36db80a1616ec3f47002",
      "name": "North West"
    },
    "sector": {
      "id": "67bc36db80a1616ec3f47003",
      "name": "Rail"
    },
    "dates": {
      "start": "2025-01-15T00:00:00.000Z",
      "end": "2026-12-31T23:59:59.999Z"
    },
    "createdAt": "2025-01-10T12:00:00.000Z",
    "updatedAt": "2026-02-20T14:03:12.111Z"
  }
}

Errors

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