Skip to main content
POST
Get the location id of a specific location

Authorizations

X-API-KEY
string
header
required

Your API key

Body

application/json
name
string
required

The name of the location to get the id of

Example:

"San Francisco"

source
enum<string>
default:live

Which location catalog to resolve against. live uses LinkedIn Sales Navigator (requires LinkedIn credentials); database uses the internal geo database; hiring uses the hiring-signal catalog. Defaults to live when omitted.

Available options:
live,
database,
hiring
Example:

"live"

Response

200 - application/json

Locations retrieved successfully. Each item always includes id and name; additional fields depend on the source.

id
string

The ID of the location, to be passed to search endpoints.

name
string

The name of the location. For source: live this is the full display name.

display_name
string

Full human-readable location name. Returned for source: hiring only.

country_code
string

ISO 3166-1 alpha-2 country code. Returned for source: hiring only.

type
string

Geo-zone kind (e.g. country, region, city). Returned for source: database only.

subtitle
string

Human-readable context such as parent regions and kind. Returned for source: database only.