Skip to main content

GET /projects/{id}

Summary

Get project

URL Parameters

NameTypeRequiredDescription
idstringYesProject identifier

Query Parameters

  • None

Request Body Fields

No request body is accepted for this endpoint.

Request Example

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

Response Fields

FieldTypeDescription
idstringProject id
nanoidstringShort project id
namestringProject name
codestringProject code
emailstringProject contact email
phoneobject
Show child attributes
  • countryCode string - Country dialing code
  • number string - Phone number
activebooleanWhether project is active
singleSitebooleanWhether project is single-site
siteCountintegerNumber of sites linked to project
companyobject
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
datesobjectOptional project date window
Show child attributes
  • start string
  • end string
createdAtstringCreation timestamp
updatedAtstringLast update timestamp

Response Example (200)

{
"success": true,
"data": {
"id": "67bc36db80a1616ec3f4739e",
"nanoid": "abc123def4",
"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 StatusDescription
401Missing, invalid, revoked, or expired API key
403Forbidden due to scope or IP restrictions
404Project not found
405Method not allowed on Open API routes
429Rate limit exceeded
500Unexpected internal error