Units

From the API, you are able to obtain a list of current active Units (venues / locations).

The API user is linked to an Airship account, and all the units associated to that account will be returned, paginated in the response.

Endpoint

GET

https://api.airship.co.uk/v1/account/units

Response

Fields

Field	Notes
id	Airships unique unit ID for the unit. It is required when sending Airship data
name	The unit name
is_root	Each Airship account has a 'root' account (typically named Head Office) - this is used for data that can't be associated with a specific location. Only 1 root account can be setup for each account, and is identified by this flag

Example response

{
    "current_page": 1,
    "data": [
        {
            "id": 13822,
            "name": "Head Office",
            "is_root": true
        },
        {
            "id": 13835,
            "name": "The shack",
            "is_root": false
        }
    ],
    "first_page_url": "https://api.airship.co.uk/v1/account/units?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "https://api.airship.co.uk/v1/account/units?page=1",
    "next_page_url": null,
    "path": "https://api.airship.co.uk/v1/account/units",
    "per_page": 100,
    "prev_page_url": null,
    "to": 2,
    "total": 2
}