Updated April 22, 2026
/api/v1/locations
curl -X GET \
"https://app.recruitsome.com/api/v1/locations" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"const response = await fetch('https://app.recruitsome.com/api/v1/locations', {
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');
$data = $response->json();List Locations
Retrieve a paginated list of your office locations with filtering and sorting options.
Endpoint
GET /api/v1/locations
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
page | integer | 1 | Page number for pagination |
per_page | integer | 20 | Items per page (max: 100) |
language | string | - | Set response locale for country names (2 characters) |
country_code | string | - | Filter by country code (2 characters, e.g. NL) |
search | string | - | Search in name, city, and address |
sort | string | name | Sort field: name, locality, created_at |
sort_direction | string | asc | Sort direction: asc or desc |
include_coordinates | boolean | false | Include latitude/longitude |
include_vacancy_count | boolean | false | Include number of vacancies at each location |
Response Fields
| Field | Type | Description | |
|---|---|---|---|
id | integer | Unique location ID | |
slug | string | URL-friendly identifier | |
name | string | Location name | |
address | object | Full address details | |
coordinates | object\ | null | Latitude/longitude (only when include_coordinates=true) |
vacancy_count | integer | Number of vacancies (only when include_vacancy_count=true) |
Address Object
{
"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 Object
{
"latitude": 52.3676,
"longitude": 4.9041
}
Example Request
curl -X GET "https://app.recruitsome.com/api/v1/locations?country_code=NL&include_coordinates=true" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/json"
Example Response
{
"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
}
}
],
"links": {
"first": "...?page=1",
"last": "...?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"per_page": 20,
"to": 1,
"total": 1
}
}
Notes
- Soft-deleted locations are automatically excluded
- Country names are localized based on the
languageparameter - The
searchparameter performs case-insensitive matching across name, city, and street address