Region

GET /region/list

This API is to get all the list of available regions. This is an authendicated API so we need to pass bearer token in request header to access the data. This is the special API so it should be enabled for you by the service provider.

Headers

Authorization string Required
Accept string

Responses

200 application/json
Hide response attributes Show response attributes object
- status string
- data array[object]
  
  Hide data attributes Show data attributes object
  
  id integer
  
  name string
  
  code string
  
  description null
  
  total_candidates integer
  
  total_businessunits integer
- message string

GET /region/list

curl \
 -X GET https://api-console.logezy.co/v1/region/list \
 -H "Authorization: Bearer your-access-token" \
 -H "Accept: application/json"

Response examples (200)

{
  "data": [
    {
      "id": 1,
      "code": "REGDEM1",
      "name": "Glasgow",
      "description": null,
      "total_candidates": 281,
      "total_businessunits": 47
    }
  ],
  "status": "success",
  "message": "Region list retrieved successfully."
}

{
  "code": 400,
  "status": "error",
  "message": "Region is not enabled or you dont have access for region"
}