Lightbug Documentation

Appearance

Gets a list of geofences​

GET
/users/{userid}/geofences

Authorizations​

ApiKeyAuth

API Key for authentication. Retrieval from either API version login routes, or other authentication token type. See Authentication for more details.

Type
API Key (header: Authorization)
Example"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

Parameters​

Path Parameters

userid*

User ID

Type
integer
Required

Query Parameters

_limit

Limit for pagination, default 10, max 10000

Type
integer
_page

Page for pagination

Type
integer
_sort

Sort by this field

Type
string
_direction

Sort in this direction (asc, desc)

Type
string
_include

Include related models

Type
string
Valid values
"list"

Request example

Responses​

OK

application/json
JSON
{
  
"data": [
  
  
{
  
  
  
"center": {
  
  
  
  
"lat": 0,
  
  
  
  
"lng": 0
  
  
  
},
  
  
  
"deviceId": 0,
  
  
  
"foreignId": "string",
  
  
  
"id": 0,
  
  
  
"list": {
  
  
  
  
"color": "string",
  
  
  
  
"id": 0,
  
  
  
  
"name": "string",
  
  
  
  
"ownerId": 0
  
  
  
},
  
  
  
"listId": 0,
  
  
  
"meta": {
  
  
  
  
"additionalProperties": null
  
  
  
},
  
  
  
"modified": true,
  
  
  
"name": "string",
  
  
  
"outline": [
  
  
  
  
{
  
  
  
  
  
"lat": 0,
  
  
  
  
  
"lng": 0
  
  
  
  
}
  
  
  
],
  
  
  
"ownerId": 0,
  
  
  
"radius": 0,
  
  
  
"type": "string"
  
  
}
  
],
  
"limit": 0,
  
"page": 0,
  
"totalElements": 0,
  
"totalPages": 0
}
Try this endpoint

Playground​

Authorization
Variables
Key
Value