API Reference

List locations

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

Returns your company's locations as a paginated list, sorted by creation date (oldest first). Filter by country with countryCode (ISO 3166-1 alpha-2) or by city name with city (partial match). Use limit and cursor to page through results; the response's nextCursor is null on the last page.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
1 to 50
Defaults to 10

Number of records to return

string

Position from the previous response's nextCursor. Omit on the first request

string
^[A-Za-z]{2}$

Filter by country code

string
length ≤ 100

Filter by city name (partial match)

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?