GET /sites

Summary

List sites

URL Parameters

• None

Query Parameters

Name	Type	Required	Description
company	string	No	Filter by company id. If omitted, data for all companies linked to the API key is returned.
page	integer	No	Page number (default 1)
limit	integer	No	Records per page (default 50, max 200)
status	enum(active, inactive)	No	Filter by site status
project	string	No	Filter by project id
query	string	No	Case-insensitive search against site name
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)	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

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

JavaScript

const response = await fetch("https://api.requidex.com/api/open/v1/sites", {
  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/sites',
    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/sites", 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	Site id
nanoid	string	Short site id
name	string	Site name
project	object	Show child attributes id string - Entity id name string - Entity name
company	object	Show child attributes id string - Entity id name string - Entity name
active	boolean	Whether site is active
email	string	Site contact email
phone	object	Show child attributes countryCode string - Country dialing code number string - Phone number
address	object	Site address details Show child attributes lineOne string - Address line one lineTwo string - Address line two city string - City region string - Region country string - Country code string - Postal code latitude number - Latitude longitude number - Longitude
createdAt	string	Creation timestamp
updatedAt	string	Last update timestamp

Response Example (200)

{
  "success": true,
  "data": [
    {
      "id": "67bc36db80a1616ec3f47055",
      "nanoid": "site12abcd",
      "name": "Manchester Central",
      "project": {
        "id": "67bc36db80a1616ec3f47011",
        "name": "Northern Rail Electrification"
      },
      "company": {
        "id": "67bc36db80a1616ec3f47001",
        "name": "Requidex Construction Ltd"
      },
      "active": true,
      "email": "site.manager@requidex.com",
      "phone": {
        "countryCode": "+44",
        "number": "1234567891"
      },
      "address": {
        "line1": "1 Station Approach",
        "city": "Manchester",
        "postcode": "M1 1AA"
      },
      "createdAt": "2025-02-01T09: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