List all locations.

get

https://api.podium.com/v4/locations

List of all the locations that the caller has access to.

If the cursor parameter is used then all other parameters will be ignored. This is to avoid confusion if passing both a cursor and other parameters which would change what data is being returned. The cursor keeps the filters of the request that returned it, so every page of a createdAfter, createdBefore or updatedAfter query stays filtered.

Required scope: read_locations.

Query Params

string

String you would like to search for in the searchFields parameter.

searchFields

array of strings

Defaults to name

A list of the fields where you want to search for the search parameters. e.g. ?searchFields[]=name&searchFields[]=displayname

searchFields

Allowed:

limit

integer

0 to 100

Defaults to 10

Max number of items to return per request. Defaults to 10.

createdAfter

date-time

Only return locations that were created after the given date. Combine with createdBefore to select a window, e.g. every location created since the last time you polled.

createdBefore

date-time

Only return locations that were created at or before the given date. Inclusive, so a poller can pass the previous request's createdBefore as the next createdAfter without missing a location.

updatedAfter

date-time

Only return locations that have been updated after the given date.

cursor

string

Retrieves the page of items that comes after the cursor.

Responses

Callback

Language

Loading…

Response

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

application/json

200Successful response.

defaultError response.