Get all Organizations

This endpoint retrieves all Organizations.

Request

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

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

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
descriptionStringFilterFilter by description
propertiesJsonFilterFilter by properties
createdAtStringFilterFilter by date of creation
appApp ObjectRelated FilterFilter by app

Header

ParameterRequired?Description
X-Auth-TokenYes[Authentication Token] (/reference/authentication) of account
$ curl -X GET 'https://industrial.api.ubidots.com/api/v2.0/organizations/' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "app": null,
            "createdAt": "2019-12-18T14:37:03.471155Z",
            "description": "Default Organization",
            "devicesCount": 0,
            "favicon":
            {
                "h36": "/media/logos/me_logo_36.png",
                "h50": "/media/logos-big/me_logo_50.png",
                "raw": "/media/logos-raw/me_logo.png"
            },
            "id": "4e51867af1721dda347b",
            "isActive": true,
            "label": "my-first-customer",
            "limits": [
                {
                    "actual_value": 0,
                    "icon": "hdd-o",
                    "max_value": "*",
                    "name": "Devices",
                    "type": "devices"
                },
                {
                    "actual_value": 0,
                    "icon": "envelope",
                    "max_value": "*",
                    "name": "Emails",
                    "type": "emails"
                },
                {
                    "actual_value": 0,
                    "icon": "signal",
                    "max_value": "*",
                    "name": "Variables",
                    "type": "variables"
                },
                {
                    "actual_value": 0,
                    "icon": "users",
                    "max_value": "*",
                    "name": "Users",
                    "type": "users"
                },
                {
                    "actual_value": 0,
                    "icon": "spinner",
                    "max_value": "*",
                    "name": "Dots",
                    "type": "dots"
                },
                {
                    "actual_value": 0,
                    "icon": "mobile-phone",
                    "max_value": "*",
                    "name": "SMS",
                    "type": "sms"
                },
                {
                    "actual_value": 0,
                    "icon": null,
                    "max_value": "*",
                    "name": "Voice",
                    "type": "voice"
                }
            ],
            "logo": null,
            "name": "My First Customer",
            "properties": {},
            "url": "https://industrial.api.ubidots.com/api/v2.0/organizations/4e51867af1721dda347b",
            "usersCount": 0
        }
    ]
}
{
    "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 Organizations.