Each OnLocation account is made up of one or more locations. A location record contains the name, contact details, timezone, date format, employee count, and the access points set up for that location.
Use the location API to retrieve your location list, add a new location, or update or delete an existing location.
Learn more about the information that's captured for each location in the OnLocation Help Center.
Retrieves a list of all locations.
A comma separated list of tag:value search parameters, a colon separator performs an exact match, a percent separator performs a starts-with search and greater/less than search number/date ranges.
List of locations
Access denied to this resource
Resource not found
Internal server error
curl -i -X GET \ 'https://api.whosonlocation.com/v1/location?q=string'
[- {
- "id": 301,
- "created": "2021-08-12T09:26:54+12:00",
- "modified": "2021-09-03T09:26:54+12:00",
- "name": "Head Office",
- "address": " 1008 Tawa Terrace, Tawa, Wellington, New Zealand",
- "phone": "+1 206 555 0123",
- "external_id": "998",
- "postcode": "5021",
- "country": "NZ",
- "timezone": "Pacific/Auckland",
- "date_format": "d/m/Y",
- "staff_count": 13,
- "lacps": [
- {
- "id": 240,
- "name": "G1 - Entry"
}
]
}
]Adds a new location to an account.
Location created
Access denied to this resource
Internal server error
{- "name": "Head Office",
- "address": " 1008 Tawa Terrace, Tawa, Wellington, New Zealand",
- "phone": "+1 206 555 0123",
- "postcode": "5021",
- "country": "NZ",
- "timezone": "Pacific/Auckland",
- "date_format": "d/m/Y"
}{- "id": 301,
- "created": "2021-08-12T09:26:54+12:00",
- "modified": "2021-09-03T09:26:54+12:00",
- "name": "Head Office",
- "address": " 1008 Tawa Terrace, Tawa, Wellington, New Zealand",
- "phone": "+1 206 555 0123",
- "external_id": "998",
- "postcode": "5021",
- "country": "NZ",
- "timezone": "Pacific/Auckland",
- "date_format": "d/m/Y",
- "staff_count": 13,
- "lacps": [
- {
- "id": 240,
- "name": "G1 - Entry"
}
]
}Returns the details of a single location, based on the ID provided.
Location response
Access denied to this resource
Resource not found.
Internal server error.
curl -i -X GET \ https://api.whosonlocation.com/v1/location/:id
{- "id": 301,
- "created": "2021-08-12T09:26:54+12:00",
- "modified": "2021-09-03T09:26:54+12:00",
- "name": "Head Office",
- "address": " 1008 Tawa Terrace, Tawa, Wellington, New Zealand",
- "phone": "+1 206 555 0123",
- "external_id": "998",
- "postcode": "5021",
- "country": "NZ",
- "timezone": "Pacific/Auckland",
- "date_format": "d/m/Y",
- "staff_count": 13,
- "lacps": [
- {
- "id": 240,
- "name": "G1 - Entry"
}
]
}Updates a location's details.
Location details:
Updated location
Access denied to this resource
Internal server error
{- "name": "Head Office",
- "address": " 1008 Tawa Terrace, Tawa, Wellington, New Zealand",
- "phone": "+1 206 555 0123",
- "postcode": "5021",
- "country": "NZ",
- "timezone": "Pacific/Auckland",
- "date_format": "d/m/Y"
}