Introduction: WhosOnLocation API

Find out about the basics of the WhosOnLocation API (Application Program Interface). 

Using our JSON-based REST API you can build integrations that leverage your visitor and staff data, notifications, users, locations, departments, and more. 

WhosOnLocation provides a REST API for managing data. The API currently supports JSON or XML data and is chosen via the Accept and Content-Type headers.

For more information, check our API schema.

API media types

The Accept and Content-Type HTTP headers can be used to describe the content being sent or requested within an HTTP request.

The client may set Accept to application/json if it is requesting a response in JSON.

Conversely, when sending data, setting the Content-Type to application/xml tells the client that the data being sent in the request is XML.

API rate limits

This API is rate-limited. You can only query the API service up to 100 times per minute per API key.

We reserve the right to adjust the rate limit for given endpoints to provide a high-quality service for all clients.

If the rate limit is exceeded, WhosOnLocation will respond with an HTTP 429 Too Many Requests response code and a body that details the reason for the rate limiter kicking in.

The response will also have a Retry-After header that tells you how many seconds to wait before retrying.

Get started with the API