/v2/regions

Region taxonomy is used to standardize data across the LinkedIn platform. Use this API to retrieve standardized URNs and their names.

Supported Methods

GET | BATCH_GET | GET_ALL | FINDER countries | FINDER states | FINDER standardizedLocation

Region Schema

Field Name Description
country The country URN for this region.
id The region code.
$URN Standardized region URN
name Region name in various locales. Represented as LocaleString type.
states The state URNs for this region. Represents an array and defaults to an empty.

GET

GET https://api.linkedin.com/v2/regions/{id}?locale.language=en&locale.country=US

Parameters

Field Name Description
locale The locale the seniority data is requested in. "en_US" locale will be used if locale is not provided or not supported.
language A lowercase two-letter language code as defined by ISO-639 .
country An uppercase two-letter country code as defined by ISO-3166 .

Sample Response

{
    "$URN": "urn:li:region:84",
    "country": "urn:li:country:us",
    "id": 84,
    "name": {
        "locale": {
            "country": "US",
            "language": "en"
        },
        "value": "San Francisco Bay Area"
    },
    "states": [
        "urn:li:state:(urn:li:country:us,CA)"
    ]
}

BATCH GET

GET https://api.linkedin.com/v2/regions?ids={id1}&ids={id2}&ids={ids3}

Parameters

Field Name Description
locale The locale the seniority data is requested in. "en_US" locale will be used if locale is not provided or not supported.
language A lowercase two-letter language code as defined by ISO-639 .
country An uppercase two-letter country code as defined by ISO-3166 .

Sample Response

{
    "errors": {},
    "results": {
        "82": {
            "$URN": "urn:li:region:82",
            "country": "urn:li:country:us",
            "id": 82,
            "name": {
                "locale": {
                    "country": "US",
                    "language": "en"
                },
                "value": "Sacramento, California Area"
            },
            "states": [
                "urn:li:state:(urn:li:country:us,CA)",
                "urn:li:state:(urn:li:country:us,NV)"
            ]
        },
        "84": {
            "$URN": "urn:li:region:84",
            "country": "urn:li:country:us",
            "id": 84,
            "name": {
                "locale": {
                    "country": "US",
                    "language": "en"
                },
                "value": "San Francisco Bay Area"
            },
            "states": [
                "urn:li:state:(urn:li:country:us,CA)"
            ]
        }
    },
    "statuses": {}
}

GET ALL

GET https://api.linkedin.com/v2/regions

Parameters

Field Name Description
locale The locale the seniority data is requested in. "en_US" locale will be used if locale is not provided or not supported.
language A lowercase two-letter language code as defined by ISO-639 .
country An uppercase two-letter country code as defined by ISO-3166 .

Sample Response

{
  "elements": [
    {
      "name": {
        "locale": {
          "country": "US",
          "language": "en"
        },
        "value": "Sacramento, California Area"
      },
      "country": "urn:li:country:us",
      "id": 82,
      "$URN": "urn:li:region:82",
      "states": [
        "urn:li:state:(urn:li:country:us,CA)",
        "urn:li:state:(urn:li:country:us,NV)"
      ]
    },
    {
      "name": {
        "locale": {
          "country": "US",
          "language": "en"
        },
        "value": "San Francisco Bay Area"
      },
      "country": "urn:li:country:us",
      "id": 84,
      "$URN": "urn:li:region:84",
      "states": [
        "urn:li:state:(urn:li:country:us,CA)"
      ]
    },
    ...
  ],
  "paging": {
    "count": 10,
    "start": 0
  }
}

FINDER countries

GET https://api.linkedin.com/v2/regions?q=countries&countries={countryURN1}&countries={countryURN2}&countries={countryURN3}

Parameters

Field Name Sub-Field Name Description
countries The country URNs.
locale The locale the seniority data is requested in. "en_US" locale will be used if locale is not provided or not supported.
language A lowercase two-letter language code as defined by ISO-639 .
country An uppercase two-letter country code as defined by ISO-3166 .

