Users API
getGet User API
get
https://api.geospark.co/v3/api/user/
The Get User API provides the list of users who are using your app corresponding to the project secret API key provided.
Request
Response
Request
Headers
Api-key
required
string
Auth-key
E.g.- 33223kjhdcscijhb5sdbsdmjsdcbj5f
Query Parameters
user_id
optional
string
Used to get the details of one particular user. Note: This query param cannot be used along with any other.
timezone_offset
optional
string
If the timezone is provided the query will be made as per the given timezone.
E.g.- Asia/Kolkata
start_date
required
string
Date from when the data is to be returned.
E.g.- 2020-09-10
end_date
required
string
Date till when the data is to be returned.
E.g.- 2020-09-13
page_number
optional
integer
This field is used for getting 10 entries at a time. If the response returns an empty list in the data field, it is safe to assume the pages are exhausted.
If points_encoded value is
true, this value will not be considered.
E.g.- 1Response
200: OK
{"status": true,"msg": "Success.","code": 200,"data": {"next_page": null,"pages": 1,"prev_page": null,"account_id": "5ede06d73722791c17f27272","users": [{"id": "60058ad6ffb3fb21c905a0b4","app_id": "5ef070ce1e621663c53bb3c6_2","device_token": "devicetoken","description": "postman device test","brand": "Samsung","model": "S8","os_version": "8.1","sdk_version": "2.1","geofence_events": true,"motion_events": false,"location_events": false,"trips_events": true,"nearby_events": false,"location_listener": false,"event_listener": false,"metadata": {"name": "Nikhil"},"is_deleted": false,"created_at": "2021-01-18T13:19:18.181","last_location_update": {}}]}}
curl --location --request GET 'https://api.geospark.co/v3/api/user/?start_date=2021-01-18&end_date=2021-01-19' \--header 'Api-Key: f4441682ed03441eb906693a3bde8979'
putUpdate User API
put
https://api.geospark.co/v3/api/user/
This API lets you update the details of a
user_id.Request
Response
Request
Headers
Api-key
required
string
Auth-key
E.g.- 33223kjhdcscijhb5sdbsdmjsdcbj5f
Body Parameters
user_id
required
string
Enable or disable events data for the given user_id.
E.g.- 5d9450ace47bae6d70064a9b
description
optional
string
Update user description.
E.g.- “test user”
geofence_events
optional
boolean
Enable or disable geofence_events.
E.g.- true
trips_events
optional
boolean
Enable or disable trips_events.
E.g.- true
location_events
optional
boolean
Enable or disable location_events.
E.g.- true
nearby_events
optional
boolean
Enable or disable nearby_events.
E.g.- true
event_listener
optional
boolean
Enable or disable event_listener.
E.g.- true
location_listener
optional
boolean
Enable or disable location_listener.
E.g.- true
Response
200: OK
{"status": true,"msg": "Success.","code": 200,"data": {"id": "60058ad6ffb3fb21c905a0b4","account_id": "5ede06d73722791c17f27272","app_id": "5ef070ce1e621663c53bb3c6_2","device_token": "devicetoken","device_uuid": null,"description": "POPOPOPO","brand": "Samsung","model": "S8","group_id": null,"os_version": "8.1","sdk_version": "2.1","device_arn": null,"geofence_events": true,"motion_events": false,"location_events": false,"trips_events": true,"nearby_events": false,"location_listener": false,"event_listener": false,"metadata": {"name": "rahul"},"is_deleted": false,"created_at": "2021-01-18T13:19:18.181","updated_at": "2021-01-18T13:28:28.132"}}
curl --location --request PUT 'https://api.geospark.co/v3/api/user/' \--header 'Content-Type: application/json' \--header 'APi-Key: f4441682ed03441eb906693a3bde8979' \--data-raw '{"user_id": "60058ad6ffb3fb21c905a0b4","description": "POPOPOPO","metadata" :{"name": "rahul" }}'