API Reference

Create a location

post
https://api.join.com/v3/locations

Creates a location. Provide the location name and its address — countryCode and city are required; street details and postalCode are optional. The postalCode is validated against the country. In countries that use an official establishment registration number (for example SIRET in France), you can set it with establishmentId. Set isDefault: true to make the new location the company default preselected for job creation — this unsets the previous default.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
length ≤ 255

Location name

address
object
required

Location address

string

Official establishment registration number (e.g. SIRET in France); only for countries that use one

boolean
Defaults to false

Whether this is the default location preselected for job ads

Headers
string

Selects the dated API version the request runs against, named after its release day as YYYY-MM-DD, e.g. 2026-11-01. Omit to use the current default version (2026-11-01). A value that is not a supported version is rejected with 400 unsupported_api_version.

Responses

Updated 2 days ago

Did this page help you?
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 2 days ago

Did this page help you?