GET /projects
Summary
List projects
URL Parameters
- None
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| page | integer | No | Page number (default 1) |
| limit | integer | No | Records per page (default 50, max 200) |
| status | enum(active, inactive) | No | Filter by project status |
| region | string | No | Filter by region id |
| sector | string | No | Filter by sector id |
| query | string | No | Case-insensitive search against project name and code |
| from | string | No | Created date filter start (YYYY-MM-DD) |
| to | string | No | Created date filter end (YYYY-MM-DD) |
| sortBy | enum(createdAt, updatedAt, name, code) | No | Sort field (default name) |
| sortOrder | enum(asc, desc) | No | Sort direction (default asc) |
Request Body Fields
No request body is accepted for this endpoint.
Request Example
- cURL
- JavaScript
- Python
- Go
curl -X GET 'https://api.requidex.com/api/open/v1/projects' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Accept: application/json'
const response = await fetch('https://api.requidex.com/api/open/v1/projects', {
method: 'GET',
headers: {
Authorization: 'Bearer <API_KEY>',
Accept: 'application/json',
},
});
const json = await response.json();
import requests
response = requests.request(
'GET',
'https://api.requidex.com/api/open/v1/projects',
headers={
'Authorization': 'Bearer <API_KEY>',
'Accept': 'application/json',
},
timeout=30,
)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.requidex.com/api/open/v1/projects", 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 |
|---|---|---|
| id | string | Project id |
| nanoid | string | Short project id |
| name | string | Project name |
| code | string | Project code |
| string | Project contact email | |
| phone | object | Show child attributes
|
| active | boolean | Whether project is active |
| singleSite | boolean | Whether project is single-site |
| siteCount | integer | Number of sites linked to project |
| company | object | Show child attributes
|
| region | object | Show child attributes
|
| sector | object | Show child attributes
|
| dates | object | Optional project date window Show child attributes
|
| createdAt | string | Creation timestamp |
| updatedAt | string | Last 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"
}
],
"meta": {
"page": 1,
"limit": 50,
"total": 1
}
}
Errors
| HTTP Status | Description |
|---|---|
| 401 | Missing, invalid, revoked, or expired API key |
| 403 | Forbidden due to scope or IP restrictions |
| 405 | Method not allowed on Open API routes |
| 429 | Rate limit exceeded |
| 500 | Unexpected internal error |