Skip to main content

GET /regions

Summary

List regions

URL Parameters

  • None

Query Parameters

NameTypeRequiredDescription
companystringNoFilter by company id. If omitted, regions for all linked companies are returned.
pageintegerNoPage number (default 1)
limitintegerNoRecords per page (default 50, max 200)
sortByenum(createdAt, updatedAt, name)NoSort field (default name)
sortOrderenum(asc, desc)NoSort direction (default asc)

Request Body Fields

No request body is accepted for this endpoint.

Request Example

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

Response Fields

FieldTypeDescription
idstringRegion id
namestringRegion name
companyobject
Show child attributes
  • id string
  • name string
createdAtstringCreation timestamp
updatedAtstringLast update timestamp

Response Example (200)

{
"success": true,
"data": [
{
"id": "67bc36db80a1616ec3f47010",
"name": "South East",
"company": { "id": "67bc36db80a1616ec3f47001", "name": "Requidex Construction Ltd" },
"createdAt": "2025-01-10T12:00:00.000Z",
"updatedAt": "2026-02-20T14:03:12.111Z"
}
],
"meta": {
"page": 1,
"limit": 50,
"total": 5
}
}

Errors

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