{
"info": {
"_postman_id": "bd417518-de65-baa3-3dd3-0eaf2e4dabeb",
"name": "IPera Starling API v1",
"description": "# IPera Starling API — V1\n\nREST API for managing guests, sessions, locations, analytics, and more on the IPera Starling Wi-Fi platform.\n\n## Setup\n\n1. Set the `baseUrl` collection variable to your environment:\n - **Engagement:** `https://api.iperawifi.com/api/v1`\n - **Middle East:** `https://api.me.iperawifi.com/api/v1`\n2. Set the `api_token` collection variable to your Bearer token.\n\nAll requests are authenticated automatically via the collection-level Bearer auth.\n\n## Pagination\n\nList endpoints support `page` and `per_page` query parameters (default: 10, max: 100 unless otherwise noted). Responses include `links` and `meta` objects for navigation.\n\n## Rate Limiting\n\nMost endpoints are limited to **60 requests per minute**. Exceeding the limit returns HTTP 429.\n\n## Error Codes\n\n| Code | Meaning |\n|------|---------|\n| 401 | Missing or invalid Bearer token |\n| 403 | Insufficient permissions |\n| 404 | Resource not found |\n| 422 | Validation error (see `errors` field) |\n| 429 | Rate limit exceeded |\n| 500 | Internal server error |",
"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
},
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{api_token}}",
"type": "string"
}
]
},
"variable": [
{
"key": "baseUrl",
"value": "https://api.iperawifi.com/api/v1",
"type": "string"
},
{
"key": "api_token",
"value": "",
"type": "string"
}
],
"item": [
{
"name": "Access Codes",
"description": "Generate and manage guest access codes for Wi-Fi onboarding.",
"item": [
{
"name": "Create Access Codes",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/access-codes",
"host": [
"{{baseUrl}}"
],
"path": [
"access-codes"
],
"variable": []
},
"description": "Generate new access code(s)\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| - |-|:-:|-----|\n| location_id | string | ✔️ | Location / venue ID. Required |\n| service_profile_id | string | ✔️ | Service profile ID for the access code(s). Required by validation |\n| guest_id | string | | Guest ID |\n| type | integer | ✔️ | Type of the access code.
Values: 1: Shared, 2: Access Code |\n| code | string | | Static shared code to be used.
Required when type is Shared. |\n| quantity | integer | | Number of access codes to be generated. Valid only when type is Access Code (2). Must be between 1 and 1000. Default: 1 |\n| start_date | date | | Start date of the code.
Format: YYYY-MM-DD |\n| expiry_date | date | | Expiry date of the code.
Format: YYYY-MM-DD |\n| description | string | | |\n\n### Response Example\n\n```json\n{\n \"status\": true,\n \"message\": \"Created 1 code\",\n \"count\": 1,\n \"access_codes\": [\n {\n \"id\": \"ApR3zO7zqeZ\",\n \"location_id\": \"rdb6XWwXQ2j\",\n \"location_name\": \"Default Location\",\n \"code\": \"u2\",\n \"type\": 2,\n \"type_name\": \"Access Code\",\n \"description\": null,\n \"service_profile_id\": \"KPGD8j3xW25\",\n \"service_profile_name\": \"Default Service Profile - 60 Minute(s)\",\n \"start_date\": null,\n \"expiry_date\": null,\n \"status\": 1,\n \"status_name\": \"Available\",\n \"use_count\": 0,\n \"used_at\": null,\n \"guest_id\": null,\n \"guest_name\": \"\",\n \"created_at\": \"2017-01-04T09:55:31.000000Z\"\n }\n ]\n}\n```",
"body": {
"mode": "raw",
"raw": "{\n \"location_id\": \"example\",\n \"service_profile_id\": \"example\",\n \"type\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
}
]
},
{
"name": "Advertisements",
"description": "Retrieve advertisement campaigns associated with your tenant.",
"item": [
{
"name": "Get Advertisements List",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/advertisements",
"host": [
"{{baseUrl}}"
],
"path": [
"advertisements"
],
"variable": [],
"query": [
{
"key": "title",
"value": "",
"description": "Title of the advertisement. Performs text-search.",
"disabled": true
},
{
"key": "type",
"value": "",
"description": "Advertisement Type: 0: Text 1: Image",
"disabled": true
},
{
"key": "url",
"value": "",
"description": "Url of the advertisement. Performs text-search.",
"disabled": true
},
{
"key": "status",
"value": "",
"description": "Advertisement Status: 0: Draft 1: Published",
"disabled": true
},
{
"key": "tag_id",
"value": "",
"description": "Tag of the advertisement. Performs text-search with hashed tag id.",
"disabled": true
},
{
"key": "start_date",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "end_date",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "page",
"value": "",
"description": "The number of page returned. Default is 1.",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 25, maximum is 100",
"disabled": true
},
{
"key": "order_by",
"value": "",
"description": "Order by field (title, type, method, status)",
"disabled": true
},
{
"key": "order_direction",
"value": "",
"description": "Order direction (asc, desc)",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of advertisement.\n\nPlease note that you cannot get more than 100 records per request. In case you need\nto get more than 100 records, then you should make more than one request.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| title | string | Title of the advertisement. Performs text-search. |\n| type | integer | Advertisement Type:
0: Text
1: Image |\n| url | string | Url of the advertisement. Performs text-search. |\n| status | integer | Advertisement Status:
0: Draft
1: Published |\n| tag_id | string | Tag of the advertisement. Performs text-search with hashed tag id. |\n| start_date | date | Returns entries started after the entered starting date (format: yyyy-mm-dd) |\n| end_date | date | Returns entries ended before the entered ending date (format: yyyy-mm-dd) |\n| page | string | The number of page returned. Default is 1. |\n| per_page | integer | The number of records returned. Default is 25, maximum is 100 |\n| order_by | string | Order by field (title, type, method, status) |\n| order_direction | string | Order direction (asc, desc) |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"id\": \"jkDvjePrZ7y\",\n \"title\": \"test\",\n \"type\": 0,\n \"method\": 1,\n \"condition_value\": 2,\n \"impression_count\": 0,\n \"click_count\": 0,\n \"status\": 1,\n \"start_date\": \"2021-01-24T21:00:00.000000Z\",\n \"end_date\": \"2021-02-01T20:59:59.000000Z\",\n \"tags\": []\n },\n {\n \"id\": \"0mqryGZBb4N\",\n \"title\": \"Test123\",\n \"type\": 1,\n \"method\": 1,\n \"condition_value\": 0,\n \"impression_count\": 0,\n \"click_count\": 0,\n \"status\": 0,\n \"start_date\": \"2021-03-29T21:00:00.000000Z\",\n \"end_date\": \"2021-04-06T20:59:59.000000Z\",\n \"tags\": [\n {\n \"id\": \"WZgBAelB9wD\",\n \"name\": \"advertisement\",\n \"group_name\": \"a\"\n }\n ]\n }\n ],\n \"links\": {\n \"first\": \"[[BaseUrl]]/advertisements?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"[[BaseUrl]]/advertisements?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"[[BaseUrl]]/advertisements\",\n \"per_page\": 25,\n \"to\": 2\n }\n}\n```"
},
"response": []
},
{
"name": "Get Advertisement Count",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/advertisements/count",
"host": [
"{{baseUrl}}"
],
"path": [
"advertisements",
"count"
],
"variable": [],
"query": [
{
"key": "title",
"value": "",
"description": "Title of the advertisement. Performs text-search.",
"disabled": true
},
{
"key": "type",
"value": "",
"description": "Advertisement Type: 0: Text 1: Image",
"disabled": true
},
{
"key": "url",
"value": "",
"description": "Url of the advertisement. Performs text-search.",
"disabled": true
},
{
"key": "status",
"value": "",
"description": "Advertisement Status: 0: Draft 1: Published",
"disabled": true
},
{
"key": "tag_id",
"value": "",
"description": "Tag of the advertisement. Performs text-search with hashed tag id.",
"disabled": true
},
{
"key": "start_date",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "end_date",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "order_by",
"value": "",
"description": "Order by field (title, type, method, status)",
"disabled": true
},
{
"key": "order_direction",
"value": "",
"description": "Order direction (asc, desc)",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the count of the advertisement.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| title | string | Title of the advertisement. Performs text-search. |\n| type | integer | Advertisement Type:
0: Text
1: Image |\n| url | string | Url of the advertisement. Performs text-search. |\n| status | integer | Advertisement Status:
0: Draft
1: Published |\n| tag_id | string | Tag of the advertisement. Performs text-search with hashed tag id. |\n| start_date | date | Returns entries started after the entered starting date (format: yyyy-mm-dd) |\n| end_date | date | Returns entries ended before the entered ending date (format: yyyy-mm-dd) |\n| order_by | string | Order by field (title, type, method, status) |\n| order_direction | string | Order direction (asc, desc) |\n\n### Response Example\n\n```json\n{\n \"count\": 1000\n}\n```"
},
"response": []
}
]
},
{
"name": "Analytics",
"description": "Guest and visit analytics including gender breakdown, nationalities, traffic trends, visit frequencies, top locations, and hourly footfall.",
"item": [
{
"name": "Get Gender",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/analytics/guest/genders",
"host": [
"{{baseUrl}}"
],
"path": [
"analytics",
"guest",
"genders"
],
"variable": [],
"query": [
{
"key": "date_start",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "date_end",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd)",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to collect gender information that\nis collected by Wi-Fi splash page and social network. If date parameters aren't set, the\nAPI endpoint returns data from last week. If only one date parameter is set, the API\nendpoint returns again 1-week data.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| - |-|:-:|-----|\n| location_id | string | ✔️ | Location / venue ID |\n| date_start | date | | Returns entries started after the entered starting date (format: yyyy-mm-dd)\n| date_end | date | | Returns entries ended before the entered ending date (format: yyyy-mm-dd)\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"Unknown\": 1883,\n \"Male\": 2005,\n \"Female\": 1645\n }\n ]\n}\n```"
},
"response": []
},
{
"name": "Get Nationalities",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/analytics/guest/nationalities",
"host": [
"{{baseUrl}}"
],
"path": [
"analytics",
"guest",
"nationalities"
],
"variable": [],
"query": [
{
"key": "date_start",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "date_end",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd)",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of guest\nnationalities. If date parameters aren't set, the API endpoint returns data from last week.\nIf only one date parameter is set, the API endpoint returns again 1-week data.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| - |-|:-:|-----|\n| location_id | string | ✔️ | Location / venue ID |\n| date_start | date | | Returns entries started after the entered starting date (format: yyyy-mm-dd)\n| date_end | date | | Returns entries ended before the entered ending date (format: yyyy-mm-dd)\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"German\": 59,\n \"British\": 36,\n \"Indonesian\": 29,\n \"Mexican\": 20\n }\n ]\n}\n```"
},
"response": []
},
{
"name": "Get Total Traffic",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/analytics/visit/total-traffic",
"host": [
"{{baseUrl}}"
],
"path": [
"analytics",
"visit",
"total-traffic"
],
"variable": [],
"query": [
{
"key": "location_id",
"value": "",
"description": "Location / venue ID",
"disabled": true
},
{
"key": "date_start",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "date_end",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd)",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of total traffic. If\ndate parameters aren't set, the API endpoint returns last week data. If only one date\nparameter is set, the API endpoint returns again 1-week data.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| - |-|:-:|-----|\n| location_id | string | | Location / venue ID |\n| date_start | date | | Returns entries started after the entered starting date (format: yyyy-mm-dd)\n| date_end | date | | Returns entries ended before the entered ending date (format: yyyy-mm-dd)\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"2020-01-01\": {\n \"passerby\": 31847,\n \"visit\": 3523\n },\n \n \"2020-01-02\": {\n \"passerby\": 32329,\n \"visit\": 2850\n },\n \n \"2020-01-03\": {\n \"passerby\": 27367,\n \"visit\": 2789\n },\n \n \"2020-01-04\": {\n \"passerby\": 40558,\n \"visit\": 2238\n },\n \n \"2020-01-05\": {\n \"passerby\": 22869,\n \"visit\": 2416\n },\n \n \"2020-01-06\": {\n \"passerby\": 23064,\n \"visit\": 2469\n }\n }\n ]\n}\n```"
},
"response": []
},
{
"name": "Get Visit Frequencies",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/analytics/visit/frequencies",
"host": [
"{{baseUrl}}"
],
"path": [
"analytics",
"visit",
"frequencies"
],
"variable": [],
"query": [
{
"key": "location_id",
"value": "",
"description": "Location / venue ID",
"disabled": true
},
{
"key": "date_start",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "date_end",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd)",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of visit frequencies.\nIf date parameters aren't set, the API endpoint returns last week data. If only one date\nparameter is set, the API endpoint returns again 1-week data.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| - |-|:-:|-----|\n| location_id | string | | Location / venue ID |\n| date_start | date | | Returns entries started after the entered starting date (format: yyyy-mm-dd)\n| date_end | date | | Returns entries ended before the entered ending date (format: yyyy-mm-dd)\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"1 visit\": 9563,\n \"2 visits\": 1008,\n \"3-5 visits\": 500,\n \"6-10 visits\": 9\n }\n ]\n}\n```"
},
"response": []
},
{
"name": "Get Top Location",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/analytics/visit/top-locations",
"host": [
"{{baseUrl}}"
],
"path": [
"analytics",
"visit",
"top-locations"
],
"variable": [],
"query": [
{
"key": "date_start",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "date_end",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd)",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of visit top locations.\nIf date parameters aren't set, the API endpoint returns last week data. If only one date\nparameter is set, the API endpoint returns again 1-week data.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| - |-|:-:|-----|\n| location_id | string | ✔️ | Location / venue ID |\n| date_start | date | | Returns entries started after the entered starting date (format: yyyy-mm-dd)\n| date_end | date | | Returns entries ended before the entered ending date (format: yyyy-mm-dd)\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"Main Lobby\": {\n \"Overall\": 18739,\n \"Female\": 6524,\n \"Male\": 7535\n },\n \n \"Gucci Zone\": {\n \"Overall\": 3277,\n \"Female\": 1257,\n \"Male\": 1798\n },\n \n \"Sephora\": {\n \"Overall\": 3138,\n \"Female\": 2011,\n \"Male\": 1032\n },\n \n \"Diesel\": {\n \"Overall\": 2414,\n \"Female\": 970,\n \"Male\": 1352\n }\n }\n ]\n}\n```"
},
"response": []
},
{
"name": "Get Hourly Footfall",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/analytics/footfall",
"host": [
"{{baseUrl}}"
],
"path": [
"analytics",
"footfall"
],
"variable": [],
"query": [
{
"key": "location_id",
"value": "",
"description": "Location / venue ID",
"disabled": true
},
{
"key": "end_date",
"value": "",
"description": "Endpoint returns hourly footfall until this date (format: yyyy-mm-dd)",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get hourly footfall.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| - |-|:-:|-----|\n| location_id | string | | Location / venue ID |\n| start_date | date | ✔ | Endpoint returns hourly footfall starting from this date (format: yyyy-mm-dd)\n| end_date | date | | Endpoint returns hourly footfall until this date (format: yyyy-mm-dd)\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"2020-12-19\": [\n 59,\n 50,\n 52,\n 44,\n 42,\n 44,\n 47,\n 48,\n 51,\n 57,\n 58,\n 75,\n 77,\n 87,\n 101,\n 111,\n 105,\n 87,\n 85,\n 73,\n 72,\n 73,\n 70,\n 69\n ],\n \"2020-12-20\": [\n 67,\n 62,\n 52,\n 49,\n 43,\n 45,\n 55,\n 71,\n 83,\n 96,\n 105,\n 119,\n 122,\n 140,\n 136,\n 151,\n 159,\n 126,\n 96,\n 90,\n 87,\n 82,\n 75,\n 75\n ]\n }\n}\n```"
},
"response": []
}
]
},
{
"name": "Guest Activities",
"description": "Retrieve a chronological log of guest actions and events.",
"item": [
{
"name": "Get Guest Activities",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/guests/activities",
"host": [
"{{baseUrl}}"
],
"path": [
"guests",
"activities"
],
"variable": [],
"query": [
{
"key": "guest_id",
"value": "",
"description": "End-user ID",
"disabled": true
},
{
"key": "location_id",
"value": "",
"description": "Location / Venue ID",
"disabled": true
},
{
"key": "activity_type",
"value": "",
"description": "Activity type: 1: Impression - seen splash page (welcome page) 2: Connected - signed in 5: Disconnected - signed out",
"disabled": true
},
{
"key": "created_at",
"value": "",
"description": "Returns entries created after the specified date up to 1 week later (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "start_time",
"value": "",
"description": "Returns entries started after the entered starting date (about 1 week after created_at) (format: yyyy-mm-dd hh:mm:ss)",
"disabled": true
},
{
"key": "end_time",
"value": "",
"description": "Returns entries ended before the entered ending date (about 1 week after created_at) (format: yyyy-mm-dd hh:mm:ss)",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 1000",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of guest activities.\n\nPlease note that you cannot get more than 1000 records per request. In case you need\nto get more than 1000 records, then you should make more than one request.\n\nPlease note that API returns response as default 1 day range, maximum 1 week range.\n\n\n\nThis endpoint has a rate limit of **20 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| guest_id | string | End-user ID |\n| location_id | string | Location / Venue ID |\n| activity_type | integer | Activity type:
1: Impression - seen splash page (welcome page)
2: Connected - signed in
5: Disconnected - signed out |\n| created_at | date | Returns entries created after the specified date up to 1 week later (format: yyyy-mm-dd) |\n| start_time | datetime | Returns entries started after the entered starting date (about 1 week after created_at) (format: yyyy-mm-dd hh:mm:ss) |\n| end_time | datetime | Returns entries ended before the entered ending date (about 1 week after created_at) (format: yyyy-mm-dd hh:mm:ss) |\n| per_page | integer | The number of records returned. Default is 10, maximum is 1000 |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"activity_name\": \"Connected\",\n \"activity_type\": 2,\n \"created_at\": \"2017-10-27T12:13:01+00:00\",\n \"guest_id\": \"X392YKaq6Dg\",\n \"location_id\": \"pqn2Kek6MO5\",\n \"location_name\": \"IPERA New York\",\n \"yas_id\": \"8f627d10-1abc-44d8-b964-a7816388173a\"\n },\n {\n \"activity_name\": \"Disconnected\",\n \"activity_type\": 5,\n \"created_at\": \"2017-10-27T12:04:40+00:00\",\n \"guest_id\": \"1XQLlBBGo4j\",\n \"location_id\": \"pqn2Kek6MO5\",\n \"location_name\": \"IPERA New York\",\n \"yas_id\": \"d4399948-05e7-4efa-91fb-39198515f308\"\n },\n {\n \"activity_name\": \"Impression\",\n \"activity_type\": 1,\n \"created_at\": \"2017-10-27T11:43:46+00:00\",\n \"guest_id\": \"9xko9aPOo7a\",\n \"location_id\": \"pqn2Kek6MO5\",\n \"location_name\": \"IPERA New York\",\n \"yas_id\": \"ea28901d-35fc-4e37-aeb4-b3a4cb2a180b\"\n }\n ],\n\n \"links\": {\n \"first\": \"[[BaseUrl]]/guests/activities?page=1\",\n \"last\": null,\n \"next\": \"[[BaseUrl]]/guests/activities?page=2\",\n \"prev\": null\n },\n\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"[[BaseUrl]]/guests/activities\",\n \"per_page\": 15,\n \"to\": 3\n }\n}\n```"
},
"response": []
}
]
},
{
"name": "Guest Dashboard",
"description": "Aggregated guest statistics (counts, new guests, connections, and traffic) broken down by hour, day, or month — used for dashboard visualizations.",
"item": [
{
"name": "Get Guests",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reports/dashboard/guests",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"dashboard",
"guests"
],
"variable": [],
"query": [
{
"key": "location_id",
"value": "",
"description": "Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the guest statistics hourly, daily or monthly.\n\nNotes: \n- Endpoint returns unique guest counts in each date group.\n- 'Sum' key returns total unique guest count in given date interval.\n\nResponse will change based on the range between start and end date parameters.\n\n- If the range is one day, it’ll return hourly data\n- If the range is less than a month, it’ll show daily data\n- If the range is more than a month it’ll show monthly data\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-------------|:-:|---------------------------------------------------------------------------------------------------------|\n| location_id | string | | Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned \n| start_date | datetime | ✔ | Start date (format: yyyy-mm-dd hh:mm:ss) \n| end_date | datetime | ✔ | End date (format: yyyy-mm-dd hh:mm:ss)\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"2020-06-01 00:00\": 10,\n \"2020-06-01 01:00\": 10,\n \"2020-06-01 02:00\": 10,\n \"2020-06-01 03:00\": 10,\n \"2020-06-01 04:00\": 10,\n \"2020-06-01 05:00\": 10,\n \"2020-06-01 06:00\": 10,\n \"2020-06-01 07:00\": 10,\n \"2020-06-01 08:00\": 10,\n \"2020-06-01 09:00\": 10,\n \"2020-06-01 10:00\": 10,\n \"2020-06-01 11:00\": 10,\n \"2020-06-01 12:00\": 10,\n \"2020-06-01 13:00\": 10,\n \"2020-06-01 14:00\": 10,\n \"2020-06-01 15:00\": 10,\n \"2020-06-01 16:00\": 10,\n \"2020-06-01 17:00\": 10,\n \"2020-06-01 18:00\": 10,\n \"2020-06-01 19:00\": 10,\n \"2020-06-01 20:00\": 10,\n \"2020-06-01 21:00\": 10,\n \"2020-06-01 22:00\": 10,\n \"2020-06-01 23:00\": 10\n },\n \"meta\": {\n \"group\": \"hourly\"\n },\n \"sum\": 240\n}\n```"
},
"response": []
},
{
"name": "Get New Guests",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reports/dashboard/new-guests",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"dashboard",
"new-guests"
],
"variable": [],
"query": [
{
"key": "location_id",
"value": "",
"description": "Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the new guest statistics hourly, daily or monthly.\n\nNotes:\n- Endpoint returns unique guest counts in each date group.\n- 'Sum' key returns total unique guest count in given date interval.\n\nResponse will change based on the range between start and end date parameters.\n\n- If the range is one day, it’ll return hourly data\n- If the range is less than a month, it’ll show daily data\n- If the range is more than a month it’ll show monthly data\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-------------|:-:|---------------------------------------------------------------------------------------------------------|\n| location_id | string | | Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned\n| start_date | datetime | ✔ | Start date (format: yyyy-mm-dd hh:mm:ss) \n| end_date | datetime | ✔ | End date (format: yyyy-mm-dd hh:mm:ss)\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"2020-06-01 00:00\": 10,\n \"2020-06-01 01:00\": 10,\n \"2020-06-01 02:00\": 10,\n \"2020-06-01 03:00\": 10,\n \"2020-06-01 04:00\": 10,\n \"2020-06-01 05:00\": 10,\n \"2020-06-01 06:00\": 10,\n \"2020-06-01 07:00\": 10,\n \"2020-06-01 08:00\": 10,\n \"2020-06-01 09:00\": 10,\n \"2020-06-01 10:00\": 10,\n \"2020-06-01 11:00\": 10,\n \"2020-06-01 12:00\": 10,\n \"2020-06-01 13:00\": 10,\n \"2020-06-01 14:00\": 10,\n \"2020-06-01 15:00\": 10,\n \"2020-06-01 16:00\": 10,\n \"2020-06-01 17:00\": 10,\n \"2020-06-01 18:00\": 10,\n \"2020-06-01 19:00\": 10,\n \"2020-06-01 20:00\": 10,\n \"2020-06-01 21:00\": 10,\n \"2020-06-01 22:00\": 10,\n \"2020-06-01 23:00\": 10\n },\n \"meta\": {\n \"group\": \"hourly\"\n },\n \"sum\": 240\n}\n```"
},
"response": []
},
{
"name": "Get Guest Connections",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reports/dashboard/guest-connections",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"dashboard",
"guest-connections"
],
"variable": [],
"query": [
{
"key": "location_id",
"value": "",
"description": "Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the guest connection statistics hourly, daily or monthly.\n\nResponse will change based on the range between start and end date parameters.\n\n- If the range is one day, it’ll return hourly data\n- If the range is less than a month, it’ll show daily data\n- If the range is more than a month it’ll show monthly data\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-------------|:-:|---------------------------------------------------------------------------------------------------------|\n| location_id | string | | Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned\n| start_date | datetime | ✔ | Start date (format: yyyy-mm-dd hh:mm:ss) \n| end_date | datetime | ✔ | End date (format: yyyy-mm-dd hh:mm:ss)\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"2020-06-01 00:00\": 10,\n \"2020-06-01 01:00\": 10,\n \"2020-06-01 02:00\": 10,\n \"2020-06-01 03:00\": 10,\n \"2020-06-01 04:00\": 10,\n \"2020-06-01 05:00\": 10,\n \"2020-06-01 06:00\": 10,\n \"2020-06-01 07:00\": 10,\n \"2020-06-01 08:00\": 10,\n \"2020-06-01 09:00\": 10,\n \"2020-06-01 10:00\": 10,\n \"2020-06-01 11:00\": 10,\n \"2020-06-01 12:00\": 10,\n \"2020-06-01 13:00\": 10,\n \"2020-06-01 14:00\": 10,\n \"2020-06-01 15:00\": 10,\n \"2020-06-01 16:00\": 10,\n \"2020-06-01 17:00\": 10,\n \"2020-06-01 18:00\": 10,\n \"2020-06-01 19:00\": 10,\n \"2020-06-01 20:00\": 10,\n \"2020-06-01 21:00\": 10,\n \"2020-06-01 22:00\": 10,\n \"2020-06-01 23:00\": 10\n },\n \"meta\": {\n \"group\": \"hourly\"\n },\n \"sum\": 240\n}\n```"
},
"response": []
},
{
"name": "Get Guest Traffics",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/reports/dashboard/guest-traffics",
"host": [
"{{baseUrl}}"
],
"path": [
"reports",
"dashboard",
"guest-traffics"
],
"variable": [],
"query": [
{
"key": "location_id",
"value": "",
"description": "Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the guest traffic statistics in bytes hourly, daily or monthly.\n\nResponse will change based on the range between start and end date parameters.\n\n- If the range is one day, it’ll return hourly data\n- If the range is less than a month, it’ll show daily data\n- If the range is more than a month it’ll show monthly data\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-------------|:-:|---------------------------------------------------------------------------------------------------------|\n| location_id | string | | Hashed id of a location. If this parameter is not provided (null), all location’s data will be returned\n| start_date | datetime | ✔ | Start date (format: yyyy-mm-dd hh:mm:ss) \n| end_date | datetime | ✔ | End date (format: yyyy-mm-dd hh:mm:ss)\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"2020-06-01 00:00\": 1024,\n \"2020-06-01 01:00\": 1024,\n \"2020-06-01 02:00\": 1024,\n \"2020-06-01 03:00\": 1024,\n \"2020-06-01 04:00\": 1024,\n \"2020-06-01 05:00\": 1024,\n \"2020-06-01 06:00\": 1024,\n \"2020-06-01 07:00\": 1024,\n \"2020-06-01 08:00\": 1024,\n \"2020-06-01 09:00\": 1024,\n \"2020-06-01 10:00\": 1024,\n \"2020-06-01 11:00\": 1024,\n \"2020-06-01 12:00\": 1024,\n \"2020-06-01 13:00\": 1024,\n \"2020-06-01 14:00\": 1024,\n \"2020-06-01 15:00\": 1024,\n \"2020-06-01 16:00\": 1024,\n \"2020-06-01 17:00\": 1024,\n \"2020-06-01 18:00\": 1024,\n \"2020-06-01 19:00\": 1024,\n \"2020-06-01 20:00\": 1024,\n \"2020-06-01 21:00\": 1024,\n \"2020-06-01 22:00\": 1024,\n \"2020-06-01 23:00\": 1024\n },\n \"meta\": {\n \"group\": \"hourly\"\n },\n \"sum\": 24576\n}\n```"
},
"response": []
}
]
},
{
"name": "Guest Devices",
"description": "List and count devices associated with guests.",
"item": [
{
"name": "Get Guest Devices",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/guest-devices",
"host": [
"{{baseUrl}}"
],
"path": [
"guest-devices"
],
"variable": [],
"query": [
{
"key": "guest_id",
"value": "",
"description": "End-user ID",
"disabled": true
},
{
"key": "mac",
"value": "",
"description": "Guest device MAC address",
"disabled": true
},
{
"key": "online",
"value": "",
"description": "If the guest device is currently online or not. true / false",
"disabled": true
},
{
"key": "created_at",
"value": "",
"description": "Returns entries created after the entered date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "updated_at",
"value": "",
"description": "Returns entries updated after the entered date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "yas_id",
"value": "",
"description": "Yas ID",
"disabled": true
},
{
"key": "last_guest_device_first",
"value": "",
"description": "List most recent devices first. true/false",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of guest devices.\n\nPlease note that you cannot get more than 100 records per request. In case you need\nto get more than 100 records, then you should make more than one request.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| guest_id | string | End-user ID |\n| mac | string | Guest device MAC address |\n| online | boolean | If the guest device is currently online or not. true / false |\n| created_at | date | Returns entries created after the entered date (format: yyyy-mm-dd) |\n| updated_at | date | Returns entries updated after the entered date (format: yyyy-mm-dd) |\n| yas_id | string | Yas ID |\n| last_guest_device_first | boolean | List most recent devices first. true/false |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"id\": \"ApR3zO7zqeZ\",\n \"guest_id\": \"NgqovXZLDOy\",\n \"yas_id\": \"8f627d10-1abc-44d8-b964-a7816388173a\",\n \"type_name\": \"Desktop\",\n \"mac\": \"f4:5c:89:94:d4:2b\",\n \"ip\": \"95.6.16.57\",\n \"user_agent\": null,\n \"description\": \"Macintosh\",\n \"platform\": \"OS X\",\n \"browser\": \"Mozilla\",\n \"connection_status\": \"Offline\",\n \"connection_status_value\": 0,\n \"total_downloaded_data\": \"1.64 GB\",\n \"total_uploaded_data\": \"141.72 MB\",\n \"last_seen_time\": \"2017-02-14T10:27:46+00:00\",\n \"created_at\": \"2017-01-04T11:41:29+00:00\", \n \"updated_at\": \"2017-02-14T10:46:46+00:00\"\n }\n ],\n\n \"links\": {\n \"first\": \"[[BaseUrl]]/guest-devices?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"[[BaseUrl]]/guest-devices?page=2\"\n },\n\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"[[BaseUrl]]/guest-devices\",\n \"per_page\": 10,\n \"to\": 2\n }\n}\n```"
},
"response": []
},
{
"name": "Get Guest Device Count",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/guest-devices/count",
"host": [
"{{baseUrl}}"
],
"path": [
"guest-devices",
"count"
],
"variable": [],
"query": [
{
"key": "guest_id",
"value": "",
"description": "End-user ID",
"disabled": true
},
{
"key": "mac",
"value": "",
"description": "Guest device MAC address",
"disabled": true
},
{
"key": "online",
"value": "",
"description": "If the guest device is currently online or not. true / false",
"disabled": true
},
{
"key": "created_at",
"value": "",
"description": "Returns count of the entries created after the entered date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "updated_at",
"value": "",
"description": "Returns count of the entries updated after the entered date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "yas_id",
"value": "",
"description": "Yas ID",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the count of the guest devices.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| guest_id | string | End-user ID |\n| mac | string | Guest device MAC address |\n| online | boolean | If the guest device is currently online or not. true / false |\n| created_at | date | Returns count of the entries created after the entered date (format: yyyy-mm-dd) |\n| updated_at | date | Returns count of the entries updated after the entered date (format: yyyy-mm-dd) |\n| yas_id | string | Yas ID |\n\n### Response Example\n\n```json\n{\n \"count\": 1000\n}\n```"
},
"response": []
}
]
},
{
"name": "Guest Sessions",
"description": "Query guest session records including session counts and per-IP session duration details.",
"item": [
{
"name": "Get Guest Sessions",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/sessions",
"host": [
"{{baseUrl}}"
],
"path": [
"sessions"
],
"variable": [],
"query": [
{
"key": "guest_id",
"value": "",
"description": "End-user ID",
"disabled": true
},
{
"key": "location_id",
"value": "",
"description": "Location / Venue ID",
"disabled": true
},
{
"key": "guest_device_mac",
"value": "",
"description": "Guest device MAC address",
"disabled": true
},
{
"key": "start_time",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "end_time",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "yas_id",
"value": "",
"description": "Yas ID",
"disabled": true
},
{
"key": "online",
"value": "",
"description": "If the guest session is currently online or not. true / false",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of guest sessions.\n\nPlease note that you cannot get more than 100 records per request. In case you need\nto get more than 100 records, then you should make more than one request.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| guest_id | string | End-user ID |\n| location_id | string | Location / Venue ID |\n| guest_device_mac | string | Guest device MAC address |\n| start_time | date | Returns entries started after the entered starting date (format: yyyy-mm-dd) |\n| end_time | date | Returns entries ended before the entered ending date (format: yyyy-mm-dd) |\n| yas_id | string | Yas ID |\n| online | boolean | If the guest session is currently online or not. true / false |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"id\": \"pR3zOKmvzqe\",\n \"location_id\": \"oWNe6XWDPLM\",\n \"location_name\": \"IPERA\",\n \"guest_device_description\": \"WebKit\",\n \"guest_device_mac\": \"14:2d:27:e7:40:2b\",\n \"guest_device_ip\": \"172.31.98.114\",\n \"access_code\": \"\",\n \"login_type_name\": \"Registration\",\n \"service_profile_name\": \"Default Service Profile - 60 Minute(s)\",\n \"total_duration\": \"00:09:05\",\n \"downloaded_data\": \"3.34 MB\",\n \"uploaded_data\": \"900.58 kB\",\n \"connection_status\": \"Offline\",\n \"connection_status_value\": 0, \n \"start_time\": \"2017-01-05T06:50:55+00:00\",\n \"start_time_formatted\": \"2017-01-05 9:50 AM\",\n \"end_time\": \"2017-01-05T07:00:00+00:00\",\n \"end_time_formatted\": \"2017-01-05 10:00 AM\",\n \"guest_id\": \"ajKeDq4582W\",\n \"yas_id\": \"8f627d10-1abc-44d8-b964-a7816388173a\"\n }\n ],\n\n \"links\": {\n \"first\": \"[[BaseUrl]]/sessions?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"[[BaseUrl]]/sessions?page=2\"\n },\n\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"[[BaseUrl]]/sessions\",\n \"per_page\": 10,\n \"to\": 10\n }\n}\n```"
},
"response": []
},
{
"name": "Get Guest Session Count",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/sessions/count",
"host": [
"{{baseUrl}}"
],
"path": [
"sessions",
"count"
],
"variable": [],
"query": [
{
"key": "guest_id",
"value": "",
"description": "End-user ID",
"disabled": true
},
{
"key": "location_id",
"value": "",
"description": "Location / Venue ID",
"disabled": true
},
{
"key": "guest_device_mac",
"value": "",
"description": "Guest device MAC address",
"disabled": true
},
{
"key": "start_time",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "end_time",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "yas_id",
"value": "",
"description": "Yas ID",
"disabled": true
},
{
"key": "online",
"value": "",
"description": "If the guest session is currently online or not. true / false",
"disabled": true
},
{
"key": "last_session_first",
"value": "",
"description": "List most recent sessions first. true/false",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the count of the guest sessions.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| guest_id | string | End-user ID |\n| location_id | string | Location / Venue ID |\n| guest_device_mac | string | Guest device MAC address |\n| start_time | date | Returns entries started after the entered starting date (format: yyyy-mm-dd) |\n| end_time | date | Returns entries ended before the entered ending date (format: yyyy-mm-dd) |\n| yas_id | string | Yas ID |\n| online | boolean | If the guest session is currently online or not. true / false |\n| last_session_first | boolean | List most recent sessions first. true/false |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n\n### Response Example\n\n```json\n{\n \"count\": 1000\n}\n```"
},
"response": []
},
{
"name": "Get Guest Session Duration",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/sessions/:ip_address",
"host": [
"{{baseUrl}}"
],
"path": [
"sessions",
":ip_address"
],
"variable": [
{
"key": "ip_address",
"value": "",
"description": "ip_address identifier"
}
],
"query": [
{
"key": "ip_address",
"value": "",
"description": "Required. Guest IP address. To fetch multiple records, separate IPs with a comma (e.g., `10.1.1.5,10.1.1.6`).",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the details of the guest and session duration via the guest session IP address.\n\n**Note:** You can retrieve details for multiple sessions simultaneously by separating IP addresses with a comma (maximum 100 IPs). When multiple IPs are provided, the response will be an array of objects. For a single IP, the response is an object (for backward compatibility).\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n|------|------|-------------|\n| ip_address | string | Required. Guest IP address.
To fetch multiple records, separate IPs with a comma (e.g., `10.1.1.5,10.1.1.6`). |\n\n### Response Example\n\n```json\n{\n \"ip_address\": \"10.1.1.5\",\n \"username\": \"C6D144DE\",\n \"name\": \"Shagun Goel\",\n \"email\": \"shagun1486@outlook.com\",\n \"duration\": 42\n}\n```"
},
"response": []
}
]
},
{
"name": "Guests",
"description": "Core guest management. List, filter, retrieve, create, and update end-user profiles.",
"item": [
{
"name": "Get Guest List",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/guests",
"host": [
"{{baseUrl}}"
],
"path": [
"guests"
],
"variable": [],
"query": [
{
"key": "username",
"value": "",
"description": "Username",
"disabled": true
},
{
"key": "yas_id",
"value": "",
"description": "Yas ID",
"disabled": true
},
{
"key": "name",
"value": "",
"description": "Full name of end-user",
"disabled": true
},
{
"key": "email",
"value": "",
"description": "Email address",
"disabled": true
},
{
"key": "birth_date",
"value": "",
"description": "Date of birth (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "location_id",
"value": "",
"description": "Location / venue ID",
"disabled": true
},
{
"key": "gender",
"value": "",
"description": "Gender Values: male, female",
"disabled": true
},
{
"key": "phone",
"value": "",
"description": "Mobile / phone number",
"disabled": true
},
{
"key": "passport_no",
"value": "",
"description": "Passport number",
"disabled": true
},
{
"key": "nationality",
"value": "",
"description": "Nationality code. ISO 3166-1 alpha-2 country code",
"disabled": true
},
{
"key": "room_no",
"value": "",
"description": "Room number",
"disabled": true
},
{
"key": "reservation_no",
"value": "",
"description": "Reservation number",
"disabled": true
},
{
"key": "custom_field_1",
"value": "",
"description": "Custom field 1",
"disabled": true
},
{
"key": "custom_field_2",
"value": "",
"description": "Custom field 2",
"disabled": true
},
{
"key": "custom_field_3",
"value": "",
"description": "Custom field 3",
"disabled": true
},
{
"key": "online",
"value": "",
"description": "If the end-user is currently online or not. true / false",
"disabled": true
},
{
"key": "last_visit_date",
"value": "",
"description": "Filters guests by their last visit date. 1. **Single date (YYYY-MM-DD):** Returns end users visited from that date to 1 week after. 2. **Date range (YYYY-MM-DD,YYYY-MM-DD):** Returns end users visited within the specified interval (max 1 month).",
"disabled": true
},
{
"key": "receive_marketing",
"value": "",
"description": "The end users accepted receiving marketing messages Values 0: Opted-out, 1: Opted-in",
"disabled": true
},
{
"key": "created_at",
"value": "",
"description": "Returns entries created after the entered date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "updated_at",
"value": "",
"description": "Returns entries updated after the entered date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "last_guest_first",
"value": "",
"description": "List newly added users first. true/false",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
},
{
"key": "type",
"value": "",
"description": "People types null(not sent or empty): all 1: guest 2: employee",
"disabled": true
},
{
"key": "withBeacon",
"value": "",
"description": "Include beacon information in response. true/false",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of end-users.\n\nPlease note that you cannot get more than 100 records per request. In case you need\nto get more than 100 records, then you should make more than one request.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| username | string | Username |\n| yas_id | string | Yas ID |\n| name | string | Full name of end-user |\n| email | string | Email address |\n| birth_date | date | Date of birth (format: yyyy-mm-dd) |\n| location_id | string | Location / venue ID |\n| gender | string | Gender
Values: male, female |\n| phone | string | Mobile / phone number |\n| passport_no | string | Passport number |\n| nationality | string | Nationality code. ISO 3166-1 alpha-2 country code |\n| room_no | string | Room number |\n| reservation_no | string | Reservation number |\n| custom_field_1 | string | Custom field 1 |\n| custom_field_2 | string | Custom field 2 |\n| custom_field_3 | string | Custom field 3 |\n| online | boolean | If the end-user is currently online or not. true / false |\n| last_visit_date | date | Filters guests by their last visit date.
1. **Single date (YYYY-MM-DD):** Returns end users visited from that date to 1 week after.
2. **Date range (YYYY-MM-DD,YYYY-MM-DD):** Returns end users visited within the specified interval (max 1 month). |\n| receive_marketing | integer | The end users accepted receiving marketing messages
Values 0: Opted-out, 1: Opted-in |\n| created_at | date | Returns entries created after the entered date (format: yyyy-mm-dd) |\n| updated_at | date | Returns entries updated after the entered date (format: yyyy-mm-dd) |\n| last_guest_first | boolean | List newly added users first. true/false |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n| type | integer | People types
null(not sent or empty): all
1: guest
2: employee |\n| withBeacon | boolean | Include beacon information in response. true/false |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"id\": \"FBN2234\",\n \"username\": \"269FBDC5\",\n \"name\": \"Sally Brown\",\n \"email\": \"sbrown@iperasolutions.com\",\n \"birth_date\": \"1991-02-06\",\n \"gender\": \"female\",\n \"phone\": \"+13231123341\",\n \"passport_no\": null,\n \"nationality\": \"American\",\n \"nationality_code\": \"US\",\n \"residency\": \"United States\",\n \"residency_code\": \"US\",\n \"room_number\": null,\n \"reservation_no\": null,\n \"hotel_status\": null,\n \"facebook_id\": null,\n \"yas_id\": \"8f627d10-1abc-44d8-b964-a7816388173a\",\n \"custom_field_1\": null,\n \"custom_field_2\": null,\n \"custom_field_3\": null,\n \"online\": false,\n \"location_id\": \"92239FF342CA23\", \n \"location_name\": \"Dining East\",\n \"last_visit_date\": \"2016-01-21T11:41:39.000000Z\",\n \"last_attempt_time\": \"2016-01-21T11:41:39.000000Z\",\n \"visit_count\": 4,\n \"receive_marketing\": 0,\n \"last_login_type\": \"Registration\",\n \"connection_status\": 0,\n \"last_connection_time\": \"2016-01-21T11:41:39.000000Z\",\n \"last_ssid_name\": null,\n \"created_at\": \"2016-01-21T11:41:39.000000Z\",\n \"updated_at\": \"2016-01-22T07:29:58.000000Z\",\n \"tags\": [\n \"FC Barcelona\",\n \"FloorTag\",\n \"Real Madrid\"\n ],\n \"type\": 1,\n \"checkin_date\": null,\n \"checkout_date\": null\n }\n ],\n\n \"links\": {\n \"first\": \"[[BaseUrl]]/guests?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"[[BaseUrl]]/guests?page=2\"\n },\n\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"[[BaseUrl]]/guests\",\n \"per_page\": 10,\n \"to\": 10\n }\n}\n```"
},
"response": []
},
{
"name": "Get Guest Count",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/guests/count",
"host": [
"{{baseUrl}}"
],
"path": [
"guests",
"count"
],
"variable": [],
"query": [
{
"key": "username",
"value": "",
"description": "Username",
"disabled": true
},
{
"key": "yas_id",
"value": "",
"description": "Yas ID",
"disabled": true
},
{
"key": "name",
"value": "",
"description": "Full name of end-user",
"disabled": true
},
{
"key": "email",
"value": "",
"description": "Email address",
"disabled": true
},
{
"key": "birth_date",
"value": "",
"description": "Date of birth (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "location_id",
"value": "",
"description": "Location / venue ID",
"disabled": true
},
{
"key": "gender",
"value": "",
"description": "Gender Values: male, female",
"disabled": true
},
{
"key": "phone",
"value": "",
"description": "Mobile / phone number",
"disabled": true
},
{
"key": "passport_no",
"value": "",
"description": "Passport number",
"disabled": true
},
{
"key": "nationality",
"value": "",
"description": "Nationality code. ISO 3166-1 alpha-2 country code",
"disabled": true
},
{
"key": "room_no",
"value": "",
"description": "Room number",
"disabled": true
},
{
"key": "reservation_no",
"value": "",
"description": "Reservation number",
"disabled": true
},
{
"key": "custom_field_1",
"value": "",
"description": "Custom field 1",
"disabled": true
},
{
"key": "custom_field_2",
"value": "",
"description": "Custom field 2",
"disabled": true
},
{
"key": "custom_field_3",
"value": "",
"description": "Custom field 3",
"disabled": true
},
{
"key": "online",
"value": "",
"description": "If the end-user is currently online or not. true / false",
"disabled": true
},
{
"key": "last_visit_date",
"value": "",
"description": "Filters guests by their last visit date. 1. **Single date (YYYY-MM-DD):** Returns end users visited from that date to 1 week after. 2. **Date range (YYYY-MM-DD,YYYY-MM-DD):** Returns end users visited within the specified interval (max 1 month).",
"disabled": true
},
{
"key": "receive_marketing",
"value": "",
"description": "The end users accepted receiving marketing messages Values 0: Opted-out, 1: Opted-in",
"disabled": true
},
{
"key": "created_at",
"value": "",
"description": "Returns entries created after the entered date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "updated_at",
"value": "",
"description": "Returns entries updated after the entered date (format: yyyy-mm-dd)",
"disabled": true
},
{
"key": "last_guest_first",
"value": "",
"description": "List newly added users first. true/false",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
},
{
"key": "type",
"value": "",
"description": "People types null(not sent or empty): all 1: guest 2: employee",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the count of the guests\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| username | string | Username |\n| yas_id | string | Yas ID |\n| name | string | Full name of end-user |\n| email | string | Email address |\n| birth_date | date | Date of birth (format: yyyy-mm-dd) |\n| location_id | string | Location / venue ID |\n| gender | string | Gender
Values: male, female |\n| phone | string | Mobile / phone number |\n| passport_no | string | Passport number |\n| nationality | string | Nationality code. ISO 3166-1 alpha-2 country code |\n| room_no | string | Room number |\n| reservation_no | string | Reservation number |\n| custom_field_1 | string | Custom field 1 |\n| custom_field_2 | string | Custom field 2 |\n| custom_field_3 | string | Custom field 3 |\n| online | boolean | If the end-user is currently online or not. true / false |\n| last_visit_date | date | Filters guests by their last visit date.
1. **Single date (YYYY-MM-DD):** Returns end users visited from that date to 1 week after.
2. **Date range (YYYY-MM-DD,YYYY-MM-DD):** Returns end users visited within the specified interval (max 1 month). |\n| receive_marketing | integer | The end users accepted receiving marketing messages
Values 0: Opted-out, 1: Opted-in |\n| created_at | date | Returns entries created after the entered date (format: yyyy-mm-dd) |\n| updated_at | date | Returns entries updated after the entered date (format: yyyy-mm-dd) |\n| last_guest_first | boolean | List newly added users first. true/false |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n| type | integer | People types
null(not sent or empty): all
1: guest
2: employee |\n\n### Response Example\n\n```json\n{\n \"count\": 1000\n}\n```"
},
"response": []
},
{
"name": "Get Guest Details",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/guests/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"guests",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
],
"query": [
{
"key": "id",
"value": "",
"description": "End-user ID",
"disabled": true
}
]
},
"description": "You can get an end-user providing the corresponding ID.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| id | string | End-user ID |\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"id\": \"FBN2234\",\n \"username\": \"269FBDC5\",\n \"name\": \"Sally Brown\",\n \"first_name\": \"Sally\",\n \"last_name\": \"Brown\",\n \"email\": \"sbrown@iperasolutions.com\",\n \"birth_date\": \"1991-02-06\",\n \"gender\": 2,\n \"gender_name\": \"Female\",\n \"phone\": \"+13231123341\",\n \"passport_no\": null,\n \"nationality\": \"American\",\n \"nationality_code\": \"US\",\n \"residency\": \"United States\",\n \"residency_code\": \"US\",\n \"room_no\": null,\n \"reservation_no\": null,\n \"hotel_status\": null,\n \"facebook_id\": null,\n \"yas_id\": \"8f627d10-1abc-44d8-b964-a7816388173a\",\n \"custom_field_1\": null,\n \"custom_field_2\": null,\n \"custom_field_3\": null,\n \"online\": false,\n \"connection_status\": 0,\n \"connection_method\": \"\",\n \"total_downloaded_data\": 0,\n \"total_uploaded_data\": 0,\n \"last_connection_time\": \"2016-01-21T11:41:39.000000Z\",\n \"location_id\": \"92239FF342CA23\",\n \"location_name\": \"Dining East\",\n \"last_visit_date\": \"2016-01-21T11:41:39.000000Z\",\n \"last_attempt_time\": \"2016-01-21T11:41:39.000000Z\",\n \"visit_count\": 4,\n \"receive_marketing\": 0,\n \"checkin_date\": null,\n \"checkout_date\": null,\n \"direct_login\": 0,\n \"tags\": [],\n \"type\": 1,\n \"device_tags\": [],\n \"vendor\": null,\n \"last_ssid_name\": null,\n \"phone_verified_at\": null,\n \"whatsapp_verified_at\": null,\n \"email_verified_at\": null,\n \"smart_login\": \"Inactive\",\n \"image_url\": null,\n \"created_at\": \"2016-01-21T11:41:39.000000Z\",\n \"updated_at\": \"2016-01-22T07:29:58.000000Z\"\n },\n \"settings\": {\n \"disconnect_enabled\": true,\n \"name_registration_rule\": 1\n }\n}\n```"
},
"response": []
},
{
"name": "Create Guest",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/guests",
"host": [
"{{baseUrl}}"
],
"path": [
"guests"
],
"variable": []
},
"description": "Create a new guest with given credentials\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-|:-:|-----|\n| location_id | string | ✔️ | Location / venue ID |\n| name | string | | Full name of end-user |\n| email | string | | Email address. Must be unique for the same tenant |\n| birth_date | date | | Date of birth (format: yyyy-mm-dd) |\n| gender | string | | Gender
Values: male, female |\n| phone | string | | Mobile / phone number |\n| passport_no | string | | Passport number |\n| nationality | string | | Nationality code. ISO 3166-1 alpha-2 country code |\n| room_no | string | | Room number |\n| reservation_no | string | | Reservation number |\n| yas_id | string | | Yas ID |\n| marketing_consent | int | | 0: Opted-out, 1: Opted-in |\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"id\": \"FBN2234\",\n \"username\": \"269FBDC5\",\n \"name\": \"Sally Brown\",\n \"first_name\": \"Sally\",\n \"last_name\": \"Brown\",\n \"email\": \"sbrown@iperasolutions.com\",\n \"birth_date\": \"1991-02-06\",\n \"gender\": 2,\n \"gender_name\": \"Female\",\n \"phone\": \"+132311233411\",\n \"passport_no\": null,\n \"nationality\": \"American\",\n \"nationality_code\": \"US\",\n \"residency\": \"United States\",\n \"residency_code\": \"US\",\n \"room_no\": null,\n \"reservation_no\": null,\n \"hotel_status\": null,\n \"facebook_id\": null,\n \"yas_id\": \"8f627d10-1abc-44d8-b964-a7816388173a\",\n \"custom_field_1\": null,\n \"custom_field_2\": null,\n \"custom_field_3\": null,\n \"online\": false,\n \"connection_status\": 0,\n \"connection_method\": \"\",\n \"total_downloaded_data\": 0,\n \"total_uploaded_data\": 0,\n \"last_connection_time\": null,\n \"last_attempt_time\": null,\n \"last_ssid_name\": null,\n \"vendor\": null,\n \"location_id\": \"92239FF342CA23\",\n \"location_name\": \"Dining East\",\n \"last_visit_date\": \"2016-01-21T11:41:39.000000Z\",\n \"visit_count\": 4,\n \"receive_marketing\": 0,\n \"checkin_date\": null,\n \"checkout_date\": null,\n \"direct_login\": 0,\n \"tags\": [],\n \"device_tags\": [],\n \"type\": 1,\n \"phone_verified_at\": null,\n \"whatsapp_verified_at\": null,\n \"email_verified_at\": null,\n \"smart_login\": \"Inactive\",\n \"image_url\": null,\n \"created_at\": \"2016-01-21T11:41:39.000000Z\",\n \"updated_at\": \"2016-01-22T07:29:58.000000Z\"\n }\n}\n```",
"body": {
"mode": "raw",
"raw": "{\n \"location_id\": \"example\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "Update Guest",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/guests/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"guests",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
]
},
"description": "Update guest information\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-|:-:|-----|\n| :id | string | ✔️ | End-user ID |\n| location_id | string | ✔️ | Location / venue ID (required if user has guests.manage-global permission) |\n| name | string | | Full name of end-user (min 5 characters) |\n| first_name | string | | First name of end-user |\n| last_name | string | | Last name of end-user |\n| email | string | | Email address. Must be unique for the same tenant |\n| birth_date | date | | Date of birth (format: yyyy-mm-dd). Also accepts `birthday` |\n| gender | integer | | Gender
0: Unknown, 1: Male, 2: Female |\n| phone | string | | Mobile / phone number |\n| passport_no | string | | Passport number |\n| nationality | string | | Nationality code. ISO 3166-1 alpha-2 country code (2 characters) |\n| residency | string | | Residency code. ISO 3166-1 alpha-2 country code (2 characters) |\n| room_no | integer | | Room number (1-9999) |\n| reservation_no | string | | Reservation number |\n| hotel_status | integer | | Hotel status
null: N/A, 0: Check-out, 1: Check-in |\n| custom_data | string | | Custom data (JSON string) |\n| custom_field_1 | string | | Custom field 1 |\n| custom_field_2 | string | | Custom field 2 |\n| custom_field_3 | string | | Custom field 3 |\n| direct_login | integer | | Direct login status
0: Disabled, 1: Enabled |\n| tags | array | | Array of tag names to assign to guest |\n| tag_type | integer | | Tag type |\n| marketing_consent | integer | | 0: Opted-out, 1: Opted-in |\n| avatar | file | | Avatar image file (max 2048 KB) |\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"id\": \"FBN2234\",\n \"username\": \"269FBDC5\",\n \"name\": \"Sally Brown\",\n \"first_name\": \"Sally\",\n \"last_name\": \"Brown\",\n \"email\": \"sbrown@iperasolutions.com\",\n \"birth_date\": \"1991-02-06\",\n \"gender\": 2,\n \"gender_name\": \"Female\",\n \"phone\": \"+13231123341\",\n \"passport_no\": null,\n \"nationality\": \"American\",\n \"nationality_code\": \"US\",\n \"residency\": \"United States\",\n \"residency_code\": \"US\",\n \"room_no\": null,\n \"reservation_no\": null,\n \"hotel_status\": null,\n \"facebook_id\": null,\n \"yas_id\": \"8f627d10-1abc-44d8-b964-a7816388173a\",\n \"custom_field_1\": null,\n \"custom_field_2\": null,\n \"custom_field_3\": null,\n \"online\": false,\n \"connection_status\": 0,\n \"connection_method\": \"\",\n \"total_downloaded_data\": 0,\n \"total_uploaded_data\": 0,\n \"last_connection_time\": null,\n \"last_attempt_time\": null,\n \"last_ssid_name\": null,\n \"vendor\": null,\n \"location_id\": \"92239FF342CA23\",\n \"location_name\": \"Dining East\",\n \"last_visit_date\": \"2016-01-21T11:41:39.000000Z\",\n \"visit_count\": 4,\n \"receive_marketing\": 0,\n \"checkin_date\": null,\n \"checkout_date\": null,\n \"direct_login\": 0,\n \"tags\": [],\n \"device_tags\": [],\n \"type\": 1,\n \"phone_verified_at\": null,\n \"whatsapp_verified_at\": null,\n \"email_verified_at\": null,\n \"smart_login\": \"Inactive\",\n \"image_url\": null,\n \"created_at\": \"2016-01-21T11:41:39.000000Z\",\n \"updated_at\": \"2016-01-22T07:29:58.000000Z\"\n }\n}\n```",
"body": {
"mode": "raw",
"raw": "{\n \"location_id\": \"example\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
}
]
},
{
"name": "Location Analytics",
"description": "Real-time and historical location presence data, session logs, and location-level activity tracking.",
"item": [
{
"name": "Get Active Sessions",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations-analytics/active-sessions",
"host": [
"{{baseUrl}}"
],
"path": [
"locations-analytics",
"active-sessions"
],
"variable": [],
"query": [
{
"key": "location_id",
"value": "",
"description": "Filter by location/venue ID",
"disabled": true
},
{
"key": "building_id",
"value": "",
"description": "Filter by building ID",
"disabled": true
},
{
"key": "floor_id",
"value": "",
"description": "Filter by floor ID",
"disabled": true
},
{
"key": "zone_id",
"value": "",
"description": "Filter by zone ID",
"disabled": true
},
{
"key": "segment_id",
"value": "",
"description": "Filter by guest segment/tag ID",
"disabled": true
},
{
"key": "data_type",
"value": "",
"description": "Filter by data type (1=WiFi, 2=BLE)",
"disabled": true
},
{
"key": "connected",
"value": "",
"description": "Filter by connection status. Use 1 to retrieve only currently connected users.0 for disconnected users",
"disabled": true
}
]
},
"description": "Get real-time location presence data for all currently active sessions. This endpoint returns information about guests currently present at locations, including their latest position coordinates from the location tracking system.\n\nThis endpoint returns **all active sessions** without pagination for real-time monitoring dashboards.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n|-------------|---------|--------------------------------------------------------------------------------------------------------|\n| location_id | string | Filter by location/venue ID |\n| building_id | string | Filter by building ID |\n| floor_id | string | Filter by floor ID |\n| zone_id | string | Filter by zone ID |\n| segment_id | string | Filter by guest segment/tag ID |\n| data_type | integer | Filter by data type (1=WiFi, 2=BLE) |\n| connected | integer | Filter by connection status. Use 1 to retrieve only currently connected users.0 for disconnected users |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"mac_address\": \"AA:BB:CC:DD:EE:FF\",\n \"data_type\": 1,\n \"x\": 123.45,\n \"y\": 678.90,\n \"location_id\": \"x1Y2z3A4b5C\",\n \"location\": \"Main Campus\",\n \"building_id\": \"a2B3c4D5e6F\",\n \"building\": \"Building A\",\n \"floor_id\": \"f7G8h9I0j1K\",\n \"floor\": \"Floor 1\",\n \"zone_id\": \"z2L3m4N5o6P\",\n \"zone\": \"Lobby\",\n \"gender\": \"Male\",\n \"nationality\": \"US\",\n \"country_of_residency\": \"CA\",\n \"guest_id\": \"g8Q9r0S1t2U\",\n \"segment\": [\n {\n \"id\": \"s3V4w5X6y7Z\",\n \"name\": \"VIP\"\n }\n ],\n \"last_seen\": \"2025-10-17T10:30:00.000000Z\",\n \"connected\": 1\n },\n {\n \"mac_address\": \"11:22:33:44:55:66\",\n \"data_type\": 2,\n \"x\": null,\n \"y\": null,\n \"location_id\": \"x1Y2z3A4b5C\",\n \"location\": \"Main Campus\",\n \"building_id\": null,\n \"building\": null,\n \"floor_id\": null,\n \"floor\": null,\n \"zone_id\": null,\n \"zone\": null,\n \"gender\": null,\n \"nationality\": null,\n \"country_of_residency\": null,\n \"guest_id\": null,\n \"segment\": [],\n \"last_seen\": \"2025-10-17T10:25:00.000000Z\",\n \"connected\": 0\n }\n ]\n}\n```"
},
"response": []
},
{
"name": "Get Location Sessions",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations-analytics/sessions",
"host": [
"{{baseUrl}}"
],
"path": [
"locations-analytics",
"sessions"
],
"variable": [],
"query": [
{
"key": "guest_id",
"value": "",
"description": "Guest ID",
"disabled": true
},
{
"key": "location_id",
"value": "",
"description": "Location / Venue ID",
"disabled": true
},
{
"key": "mac",
"value": "",
"description": "Guest device MAC address",
"disabled": true
},
{
"key": "started_at",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd hh:ii)",
"disabled": true
},
{
"key": "ended_at",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd hh:ii)",
"disabled": true
},
{
"key": "visit_type",
"value": "",
"description": "Visit type",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
}
]
},
"description": "This endpoint is **deprecated** and will be removed in a future version. Please use `/locations-analytics/active-sessions` instead with the `connected=1` filter to get active connected sessions.\n\n**Replacement:** `GET /locations-analytics/active-sessions?connected=1` \n**Sunset Date:** June 1, 2026\n\nBy using this API endpoint, it is possible to get the list of location sessions.\n\nPlease note that you cannot get more than 100 records per request. In case you need\nto get more than 100 records, then you should make more than one request.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| guest_id | string | Guest ID |\n| location_id | string | Location / Venue ID |\n| mac | string | Guest device MAC address |\n| started_at | date | Returns entries started after the entered starting date (format: yyyy-mm-dd hh:ii) |\n| ended_at | date | Returns entries ended before the entered ending date (format: yyyy-mm-dd hh:ii) |\n| visit_type | integer | Visit type |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"id\": \"pR3zOKmvzqe\",\n \"guest_id\": \"VGBzq2o1XQ5\",\n \"location_id\": \"1kgXJ6RXN9D\",\n \"mac\": \"74:e5:0b:10:c2:cc\",\n \"started_at\": \"2017-10-24T13:11:25.000000Z\",\n \"ended_at\": \"2017-10-24T18:11:25.000000Z\",\n \"duration\": \"600\",\n \"visit_type\": 1\n }\n ],\n\n \"links\": {\n \"first\": \"[[BaseUrl]]/locations-analytics/sessions?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"[[BaseUrl]]/locations-analytics/sessions?page=2\"\n },\n\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"[[BaseUrl]]/locations-analytics/sessions\",\n \"per_page\": 10,\n \"to\": 10\n }\n}\n```"
},
"response": []
},
{
"name": "Get Location Sessions Count",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations-analytics/sessions/count",
"host": [
"{{baseUrl}}"
],
"path": [
"locations-analytics",
"sessions",
"count"
],
"variable": [],
"query": [
{
"key": "guest_id",
"value": "",
"description": "Guest ID",
"disabled": true
},
{
"key": "location_id",
"value": "",
"description": "Location / Venue ID",
"disabled": true
},
{
"key": "mac",
"value": "",
"description": "Guest device MAC address",
"disabled": true
},
{
"key": "started_at",
"value": "",
"description": "Returns entries started after the entered starting date (format: yyyy-mm-dd hh:ii)",
"disabled": true
},
{
"key": "ended_at",
"value": "",
"description": "Returns entries ended before the entered ending date (format: yyyy-mm-dd hh:ii)",
"disabled": true
},
{
"key": "visit_type",
"value": "",
"description": "Visit type",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
}
]
},
"description": "This endpoint is **deprecated** and will be removed in a future version. Please use `/locations-analytics/active-sessions` instead and count the results client-side, or use the active-sessions endpoint with appropriate filters.\n\n**Replacement:** `GET /locations-analytics/active-sessions` (count results client-side) \n**Sunset Date:** June 1, 2026\n\nBy using this API endpoint, it is possible to get the count of location sessions.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| guest_id | string | Guest ID |\n| location_id | string | Location / Venue ID |\n| mac | string | Guest device MAC address |\n| started_at | date | Returns entries started after the entered starting date (format: yyyy-mm-dd hh:ii) |\n| ended_at | date | Returns entries ended before the entered ending date (format: yyyy-mm-dd hh:ii) |\n| visit_type | integer | Visit type |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n\n### Response Example\n\n```json\n{\n \"count\": 1000\n}\n```"
},
"response": []
},
{
"name": "Get Location Session Details",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations-analytics/sessions/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"locations-analytics",
"sessions",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
],
"query": [
{
"key": "id",
"value": "",
"description": "location ID",
"disabled": true
}
]
},
"description": "Get location session details.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| id | string | location ID |\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"id\": \"pR3zOKmvzqe\",\n \"guest_id\": \"VGBzq2o1XQ5\",\n \"location_id\": \"1kgXJ6RXN9D\",\n \"mac\": \"74:e5:0b:10:c2:cc\",\n \"started_at\": \"2017-10-24T13:11:25.000000Z\",\n \"ended_at\": \"2017-10-24T18:11:25.000000Z\",\n \"duration\": \"600\",\n \"visit_type\": 1\n }\n}\n```"
},
"response": []
},
{
"name": "Get Location Logs",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations-analytics/location-logs",
"host": [
"{{baseUrl}}"
],
"path": [
"locations-analytics",
"location-logs"
],
"variable": [],
"query": [
{
"key": "guest_id",
"value": "",
"description": "Guest ID",
"disabled": true
},
{
"key": "guest_mac",
"value": "",
"description": "Guest MAC address",
"disabled": true
},
{
"key": "session_id",
"value": "",
"description": "Session ID of the log",
"disabled": true
},
{
"key": "zone_id",
"value": "",
"description": "Zone ID",
"disabled": true
},
{
"key": "timestamp",
"value": "",
"description": "Returns entries created after the entered timestamp (format: yyyy-mm-dd hh:ii)",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
}
]
},
"description": "This endpoint is **deprecated** and will be removed in a future version. Please use `/locations-analytics/active-sessions` for real-time location data instead.\n\n**Replacement:** `GET /locations-analytics/active-sessions` \n**Sunset Date:** June 1, 2026\n\nBy using this API endpoint, it is possible to get the list of location logs.\n\nPlease note that you cannot get more than 100 records per request. In case you need\nto get more than 100 records, then you should make more than one request.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| guest_id | string | Guest ID |\n| guest_mac | string | Guest MAC address |\n| session_id | string | Session ID of the log |\n| zone_id | string | Zone ID |\n| timestamp | date | Returns entries created after the entered timestamp (format: yyyy-mm-dd hh:ii) |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"guest_id\": \"VGBzq2o1XQ5\",\n \"guest_mac\": \"74:e5:0b:10:c2:cc\",\n \"session_id\": \"Zk5reDj6baK\",\n \"zone_id\": \"pR3zOKmvzqe\",\n \"timestamp\": \"2017-10-24T13:11:25.000000Z\",\n \"duration\": \"600\"\n },\n {\n \"guest_id\": \"DEFzq2o1XQ5\",\n \"guest_mac\": \"82:g6:0b:10:c2:dd\",\n \"session_id\": \"9apvYXJr5l0\",\n \"zone_id\": \"p79zOKmecq1\",\n \"timestamp\": \"2017-10-24T13:11:25.000000Z\",\n \"duration\": \"400\"\n }\n ],\n\n \"links\": {\n \"first\": \"[[BaseUrl]]/locations-analytics/location-logs?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"[[BaseUrl]]/locations-analytics/location-logs?page=2\"\n },\n\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"[[BaseUrl]]/locations-analytics/location-logs\",\n \"per_page\": 10,\n \"to\": 10\n }\n}\n```"
},
"response": []
},
{
"name": "Get Location Logs Count",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations-analytics/location-logs/count",
"host": [
"{{baseUrl}}"
],
"path": [
"locations-analytics",
"location-logs",
"count"
],
"variable": [],
"query": [
{
"key": "guest_id",
"value": "",
"description": "Guest ID",
"disabled": true
},
{
"key": "guest_mac",
"value": "",
"description": "Guest MAC address",
"disabled": true
},
{
"key": "session_id",
"value": "",
"description": "Session ID of the log",
"disabled": true
},
{
"key": "zone_id",
"value": "",
"description": "Zone ID",
"disabled": true
},
{
"key": "timestamp",
"value": "",
"description": "Returns entries created after the entered timestamp (format: yyyy-mm-dd hh:ii)",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
}
]
},
"description": "This endpoint is **deprecated** and will be removed in a future version. Please use `/locations-analytics/active-sessions` instead and count the results client-side.\n\n**Replacement:** `GET /locations-analytics/active-sessions` (count results client-side) \n**Sunset Date:** June 1, 2026\n\nBy using this API endpoint, it is possible to get the count of the location logs.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| guest_id | string | Guest ID |\n| guest_mac | string | Guest MAC address |\n| session_id | string | Session ID of the log |\n| zone_id | string | Zone ID |\n| timestamp | date | Returns entries created after the entered timestamp (format: yyyy-mm-dd hh:ii) |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n\n### Response Example\n\n```json\n{\n \"count\": 1000\n}\n```"
},
"response": []
}
]
},
{
"name": "Locations",
"description": "Manage venue and location records — list, count, hierarchy, create, and update.",
"item": [
{
"name": "Get Location List",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations",
"host": [
"{{baseUrl}}"
],
"path": [
"locations"
],
"variable": [],
"query": [
{
"key": "name",
"value": "",
"description": "Filter by location name (performs text search)",
"disabled": true
},
{
"key": "status",
"value": "",
"description": "Filter by status (0: Active, 1: Trashed). If status=1, returns trashed locations",
"disabled": true
},
{
"key": "page",
"value": "",
"description": "Page number to be returned",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get list of locations that are\ncreated under a Tenant. Tenant represents customer and Locations represent their\nvenues / branches / stores / physical locations.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| name | string | Filter by location name (performs text search) |\n| status | integer | Filter by status (0: Active, 1: Trashed). If status=1, returns trashed locations |\n| page | integer | Page number to be returned |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"id\": \"ZV4NljAPlq5\",\n \"name\": \"Costa Jeddah Street\",\n \"description\": \"\",\n \"login_page_name\": \"Prelogin (Live)\",\n \"login_page_id\": \"MmOPgO4P26x\",\n \"post_login_page_name\": \"Postlogin (Live)\",\n \"post_login_page_id\": \"elka5Y9aBn2\",\n \"is_trashed\": false\n }\n ],\n\n \"links\": {\n \"first\": \"[[BaseUrl]]/locations?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"[[BaseUrl]]/locations?page=2\"\n },\n\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"[[BaseUrl]]/locations\",\n \"per_page\": 10,\n \"to\": 1\n }\n}\n```"
},
"response": []
},
{
"name": "Get Location Count",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations/count",
"host": [
"{{baseUrl}}"
],
"path": [
"locations",
"count"
],
"variable": [],
"query": [
{
"key": "name",
"value": "",
"description": "Filter by location name (performs text search)",
"disabled": true
},
{
"key": "status",
"value": "",
"description": "Filter by status (0: Active, 1: Trashed). If status=1, returns trashed locations",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the count of the locations that are\ncreated under a Tenant.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| name | string | Filter by location name (performs text search) |\n| status | integer | Filter by status (0: Active, 1: Trashed). If status=1, returns trashed locations |\n\n### Response Example\n\n```json\n{\n \"count\": 1000\n}\n```"
},
"response": []
},
{
"name": "Get Location Hierarchy",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations/hierarchy",
"host": [
"{{baseUrl}}"
],
"path": [
"locations",
"hierarchy"
],
"variable": [],
"query": [
{
"key": "location_id",
"value": "",
"description": "Filter by specific location ID",
"disabled": true
},
{
"key": "name",
"value": "",
"description": "Filter by location name (performs text search)",
"disabled": true
},
{
"key": "with_coordinates",
"value": "",
"description": "Include coordinates in zone data. 1: Include, 0: Exclude (default)",
"disabled": true
},
{
"key": "scale_floor_dimensions",
"value": "",
"description": "Scale floor dimensions if grid count exceeds 3000. 1: Scale, 0: Don't scale (default)",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get list of location hierarchy.\nApi endpoint returns width and height data as meter.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| location_id | string | Filter by specific location ID |\n| name | string | Filter by location name (performs text search) |\n| with_coordinates | integer | Include coordinates in zone data. 1: Include, 0: Exclude (default) |\n| scale_floor_dimensions | integer | Scale floor dimensions if grid count exceeds 3000. 1: Scale, 0: Don't scale (default) |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"id\": \"ZV4NljAPlq5\",\n \"name\": \"West Location\",\n \"lat\": \"24.5013014\",\n \"lng\": \"54.3897024\",\n \"buildings\" : [\n {\n \"id\": \"TV5NYkjLq8\",\n \"name\": \"West Building\",\n \"lat\": \"41\",\n \"lng\": \"29\",\n \"floors\": [\n {\n \"id\": \"pXYG90jQnzk\",\n \"name\": \"West Floor F1\",\n \"image\": {\n \"name\": \"[[BaseUrl]]/a/18_JdQRLpk6WGk/img/maps/Tmsöfdösn4sdfsfdsfsd.png\",\n \"width\": 5000,\n \"height\": 3200\n },\n \"dimensions\": {\n \"width\": 200,\n \"length\": 200\n },\n \"zones\": [] \n },\n {\n \"id\": \"gep9lKOma16\",\n \"name\": \"West Floor F2\",\n \"image\": {\n \"name\": \"[[BaseUrl]]/a/14_KLFDnldt5W9/img/maps/Kkjndfskfksbsdf.png\",\n \"width\": 4500,\n \"height\": 3600\n },\n \"dimensions\": {\n \"width\": 220,\n \"length\": 192\n },\n \"zones\": [\n {\n \"id\": \"Gvk9ZeDmPrV\",\n \"name\": \"West Zone Z1\"\n }\n ] \n } \n ] \n }\n ]\n }\n ]\n}\n```"
},
"response": []
},
{
"name": "Create Location",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations",
"host": [
"{{baseUrl}}"
],
"path": [
"locations"
],
"variable": []
},
"description": "Create a new location with given attributes.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-|:-:|-----|\n| name | string | ✔ | Name of the location. Max 50 characters. Must be unique for the tenant. |\n| country_code | string | | Country code. ISO 3166-1 alpha-2 country code. |\n| city | string | | City of the location. |\n| address | string | | Address of the location. Max 255 characters. |\n| post_code | string | | Post code of the location. |\n| description | string | | Description. |\n| lat | float | | Latitude coordinate |\n| lng | float | | Longitude coordinate |\n| smart_login | integer | | Smart login enabled or not. null: Inherit, 0: Disabled, 1: Enabled. |\n| smart_login_frequency | integer | | Smart login frequency. Required if smart_login=1. Min. 1 |\n| smart_login_frequency_type | integer | | Smart login frequency unit. Required if smart_login=1. 2: Hours, 3: Days |\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"id\": \"ZOpo383vB8X\",\n \"name\": \"Convert Venue\",\n \"description\": \"Optional description.\",\n \"address\": \"115 East 23rd Street 5th Floor\",\n \"post_code\": \"84500\",\n \"city\": \"Dubai\",\n \"state\": null,\n \"country_code\": \"AE\",\n \"lat\": 25.6428852,\n \"lng\": 55.1966358,\n \"is_trashed\": false\n }\n}\n```",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"example\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "Update Location",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/locations/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"locations",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
]
},
"description": "Update location information.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-|:-:|-----|\n| :id | string | ✔ | Location ID |\n| name | string | ✔ | Name of the location. Max 50 characters. Must be unique for the tenant. |\n| country_code | string | | Country code. ISO 3166-1 alpha-2 country code. |\n| city | string | | City of the location. |\n| address | string | | Address of the location. Max 255 characters. |\n| post_code | string | | Post code of the location. |\n| description | string | | Description. |\n| lat | float | | Latitude coordinate |\n| lng | float | | Longitude coordinate |\n| smart_login | integer | | Smart login enabled or not. null: Inherit, 0: Disabled, 1: Enabled. |\n| smart_login_frequency | integer | | Smart login frequency. Required if smart_login=1. Min. 1 |\n| smart_login_frequency_type | integer | | Smart login frequency unit. Required if smart_login=1. 2: Hours, 3: Days |\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"id\": \"ZOpo383vB8X\",\n \"name\": \"Convert Venue\",\n \"description\": \"Optional description.\",\n \"address\": \"115 East 23rd Street 5th Floor\",\n \"post_code\": \"84500\",\n \"city\": \"Dubai\",\n \"state\": null,\n \"country_code\": \"AE\",\n \"lat\": 25.6428852,\n \"lng\": 55.1966358,\n \"is_trashed\": false\n }\n}\n```",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"example\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
}
]
},
{
"name": "Tenants",
"description": "Multi-tenant management. List, create, update, activate, deactivate, and switch between tenants.",
"item": [
{
"name": "Get Tenant List",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/tenants",
"host": [
"{{baseUrl}}"
],
"path": [
"tenants"
],
"variable": [],
"query": [
{
"key": "name",
"value": "",
"description": "Full name of the tenant",
"disabled": true
},
{
"key": "description",
"value": "",
"description": "Description of tenant. It performs a text search.",
"disabled": true
},
{
"key": "page",
"value": "",
"description": "Page number to be returned.",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of tenants.\n\nPlease note that you cannot get more than 100 records per request. In case you need\nto get more than 100 records, then you should make more than one request.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| name | string | Full name of the tenant |\n| description | string | Description of tenant. It performs a text search. |\n| page | integer | Page number to be returned. |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"id\": \"QZOpo3GoB8X\",\n \"name\": \"Company\",\n \"address\": \"115 East 23rd Street 5th Floor\",\n \"city\": \"New York\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"description\": \"New York\",\n \"is_trashed\": false,\n \"group_id\": \"0\",\n \"group_name\": \"\"\n },\n ...\n ],\n \"links\": {\n \"first\": \"[[BaseUrl]]/tenants?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"[[BaseUrl]]/tenants?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"[[BaseUrl]]/tenants\",\n \"per_page\": 10,\n \"to\": 10\n }\n}\n```"
},
"response": []
},
{
"name": "Get Tenant Count",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/tenants/count",
"host": [
"{{baseUrl}}"
],
"path": [
"tenants",
"count"
],
"variable": [],
"query": [
{
"key": "name",
"value": "",
"description": "Full name of the tenant",
"disabled": true
},
{
"key": "description",
"value": "",
"description": "Description of tenant. It performs a text search.",
"disabled": true
},
{
"key": "page",
"value": "",
"description": "Page number to be returned.",
"disabled": true
},
{
"key": "per_page",
"value": "",
"description": "The number of records returned. Default is 10, maximum is 100",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the count of the tenants.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| name | string | Full name of the tenant |\n| description | string | Description of tenant. It performs a text search. |\n| page | integer | Page number to be returned. |\n| per_page | integer | The number of records returned. Default is 10, maximum is 100 |\n\n### Response Example\n\n```json\n{\n \"count\": 1000\n}\n```"
},
"response": []
},
{
"name": "Create Tenant",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/tenants",
"host": [
"{{baseUrl}}"
],
"path": [
"tenants"
],
"variable": []
},
"description": "Create a new tenant with given attributes. After creating, following are done automatically.\n\n- API user is moved to the new tenant. See Switch Tenant.\n- A default location is created.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-|:-:|-----|\n| name | string | ✔ | Name of the tenant. Min. 5 characters. |\n| country_code | string | | Country code. ISO 3166-1 alpha-2 country code. |\n| city | string | | City of the tenant. |\n| address | string | | Address of the tenant. |\n| post_code | string | | Post code of the tenant. |\n| description | string | | Description. |\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"id\": \"QZOpo3GoB8X\",\n \"name\": \"Company\",\n \"address\": \"115 East 23rd Street 5th Floor\",\n \"city\": \"New York\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"description\": \"New York\",\n \"is_trashed\": false\n }\n}\n```",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"example\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "Update Tenant",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/tenants/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"tenants",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
]
},
"description": "Update tenant information.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-|:-:|-----|\n| name | string | ✔ | Name of the tenant. Min. 5 characters. |\n| country_code | string | | Country code. ISO 3166-1 alpha-2 country code. |\n| city | string | | City of the tenant. |\n| address | string | | Address of the tenant. |\n| post_code | string | | Post code of the tenant. |\n| description | string | | Description. |\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"id\": \"QZOpo3GoB8X\",\n \"name\": \"Company\",\n \"address\": \"115 East 23rd Street 5th Floor\",\n \"city\": \"New York\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"description\": \"New York\",\n \"is_trashed\": false\n }\n}\n```",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"example\"\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "Deactivate Tenant",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/tenants/:id/deactivate",
"host": [
"{{baseUrl}}"
],
"path": [
"tenants",
":id",
"deactivate"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
]
},
"description": "Deactivate given tenant.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-|:-:|-----|\n| user_status | int | | Set status of the users belong to the tenant to this value after deactivation. 0: Passive, 1: Active, 2: Banned.
Note: This does not affect support users. |\n\n### Response Example\n\n```json\n{\n \"is_trashed\": true\n}\n```",
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "Activate Tenant",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/tenants/:id/activate",
"host": [
"{{baseUrl}}"
],
"path": [
"tenants",
":id",
"activate"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
]
},
"description": "Activate given tenant.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-|:-:|-----|\n| user_status | int | | Set status of the users belong to the tenant to this value after activation. 0: Passive, 1: Active, 2: Banned.
Note: This does not affect support users. |\n\n### Response Example\n\n```json\n{\n \"is_trashed\": false\n}\n```",
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "Switch Tenant",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/tenants/:id/switch",
"host": [
"{{baseUrl}}"
],
"path": [
"tenants",
":id",
"switch"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
]
},
"description": "Switches tenant of the API user.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Response Example\n\n```json\n{\n \"success\": true\n}\n```",
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
}
]
},
{
"name": "Users",
"description": "Manage API and portal user accounts — list, create, update, activate, and deactivate.",
"item": [
{
"name": "Get User List",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"variable": [],
"query": [
{
"key": "name",
"value": "",
"description": "Name of the user. Performs text-search.",
"disabled": true
},
{
"key": "email",
"value": "",
"description": "Email of the user. Performs text-search.",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the list of users.\n\nPlease note that you cannot get more than 100 records per request. In case you need\nto get more than 100 records, then you should make more than one request.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| name | string | Name of the user. Performs text-search. |\n| email | string | Email of the user. Performs text-search. |\n\n### Response Example\n\n```json\n{\n \"data\": [\n {\n \"id\": \"QZOpo3GoB8X\",\n \"user_id\": 123,\n \"name\": \"John Doe\",\n \"username\": \"johndoe\",\n \"user_type\": 1,\n \"user_type_name\": \"Platform\",\n \"email\": \"john@doe.com\",\n \"role\": \"support\",\n \"role_name\": \"Support\",\n \"current_tenant_name\": \"Company\",\n \"current_tenant_id\": \"QZOpo3GoB8X\",\n \"location_id\": \"ZOpo383vB8X\",\n \"location_name\": \"Venue\",\n \"status\": 1,\n \"is_trashed\": false,\n \"locale\": \"en\"\n },\n ...\n ],\n \"links\": {\n \"first\": \"[[BaseUrl]]/users?page=1\",\n \"last\": null,\n \"prev\": null,\n \"next\": \"[[BaseUrl]]/users?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"path\": \"[[BaseUrl]]/users\",\n \"per_page\": 10,\n \"to\": 2,\n }\n}\n```"
},
"response": []
},
{
"name": "Get User Count",
"request": {
"method": "GET",
"header": [],
"url": {
"raw": "{{baseUrl}}/users/count",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
"count"
],
"variable": [],
"query": [
{
"key": "name",
"value": "",
"description": "Name of the user. Performs text-search.",
"disabled": true
},
{
"key": "email",
"value": "",
"description": "Email of the user. Performs text-search.",
"disabled": true
}
]
},
"description": "By using this API endpoint, it is possible to get the count of the users.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Description |\n| ------------- |-------------|-----|\n| name | string | Name of the user. Performs text-search. |\n| email | string | Email of the user. Performs text-search. |\n\n### Response Example\n\n```json\n{\n \"count\": 1000\n}\n```"
},
"response": []
},
{
"name": "Create User",
"request": {
"method": "POST",
"header": [],
"url": {
"raw": "{{baseUrl}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"users"
],
"variable": []
},
"description": "Create a new user with given attributes.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-|:-:|-----|\n| name | string | ✔ | Name of the user. Min. 5 characters. |\n| email | string | ✔ | Email of the user. |\n| role | string | ✔ | Role of the user. tenant: Tenant Admin, venue: Venue Admin, front-desk: Front Desk |\n| password | string | ✔ | Password of the user. 8 - 30 characters in length and include a number, a symbol, an upper case letter, a lower case letter. |\n| password_confirmation | string | ✔ | Password confirmation. Must be same with password field. |\n| status | int | ✔ | Status of the user. 0: Passive, 1: Active, 2: Banned |\n| location_id | string | | Location of the user. Required if user's role is Venue Admin or Front Desk |\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"id\": \"MO92vaXoe3a\",\n \"user_id\": 456,\n \"name\": \"John Doe\",\n \"username\": \"johndoe\",\n \"user_type\": 1,\n \"user_type_name\": \"Platform\",\n \"email\": \"john@examplet.com\",\n \"role\": \"front-desk\",\n \"role_name\": \"Front Desk\",\n \"current_tenant_name\": \"Company\",\n \"current_tenant_id\": \"QZOpo3GoB8X\",\n \"location_id\": \"N1L5ead5j7p\",\n \"location_name\": \"Concert Venue\",\n \"status\": 1,\n \"is_trashed\": false,\n \"locale\": \"en\",\n \"api_token\": null\n }\n}\n```",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"example\",\n \"email\": \"example\",\n \"role\": \"example\",\n \"password\": \"example\",\n \"password_confirmation\": \"example\",\n \"status\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "Update User",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/users/:id",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":id"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
]
},
"description": "Update user information.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.\n\n### Parameters\n\n| Name | Type | Required | Description |\n| ------------- |-|:-:|-----|\n| name | string | ✔ | Name of the user. Min. 5 characters. |\n| email | string | ✔ | Email of the user. |\n| role | string | ✔ | Role of the user. tenant: Tenant Admin, venue: Venue Admin, front-desk: Front Desk |\n| status | int | ✔ | Status of the user. 0: Passive, 1: Active, 2: Banned |\n| password | string | | Password of the user. 8 - 30 characters in length and include a number, a symbol, an upper case letter, a lower case letter. |\n| password_confirmation | string | | Password confirmation. Must be same with password field. |\n| location_id | string | | Location of the user. Required if user's role is Venue Admin or Front Desk |\n\n### Response Example\n\n```json\n{\n \"data\": {\n \"id\": \"MO92vaXoe3a\",\n \"user_id\": 456,\n \"name\": \"John Doe\",\n \"username\": \"johndoe\",\n \"user_type\": 1,\n \"user_type_name\": \"Platform\",\n \"email\": \"john@examplet.com\",\n \"role\": \"front-desk\",\n \"role_name\": \"Front Desk\",\n \"current_tenant_name\": \"Company\",\n \"current_tenant_id\": \"QZOpo3GoB8X\",\n \"location_id\": \"N1L5ead5j7p\",\n \"location_name\": \"Concert Venue\",\n \"status\": 1,\n \"is_trashed\": false,\n \"locale\": \"en\",\n \"api_token\": null\n }\n}\n```",
"body": {
"mode": "raw",
"raw": "{\n \"name\": \"example\",\n \"email\": \"example\",\n \"role\": \"example\",\n \"status\": 1\n}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "Deactivate User",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/users/:id/deactivate",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":id",
"deactivate"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
]
},
"description": "Deactivate given user.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.",
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
},
{
"name": "Activate User",
"request": {
"method": "PUT",
"header": [],
"url": {
"raw": "{{baseUrl}}/users/:id/activate",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":id",
"activate"
],
"variable": [
{
"key": "id",
"value": "",
"description": "id identifier"
}
]
},
"description": "Activate given user.\n\n\n\nThis endpoint has a rate limit of **60 requests per minute**.",
"body": {
"mode": "raw",
"raw": "{}",
"options": {
"raw": {
"language": "json"
}
}
}
},
"response": []
}
]
}
]
}