List Locations

get

https://app.bluetallyapp.com/api/v1/locations

Returns all locations.

Query Params

tenant_id

int32

The ID of the tenant the API request is for (for users with multi-tenancy enabled)

limit

int32

Defaults to 50

The maximum number of entries to return.

sort

string

Defaults to name

The column to sort the results by. Options: { created_at, updated_at, name, address_line_1, address_line_2, city, zip, state, country }

order

string

Defaults to asc

The order to sort the results by. Options: { asc, desc }

offset

int32

Defaults to 0

Offset the results by a number.

name

string

The exact search for name.

address_line_1

string

The exact search for address line 1.

address_line_2

string

The exact search for address line 2.

city

string

The exact search for city.

zip

string

The exact search for zip.

state

string

The exact search for state.

country

string

The exact search for country.

string

The exact search for email.

phone

string

The exact search for phone.

currency

string

The exact search for currency.

Response

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200