Introduction

Each user can generate an API token that provides access to the Vantage public API. These tokens are long lived and can be freely created/deleted from the Vantage portal.

A team belongs to to a specific Vantage account. Each user can be a member of multiple teams, this provides a single user access to multiple Vantage accounts if permitted.

You can retrieve the device list for each team. This includes basic information about each device along with the latest data collected.

Generate Token

Click on your name and select API Tokens from the dropdown

Name your token and click create. Store the created token, this will only be shown once.

Token must be added to every request as a bearer token in the Authorization header

API Endpoints

Base URL

https://onvantage.io/api/v1

Get User

GET /user

Returns the currently logged in user

{
    "data": {
        "id": "xPeaNArJeWyE27lg",
        "name": "Vantage User",
        "email": "vantage.user@vantage.com"
    }
}

Get Team Membership List

GET /teams

Returns all teams the user is a member of

{
    "data": [
        {
            "id": "5LOkAdWNDqgVomKP",
            "name": "Waelchi-Kilback"
        },
        {
            "id": "xPeaNArJeWyE27lg",
            "name": "Mertz-Schmeler"
        }
    ]
}

Get Team Device List

GET /teams/{team_id}/devices

Returns the list of devices that belong to the specified team. The user must be a member of the team or a 401 error will be returned.

Data is paginated, the page can be selected with a page query parameter.

Returns the list of devices that belong to the specified team. The user must be a member of the team or a 401 error will be returned.

Data is paginated, the page can be selected with a page query parameter.

{
    "data": [
        {
            "id": "5LOkAdWNDqgVomKP",
            "name": "CX-20",
            "manufacturer": "Barco",
            "model": "CX-20",
            "mac_addresses": [
                "00:DE:43:C5:76:F4",
                "00:6A:B9:FB:26:D4"
            ],
            "ip_addresses": [
                "192.168.0.1",
                "192.168.0.2"
            ],
            "serial_number": "4tyi57xjqij5",
            "status": "ONLINE",
            "room": "w422",
            "attributes": [
                {
                    "key": "testkey",
                    "value": "testvalue",
                    "last_updated": "2022-10-12T16:47:52.000000Z"
                }
            ]
        },
        {
            "id": "xPeaNArJeWyE27lg",
            "name": "Logitech Rally Plus Black - Mic Pod 1",
            "manufacturer": "SSC",
            "model": "Logitech Rally Plus Black - Mic Pod 1",
            "mac_addresses": [
                "00:D8:AB:81:7C:4A",
                "00:BF:E8:F4:8F:28"
            ],
            "ip_addresses": [
                "192.168.0.1",
                "192.168.0.2"
            ],
            "serial_number": "4umb69jhmgy2",
            "status": "ONLINE",
            "room": "q957",
            "attributes": []
        }
    ],
    "links": {
        "first": "<https://onvantage.io/api/v1/teams/5LOkAdWNDqgVomKP/devices?page=1>",
        "last": "<https://onvantage.io/api/v1/teams/5LOkAdWNDqgVomKP/devices?page=1>",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "<https://onvantage.io/api/v1/teams/5LOkAdWNDqgVomKP/devices?page=1>",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next &raquo;",
                "active": false
            }
        ],
        "path": "<https://onvantage.io/api/v1/teams/5LOkAdWNDqgVomKP/devices>",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}