List all locations.
GET {{baseUrl}}/v4/locations?search=nisi dolor sed ullamco&searchFields=name&limit=10&cursor=MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw
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.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
search | string | String you would like to search for in the searchFields parameter. | |
searchFields | string | A list of the fields where you want to search for the search parameters. e.g. ?searchFields[]=name&searchFields[]=displayname | |
limit | number | Max number of items to return per request. Defaults to 10 . | |
cursor | string | Retrieves the page of items that comes after the cursor . |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"address":"1650 Digital Dr, Lehi, UT 84043","archived":false,"displayName":"Podium, Inc.","name":"dolore nisi anim laboris","organizationUid":"00000000-0000-0000-0000-000000000000","podiumPhoneNumber":"+18017580580","uid":"00000000-0000-0000-0000-000000000000"},{"address":"1650 Digital Dr, Lehi, UT 84043","archived":false,"displayName":"Podium, Inc.","name":"re","organizationUid":"00000000-0000-0000-0000-000000000000","podiumPhoneNumber":"+18017580580","uid":"00000000-0000-0000-0000-000000000000"}],"metadata":{"nextCursor":"MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw","previousCursor":"MDAwMDAwMDAtMDAwMC0wMDAwLTAwMDAtMDAwMDAwMDAwMDAw","totalItems":9436737,"url":"https://www.podium.com/"}}