Get all Device Groups

This endpoint retrieves all Device Groups.

Request

To retrieve all Device Groups please make a GET request to the following URL:

HTTP MethodURL
GEThttps://industrial.api.ubidots.com/api/v2.0/device_groups/

Query Parameter

ParameterTypeUseDescription
tokenStringAuthenticationAuthentication Token can optionally be sent as a query parameter.
pageNumberPaginationReturns the corresponding page of the result
page_sizeNumberPaginationNumber of items per page, if not provided takes default values of 50 (for variables 200)
created_atStringSortSort all Variables based on date created. Default descending.
labelStringSortSort by label
nameStringSortSort by name
fieldsComma separated listDynamic FieldsSpecify the fields that should be obtained in the response object.
searchStringSearchAllows to search on the following fields with one request label, name, description, username, firstName, lastName
idStringFilterFilter by id
labelStringFilterFilter by label
nameStringFilterFilter by name
organization<organization_key>FilterFilter by organization key
eventsRelated Filter of EventsFilterFilter by event key
createdAtDateFilterFilter by date created

Header

ParameterRequired?Description
X-Auth-TokenYes[Authentication Token] (/reference/authentication) of account
$ curl -X GET 'https://industrial.api.ubidots.com/api/v2.0/device_groups/' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "https://industrial.api.ubidots.com/api/v2.0/device_groups/5e1c8daf89f9bd33017e05e9",
            "id": "5e1c8daf89f9bd33017e05e9",
            "label": "group-test",
            "name": "Group Test",
            "organization": null,
            "devices": "https://industrial.api.ubidots.com/api/v2.0/device_groups/5e1c8daf89f9bd33017e05e9/devices",
            "devicesNumber": 1,
            "createdAt": "2020-01-13T15:33:03.655965Z"
        }
    ]
}
{
    "code": 400001,
    "message": "Validation Error.",
    "detail": {
        ....
    }
}
{
    "code": 401001,
    "message": "Authentication credentials were not provided.",
    "detail": "Authentication credentials were not provided."
}

Response

An object with an array results containing all Device Groups.