Skip to content
PulsatePulsatePulsate Documentation

Beacons: Index

GET /apps/{app_id}/beacons

Path Parameters

Section titled “Path Parameters”
Name Type Required Description
app_id string No

Query Parameters

Section titled “Query Parameters”
Name Type Required Description
page string No page number
per_page string No records per page
battery_status string No Beacons battery status (active,check,inactive)
group_ids string No Group ids
search_query string No search beacon by id and nickname
sort string No sort param
order string No order by ascending or descending e.g. (asc, desc)

Headers

Section titled “Headers”
Name Type Required Description
Authorization string Yes {my_admin_api_token}
Content-Type string No application/json

Request Example

Section titled “Request Example”
Terminal window
curl --request GET \
  --url https://control.pulsatehq.com/api/v2/apps/{app_id}/beacons \
  --header 'authorization: Token token={my_admin_api_token}' \
  --header 'content-type: application/json'

Responses

Section titled “Responses”

200

{
    "data": [
        {
            "id": "64b667cba46a6f8b9a504c98",
            "nickname": "Very Long - 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910 12345678910",
            "cached_beacon_events_count": 0,
            "created_at": "2023-07-18T10:22:03Z",
            "uuid": "3A149B28-3868-4FCC-92FD-DA167776668C",
            "major": 555,
            "minor": 555,
            "battery": "Check",
            "beacon_id": "555",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/64b667cba46a6f8b9a504c98",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/64b667cba46a6f8b9a504c98"
            }
        },
        {
            "id": "64b667cba46a6f8b9a504c97",
            "nickname": "123",
            "cached_beacon_events_count": 0,
            "created_at": "2023-07-18T10:22:03Z",
            "uuid": "4A7F4825-E951-4F63-AE55-838BA4FD378E",
            "major": 123,
            "minor": 123,
            "battery": "Check",
            "beacon_id": "123",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/64b667cba46a6f8b9a504c97",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/64b667cba46a6f8b9a504c97"
            }
        },
        {
            "id": "64b667cba46a6f8b9a504c96",
            "nickname": "987",
            "cached_beacon_events_count": 0,
            "created_at": "2023-07-18T10:22:03Z",
            "uuid": "5D2CDC7E-3907-4A81-B17F-898708ABC21C",
            "major": 987,
            "minor": 987,
            "battery": "Check",
            "beacon_id": "987",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/64b667cba46a6f8b9a504c96",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/64b667cba46a6f8b9a504c96"
            }
        },
        {
            "id": "64b113a5a46a6f1a74ae4ac0",
            "nickname": "2",
            "cached_beacon_events_count": 0,
            "created_at": "2023-07-14T09:21:41Z",
            "uuid": "33E85398-AC27-489B-ADD2-FD2D7A785AD3",
            "major": 3,
            "minor": 1,
            "battery": "Check",
            "beacon_id": "245235",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/64b113a5a46a6f1a74ae4ac0",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/64b113a5a46a6f1a74ae4ac0"
            }
        },
        {
            "id": "64b113a5a46a6f1a74ae4abf",
            "nickname": "2",
            "cached_beacon_events_count": 0,
            "created_at": "2023-07-14T09:21:41Z",
            "uuid": "33E85398-AC27-489B-ADD2-FD2D7A785AD2",
            "major": 3,
            "minor": 1,
            "battery": "Check",
            "beacon_id": "245295",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/64b113a5a46a6f1a74ae4abf",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/64b113a5a46a6f1a74ae4abf"
            }
        },
        {
            "id": "64b113a5a46a6f1a74ae4abe",
            "nickname": "1",
            "cached_beacon_events_count": 0,
            "created_at": "2023-07-14T09:21:41Z",
            "uuid": "531E0AED-67DA-4C80-B105-CB4F73F6B8E5",
            "major": 4,
            "minor": 3,
            "battery": "Check",
            "beacon_id": "24525",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/64b113a5a46a6f1a74ae4abe",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/64b113a5a46a6f1a74ae4abe"
            }
        },
        {
            "id": "63d0fbf1a8e6aad95e7342a0",
            "nickname": "Test_beacn_04",
            "cached_beacon_events_count": 0,
            "created_at": "2023-01-25T09:52:49Z",
            "uuid": "F7826DA6-4FA2-4E98-8024-BC5B71E0893E",
            "major": 1237,
            "minor": 5542,
            "battery": "Check",
            "beacon_id": "Test_beacn_04",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/63d0fbf1a8e6aad95e7342a0",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/63d0fbf1a8e6aad95e7342a0"
            }
        },
        {
            "id": "63d0fbf1a8e6aad95e73429f",
            "nickname": "Test_beacn_03",
            "cached_beacon_events_count": 0,
            "created_at": "2023-01-25T09:52:49Z",
            "uuid": "F7826DA6-4FA2-4E98-8024-BC5B71E0893E",
            "major": 1236,
            "minor": 5520,
            "battery": "Check",
            "beacon_id": "Test_beacn_03",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/63d0fbf1a8e6aad95e73429f",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/63d0fbf1a8e6aad95e73429f"
            }
        },
        {
            "id": "63d0fbf1a8e6aad95e73429e",
            "nickname": "Test_beacn_02",
            "cached_beacon_events_count": 0,
            "created_at": "2023-01-25T09:52:49Z",
            "uuid": "F7826DA6-4FA2-4E98-8024-BC5B71E0893E",
            "major": 1235,
            "minor": 5498,
            "battery": "Check",
            "beacon_id": "Test_beacn_02",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/63d0fbf1a8e6aad95e73429e",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/63d0fbf1a8e6aad95e73429e"
            }
        },
        {
            "id": "62d029afa8e6aa71b4221a8e",
            "nickname": "QA Ashtown - New Beacon",
            "cached_beacon_events_count": 1185,
            "created_at": "2022-07-14T14:35:27Z",
            "uuid": "F7826DA6-4FA2-4E98-8024-BC5B71E0893E",
            "major": 2175,
            "minor": 28056,
            "battery": "Check",
            "beacon_id": "iBeacon 2",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/62d029afa8e6aa71b4221a8e",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/62d029afa8e6aa71b4221a8e"
            }
        },
        {
            "id": "62d02987a8e6aa71b4221a8b",
            "nickname": "iBeacon 1",
            "cached_beacon_events_count": 2270,
            "created_at": "2022-07-14T14:34:47Z",
            "uuid": "F7826DA6-4FA2-4E98-8024-BC5B71E0893E",
            "major": 35786,
            "minor": 18382,
            "battery": "Check",
            "beacon_id": "iBeacon-1",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/62d02987a8e6aa71b4221a8b",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/62d02987a8e6aa71b4221a8b"
            }
        },
        {
            "id": "5ae0861b4753364a20170000",
            "nickname": "Beacon-nickname",
            "cached_beacon_events_count": 3,
            "created_at": "2018-04-25T13:43:55Z",
            "uuid": "2F234454-CF6D-4A0F-ADF2-F4911BA9FFA6",
            "major": 0,
            "minor": 0,
            "battery": "Check",
            "beacon_id": "Beacon-id",
            "groups": [],
            "actions": {
                "edit": "/api/v2/apps/5ae07be64753364695040000/beacons/5ae0861b4753364a20170000",
                "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/5ae0861b4753364a20170000"
            }
        }
    ],
    "bulk_actions": {
        "delete": "/api/v2/apps/5ae07be64753364695040000/beacons/batch_destroy",
        "add_to_group": "/api/v2/apps/5ae07be64753364695040000/groups/add_resources",
        "remove_from_group": "/api/v2/apps/5ae07be64753364695040000/groups/remove_resources"
    },
    "metadata": {
        "page": 1,
        "per_page": 50,
        "total_pages": 1,
        "data_count": 12,
        "groups": [],
        "beacons_status": {
            "active": 0,
            "check": 12,
            "inactive": 0
        },
        "export_link": "/api/v2/apps/5ae07be64753364695040000/beacons/export"
    }
}