Sample Response of urn:li:country:us and urn:li:country:ca

{
  "elements": [
    {
      "name": {
        "locale": {
          "country": "US",
          "language": "en"
        },
        "value": "Toronto, Canada Area"
      },
      "country": "urn:li:country:ca",
      "id": 4876,
      "$URN": "urn:li:region:4876",
      "states": [
        "urn:li:state:(urn:li:country:ca,ON)"
      ]
    },
    {
      "name": {
        "locale": {
          "country": "US",
          "language": "en"
        },
        "value": "Sacramento, California Area"
      },
      "country": "urn:li:country:us",
      "id": 82,
      "$URN": "urn:li:region:82",
      "states": [
        "urn:li:state:(urn:li:country:us,CA)",
        "urn:li:state:(urn:li:country:us,NV)"
      ]
    },
    {
      "name": {
        "locale": {
          "country": "US",
          "language": "en"
        },
        "value": "San Francisco Bay Area"
      },
      "country": "urn:li:country:us",
      "id": 84,
      "$URN": "urn:li:region:84",
      "states": [
        "urn:li:state:(urn:li:country:us,CA)"
      ]
    },
    ...
  ],
  "paging": {
    "count": 10,
    "start": 0
  }
}

FINDER states

GET https://api.linkedin.com/v2/regions?q=states&states={stateURN1}&states={stateURN2}&states={stateURN3}

Parameters

Field Name Sub-Field Name Description
states The state URNs.
locale The locale the seniority data is requested in. "en_US" locale will be used if locale is not provided or not supported.
language A lowercase two-letter language code as defined by ISO-639 .
country An uppercase two-letter country code as defined by ISO-3166 .

Sample Response of urn:li:state(urn:li:country:us,CA) and urn:li:state(urn:li:country:us,NY)

{
  "elements": [
    {
      "name": {
        "locale": {
          "country": "US",
          "language": "en"
        },
        "value": "Greater New York City Area"
      },
      "country": "urn:li:country:us",
      "id": 70,
      "$URN": "urn:li:region:70",
      "states": [
        "urn:li:state:(urn:li:country:us,NY)"
      ]
    },
    {
      "name": {
        "locale": {
          "country": "US",
          "language": "en"
        },
        "value": "Sacramento, California Area"
      },
      "country": "urn:li:country:us",
      "id": 82,
      "$URN": "urn:li:region:82",
      "states": [
        "urn:li:state:(urn:li:country:us,CA)",
        "urn:li:state:(urn:li:country:us,NV)"
      ]
    },
    {
      "name": {
        "locale": {
          "country": "US",
          "language": "en"
        },
        "value": "San Francisco Bay Area"
      },
      "country": "urn:li:country:us",
      "id": 84,
      "$URN": "urn:li:region:84",
      "states": [
        "urn:li:state:(urn:li:country:us,CA)"
      ]
    },
    ...
  ],
  "paging": {
    "count": 10,
    "start": 0
  }
}

FINDER standardizedLocation

GET https://api.linkedin.com/v2/regions?q=standardizedLocation&standardizedLocation={standardizedLocationURN}

Parameters

Field Name Sub-Field Name Description
standardizedLocation The standardized location URN.
locale The locale the seniority data is requested in. "en_US" locale will be used if locale is not provided or not supported.
language A lowercase two-letter language code as defined by ISO-639 .
country An uppercase two-letter country code as defined by ISO-3166 .

Sample Response

{
    "elements": [
        {
            "$URN": "urn:li:region:14",
            "country": "urn:li:country:us",
            "id": 14,
            "name": {
                "locale": {
                    "country": "US",
                    "language": "en"
                },
                "value": "Greater Chicago Area"
            },
            "states": [
                "urn:li:state:(urn:li:country:us,IL)",
                "urn:li:state:(urn:li:country:us,IN)",
                "urn:li:state:(urn:li:country:us,WI)"
            ]
        }
    ],
    "paging": {
        "count": 10,
        "start": 0
    }
}