API Reference

List locations

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

Returns your company’s locations, ordered by creation date, oldest first.

Filter by countryCode (ISO 3166-1 alpha-2) or city (partial match). Results are paginated: follow nextCursor until it is null.

See Pagination, filtering and sorting for shared conventions.

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 a dated API revision in YYYY-MM-DD format, such as 2026-11-01. Pin this header to choose the revision explicitly; omitting it uses the server’s default. An unsupported value returns 400 unsupported_api_version. See Versions and compatibility.

Responses

Updated about 3 hours 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 about 3 hours ago

Did this page help you?