Skip to main content

Get Location Details

NL EN

Updated June 15, 2026

GET /api/v1/locations/{slug}
curl -X GET \
  "https://app.recruitsome.com/api/v1/locations/{slug}" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"
const response = await fetch('https://app.recruitsome.com/api/v1/locations/{slug}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Accept': 'application/json',
  },
});

const data = await response.json();
console.log(data);
use Illuminate\Support\Facades\Http;

$response = Http::withToken('YOUR_API_KEY')
    ->acceptJson()
    ->get('https://app.recruitsome.com/api/v1/locations/{slug}');

$data = $response->json();

Retrieve complete information for a specific location by its slug — for example to render a single office page with address, map coordinates, and the number of vacancies tied to it.

Authentication

Requires an API key with the locations:read scope (included in the Career website preset). A key without this scope receives a 403 response.

Path parameters

ParameterTypeRequiredDescription
slugstringYesURL-friendly location identifier, exactly as returned by GET /locations

Query parameters

ParameterTypeDefaultDescription
languagestring-Set response locale for country names (exactly 2 characters)
include_coordinatesbooleanfalseInclude latitude/longitude
include_vacancy_countbooleanfalseInclude number of vacancies at this location

Response

Returns the same fields as the list endpoint for a single location. The coordinates and vacancy_count keys are absent from the response unless their include_* flag is passed — they are not included as null.

vacancy_count counts all vacancies linked to the location — including drafts, closed, and unpublished ones — not just the vacancies currently visible on GET /vacancies.

Example

cURL
curl -X GET "https://app.recruitsome.com/api/v1/locations/amsterdam-office-amsterdam-nl?include_coordinates=true&include_vacancy_count=true" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json"

Response 200

JSON
{
  "data": {
    "id": 1,
    "slug": "amsterdam-office-amsterdam-nl",
    "name": "Amsterdam Office",
    "address": {
      "address_line_1": "Keizersgracht 100",
      "address_line_2": null,
      "address_line_3": null,
      "locality": "Amsterdam",
      "administrative_area": "North Holland",
      "postal_code": "1015 AA",
      "country_code": "NL",
      "country_name": "Netherlands"
    },
    "coordinates": {
      "latitude": 52.3676,
      "longitude": 4.9041
    },
    "vacancy_count": 5
  }
}

Error responses

StatusWhenFix
401Missing or invalid API keySend a valid key as Authorization: Bearer YOUR_API_KEY
403API key lacks the locations:read scopeAdd the scope to your key or regenerate it with the Career website preset
404No location exists with this slug (deleted locations also return 404)Check the slug against GET /locations
422Invalid query parameter (e.g. language not exactly 2 characters)Correct the parameter per the table above