Skip to main content

GET /sites/{id}

Summary

Get site

URL Parameters

NameTypeRequiredDescription
idstringYesSite 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/sites/{id}' \
-H 'Authorization: Bearer <API_KEY>' \
-H 'Accept: application/json'

Response Fields

FieldTypeDescription
idstringSite id
nanoidstringShort site id
namestringSite name
projectobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
companyobject
Show child attributes
  • id string - Entity id
  • name string - Entity name
activebooleanWhether site is active
emailstringSite contact email
phoneobject
Show child attributes
  • countryCode string - Country dialing code
  • number string - Phone number
addressobjectSite 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
  • coordsOverriden boolean - Whether coordinates were manually overridden
createdAtstringCreation timestamp
updatedAtstringLast 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"
}
}

Errors

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