v1

latestOpenAPI 3.0.02026-08-061280285.2 KB

Job APIs

Lists all job locations in the account.

get/api/external/location/list

Query parameters

include_countstring

Count of total records

open_jobs_onlystring

to fetch locations of open jobs only

Headers

RF-Api-Keystring

Response

Auto generated using Swagger Inspector

{"stackTrail":"paths:/api/external/location/list:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"city":null,"country":null,"details":null,"id":55,"iso_3166_1_alpha_2_code":null,"location_type":"Physical","location_type_id":1,"name":"Test loc 3","postal_code":"575 009","state":"Karnataka","zipcode":"575 009"},{"city":"Bangalore","country":"India","details":null,"id":56,"iso_3166_1_alpha_2_code":"IN","location_type":"Physical","location_type_id":1,"name":"Test loc 4","postal_code":"575 000","state":"Karnataka","zipcode":"575 000"},{"city":null,"country":null,"details":null,"id":30,"iso_3166_1_alpha_2_code":null,"location_type":"Physical","location_type_id":1,"name":"x","postal_code":"","state":"y","zipcode":""},{"city":null,"country":null,"details":null,"id":32,"iso_3166_1_alpha_2_code":null,"location_type":"Physical","location_type_id":1,"name":"y","postal_code":"98768","state":"Bangladesh","zipcode":"98768"}],"total_items":4}}

Example response

{
  "data": [
    {
      "city": null,
      "country": null,
      "details": null,
      "id": 55,
      "iso_3166_1_alpha_2_code": null,
      "location_type": "Physical",
      "location_type_id": 1,
      "name": "Test loc 3",
      "postal_code": "575 009",
      "state": "Karnataka",
      "zipcode": "575 009"
    },
    {
      "city": "Bangalore",
      "country": "India",
      "details": null,
      "id": 56,
      "iso_3166_1_alpha_2_code": "IN",
      "location_type": "Physical",
      "location_type_id": 1,
      "name": "Test loc 4",
      "postal_code": "575 000",
      "state": "Karnataka",
      "zipcode": "575 000"
    },
    {
      "city": null,
      "country": null,
      "details": null,
      "id": 30,
      "iso_3166_1_alpha_2_code": null,
      "location_type": "Physical",
      "location_type_id": 1,
      "name": "x",
      "postal_code": "",
      "state": "y",
      "zipcode": ""
    },
    {
      "city": null,
      "country": null,
      "details": null,
      "id": 32,
      "iso_3166_1_alpha_2_code": null,
      "location_type": "Physical",
      "location_type_id": 1,
      "name": "y",
      "postal_code": "98768",
      "state": "Bangladesh",
      "zipcode": "98768"
    }
  ],
  "total_items": 4
}