--- updatedAt: 2025-06-09T23:12:27.000Z --- Fetch the complete documentation index at: https://docs.recruitee.com/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version. # /locations # Selected fields in /locations response | Field name | Description | | :-------------------------- | :-------------------------------------------------------------------------------------------------- | | id | Unique location ID - used in job offers to refer to a correct location | | name | Location name | | country\_code | Shortened country code expressed in ISO 3166 (link) | | state\_name | Hard coded value, depending on the country, translated within the "full\_address" translation field | | state\_code | Hard coded value, shortened state code | | city | Manually populated value for city, not automatically translated (required) | | street | Manually populated value for street, not automatically translated (optional) | | postal\_code | Manually populated value for postal code, not automatically translated (optional) | | full\_address | One line address with the following scheme: country, state, city, postal code, street | | created\_at | Date when the location was first created | | updated\_at | Date when the location was last edited | | archived\_at | Date when the location was archived | | lang\_code | Default language code of the location | | active\_offers\_count | Number of offers the location is assigned to | | active\_requisitions\_count | Number of requisitions the offer is assigned to | | is\_deletable | Location with value "false" cannot be deleted unless it is unassigned from all offers | | translations | Array of objects containing translation fields and values, one object for every language | # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "ats-api", "version": "1.0" }, "servers": [ { "url": "https://api.recruitee.com" } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "/c/{company_id}/locations": { "get": { "summary": "/locations", "description": "", "operationId": "locations", "parameters": [ { "name": "company_id", "in": "path", "description": "Company ID. Company subdomain can also be used.", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "description": "Limits the number of results.", "schema": { "type": "integer", "format": "int32", "default": 60 } }, { "name": "page", "in": "query", "description": "Page number.", "schema": { "type": "integer", "format": "int32", "default": 1 } }, { "name": "query", "in": "query", "description": "Allows searching through an entered term.", "schema": { "type": "string" } }, { "name": "scope", "in": "query", "description": "`active` contains only active locations; `archived` contains only archived locations; `all` contains all locations", "schema": { "type": "string", "default": "all" } }, { "name": "view_mode", "in": "query", "description": "`brief` contains location information without translations; `full` contains all the information along with translations and active offer counters", "schema": { "type": "string", "default": "brief" } } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "OK - no translations": { "value": "{\n \"meta\": {\n \"limit\": 1000,\n \"page\": 1,\n \"total_count\": 2\n },\n \"locations\": [\n {\n \"id\": 214600,\n \"name\": \"Location 2\",\n \"is_valid\": true,\n \"state_name\": \"Mazowieckie\",\n \"updated_at\": \"2024-07-17T07:07:05.126408Z\",\n \"city\": \"Warsaw\",\n \"note\": \"Location note 2\",\n \"country_code\": \"PL\",\n \"created_at\": \"2024-07-17T07:07:05.122231Z\",\n \"archived_at\": null,\n \"lang_code\": \"en\",\n \"postal_code\": \"00-497\",\n \"state_code\": \"14\",\n \"street\": \"Nowy Świat\",\n \"full_address\": \"Poland, Mazowieckie, Warsaw, 00-497, Nowy Świat\"\n },\n {\n \"id\": 214599,\n \"name\": \"Location 1\",\n \"is_valid\": true,\n \"state_name\": \"Noord-Holland\",\n \"updated_at\": \"2024-07-17T07:06:25.805513Z\",\n \"city\": \"Amsterdam\",\n \"note\": \"Location note\",\n \"country_code\": \"NL\",\n \"created_at\": \"2024-07-17T07:06:25.801045Z\",\n \"archived_at\": null,\n \"lang_code\": \"en\",\n \"postal_code\": \"1012\",\n \"state_code\": \"NH\",\n \"street\": \"Raadhuisstraat\",\n \"full_address\": \"Netherlands, Noord-Holland, Amsterdam, 1012, Raadhuisstraat\"\n }\n ]\n}" }, "OK - with translations": { "value": "{\n \"meta\": {\n \"limit\": 1000,\n \"page\": 1,\n \"total_count\": 2\n },\n \"locations\": [\n {\n \"id\": 214600,\n \"name\": \"Location 2\",\n \"is_valid\": true,\n \"state_name\": \"Mazowieckie\",\n \"updated_at\": \"2024-07-18T07:25:33.668705Z\",\n \"city\": \"Warsaw\",\n \"translations\": [\n {\n \"default\": true,\n \"name\": \"Location 2\",\n \"city\": \"Warsaw\",\n \"note\": \"Locatione note 2\",\n \"total_count\": 5,\n \"lang_code\": \"en\",\n \"postal_code\": \"00-497\",\n \"street\": \"Nowy Świat\",\n \"full_address\": \"Poland, Mazowieckie, Warsaw, 00-497, Nowy Świat\",\n \"filled_count\": 5\n },\n {\n \"default\": false,\n \"name\": \"Standorte 2\",\n \"city\": \"Warschau\",\n \"note\": \"Standortnotiz 2\",\n \"total_count\": 5,\n \"lang_code\": \"de\",\n \"postal_code\": \"00-497\",\n \"street\": \"Nowy Świat\",\n \"full_address\": \"Polen, Masowien, Warschau, 00-497, Nowy Świat\",\n \"filled_count\": 5\n }\n ],\n \"note\": \"Locatione note 2\",\n \"country_code\": \"PL\",\n \"created_at\": \"2024-07-18T07:07:05.122231Z\",\n \"archived_at\": null,\n \"lang_code\": \"en\",\n \"postal_code\": \"00-497\",\n \"state_code\": \"14\",\n \"street\": \"Nowy Świat\",\n \"full_address\": \"Poland, Mazowieckie, Warsaw, 00-497, Nowy Świat\",\n \"active_offers_count\": 2,\n \"active_requisitions_count\": 0,\n \"is_deletable\": false\n },\n {\n \"id\": 214599,\n \"name\": \"Location 1\",\n \"is_valid\": true,\n \"state_name\": \"Noord-Holland\",\n \"updated_at\": \"2024-07-18T07:26:01.083957Z\",\n \"city\": \"Amsterdam\",\n \"translations\": [\n {\n \"default\": true,\n \"name\": \"Location 1\",\n \"city\": \"Amsterdam\",\n \"note\": \"Location note\",\n \"total_count\": 5,\n \"lang_code\": \"en\",\n \"postal_code\": \"1012\",\n \"street\": \"Raadhuisstraat\",\n \"full_address\": \"Netherlands, Noord-Holland, Amsterdam, 1012, Raadhuisstraat\",\n \"filled_count\": 5\n },\n {\n \"default\": false,\n \"name\": \"Standorte 1\",\n \"city\": \"Amsterdam\",\n \"note\": \"Standortnotiz 1\",\n \"total_count\": 5,\n \"lang_code\": \"de\",\n \"postal_code\": \"1012\",\n \"street\": \"Raadhuisstraat\",\n \"full_address\": \"Niederlande, Nordholland, Amsterdam, 1012, Raadhuisstraat\",\n \"filled_count\": 5\n }\n ],\n \"note\": \"Location note\",\n \"country_code\": \"NL\",\n \"created_at\": \"2024-07-18T07:06:25.801045Z\",\n \"archived_at\": null,\n \"lang_code\": \"en\",\n \"postal_code\": \"1012\",\n \"state_code\": \"NH\",\n \"street\": \"Raadhuisstraat\",\n \"full_address\": \"Netherlands, Noord-Holland, Amsterdam, 1012, Raadhuisstraat\",\n \"active_offers_count\": 2,\n \"active_requisitions_count\": 0,\n \"is_deletable\": false\n }\n ]\n}" } }, "schema": { "oneOf": [ { "title": "OK - no translations", "type": "object", "properties": { "meta": { "type": "object", "properties": { "limit": { "type": "integer", "example": 1000, "default": 0 }, "page": { "type": "integer", "example": 1, "default": 0 }, "total_count": { "type": "integer", "example": 2, "default": 0 } } }, "locations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 214600, "default": 0 }, "name": { "type": "string", "example": "Location 2" }, "is_valid": { "type": "boolean", "example": true, "default": true }, "state_name": { "type": "string", "example": "Mazowieckie" }, "updated_at": { "type": "string", "example": "2024-07-17T07:07:05.126408Z" }, "city": { "type": "string", "example": "Warsaw" }, "note": { "type": "string", "example": "Location note 2" }, "country_code": { "type": "string", "example": "PL" }, "created_at": { "type": "string", "example": "2024-07-17T07:07:05.122231Z" }, "archived_at": {}, "lang_code": { "type": "string", "example": "en" }, "postal_code": { "type": "string", "example": "00-497" }, "state_code": { "type": "string", "example": "14" }, "street": { "type": "string", "example": "Nowy Świat" }, "full_address": { "type": "string", "example": "Poland, Mazowieckie, Warsaw, 00-497, Nowy Świat" } } } } } }, { "title": "OK - with translations", "type": "object", "properties": { "meta": { "type": "object", "properties": { "limit": { "type": "integer", "example": 1000, "default": 0 }, "page": { "type": "integer", "example": 1, "default": 0 }, "total_count": { "type": "integer", "example": 2, "default": 0 } } }, "locations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 214600, "default": 0 }, "name": { "type": "string", "example": "Location 2" }, "is_valid": { "type": "boolean", "example": true, "default": true }, "state_name": { "type": "string", "example": "Mazowieckie" }, "updated_at": { "type": "string", "example": "2024-07-18T07:25:33.668705Z" }, "city": { "type": "string", "example": "Warsaw" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "default": { "type": "boolean", "example": true, "default": true }, "name": { "type": "string", "example": "Location 2" }, "city": { "type": "string", "example": "Warsaw" }, "note": { "type": "string", "example": "Locatione note 2" }, "total_count": { "type": "integer", "example": 5, "default": 0 }, "lang_code": { "type": "string", "example": "en" }, "postal_code": { "type": "string", "example": "00-497" }, "street": { "type": "string", "example": "Nowy Świat" }, "full_address": { "type": "string", "example": "Poland, Mazowieckie, Warsaw, 00-497, Nowy Świat" }, "filled_count": { "type": "integer", "example": 5, "default": 0 } } } }, "note": { "type": "string", "example": "Locatione note 2" }, "country_code": { "type": "string", "example": "PL" }, "created_at": { "type": "string", "example": "2024-07-18T07:07:05.122231Z" }, "archived_at": {}, "lang_code": { "type": "string", "example": "en" }, "postal_code": { "type": "string", "example": "00-497" }, "state_code": { "type": "string", "example": "14" }, "street": { "type": "string", "example": "Nowy Świat" }, "full_address": { "type": "string", "example": "Poland, Mazowieckie, Warsaw, 00-497, Nowy Świat" }, "active_offers_count": { "type": "integer", "example": 2, "default": 0 }, "active_requisitions_count": { "type": "integer", "example": 0, "default": 0 }, "is_deletable": { "type": "boolean", "example": false, "default": true } } } } } } ] } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```