Saved visitors

Each employee can maintain a saved visitor list in OnLocation. Use the saved visitor API to retrieve all saved visitors, add a new saved visitor, or update or delete a saved visitor.

Learn more about saved visitors in the OnLocation Help Center.

List all saved visitors

Returns a list of all saved visitors added by employees.

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.

Responses
200

List of registered visitors

403

Access denied to this resource

404

Resource not found

500

Internal server error

get/visitor/person
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/visitor/person
Response samples
application/json
application/json
application/xml
[
  • {
    }
]

Retrieve a saved visitor

Retrieves a single saved visitor, filtering with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the registered visitor to retrieve

Responses
200

A visitor's details

403

Access denied to resource

404

Resource not found

500

Internal server error

get/visitor/person/{id}
Request samples
curl -i -X GET \
  https://api.whosonlocation.com/v1/visitor/person/:id
Response samples
application/json
application/json
application/xml
{
  • "id": 293,
  • "created": "2021-11-29T11:10:44+13:00",
  • "modified": "2021-11-30T11:10:44+13:00",
  • "location_id": 301,
  • "created_staff_id": 823431,
  • "staff_id": 823431,
  • "name": "Frequent Visitor name",
  • "email": "frequent.visitor@whosonlocation.com",
  • "from": "Another Organisation",
  • "phone": "+1 206 555 0123",
  • "mobile": "+1 206 555 0123",
  • "title": "Mr",
  • "assistance": false,
  • "type": "frequent",
  • "groups": [
    ]
}

Delete a saved visitor

Deletes a saved visitor using with the provided ID.

Request
path Parameters
id
required
integer <int32>

ID of the registered visitor to delete

Responses
204

Saved visitor deleted

403

Access denied to resource

404

Resource not found

500

Internal server error

delete/visitor/person/{id}
Request samples
curl -i -X DELETE \
  https://api.whosonlocation.com/v1/visitor/person/:id