Description

Get a geofence referenced by its geofenceId. A geofenceId is generated for all geofences and can be found in the Pilgrim Console.


Request

GET https://api.foursquare.com/v2/apps/CLIENT_ID/geofence/GEOFENCE_ID


Authentication

User authentication.


Parameters

None.


Response Fields

Field Description
geofence A geofence object containing an id, name, type, and boundary.
id A unique string identifier for this geofence.
name Name of the geofence that will appear in the Pilgrim Console.
type Can be either Venue, LatLng, or Polygon.
boundary Bounds of the geofence. For polygons it will be an array of points.
radius Area around the lat/lng that will trigger a geofence event.

Response

{
    "meta": {
        "code": 200,
        "requestId": "5cacda89f594df4b05c2444c"
    },
    "notifications": [
        {
            "type": "notificationTray",
            "item": {
                "unreadCount": 0
            }
        }
    ],
    "response": {
        "geofence": {
            "type": "Venue",
            "name": "au cheval",
            "id": "5cacb43ed176e90025f69690",
            "venueIds": [
                "5c71d51689b06a002c6de87d"
            ],
            "boundary": {
                "radius": 120
            },
            "dwellTime": 2
        }
    }
}
Was this page helpful?
Yes
No
Thank you!