Pilgrim Geofence API

Learn About the Geofences API



API Explorer

API Usage

Learn about how to use the API including authentication, rate limits and more.




Endpoints


Get a Geofence

Get a geofence referenced by its geofence_id.

Get All Geofences

Gets all created geofences created within your FSQ Developer Project.

Add a Geofence

Create the following types of geofences: Around a FSQ Venue, using a Custom Polygon, around a Lat/Long Coordinate.

Add Bulk Geofences

Bulk add up to 1000 geofence objects at the same time.

Update a Geofence

Update a geofence referenced by its geofenceId.

Delete a Geofence

Delete a geofence referenced by its geofenceId.

Delete Bulk Geofences

Bulk delete up to 100 geofences (by its geofenceId) at the same time.

Clear All Geofences

Clears all created geofences.



Sign In