Get Organization

This endpoints retrieves a specific Organization.

Request

To retrieve a single Organization please make a GET request to the following URL:

HTTP Method

URL

GET

https://industrial.api.ubidots.com/api/v2.0/organizations/<organization_key>/

Path Parameters

Parameter

Type

Description

organization_key

String

The id or label of the Organization, label should use the prefix ~

Query Parameters

Parameter

Type

Use

Description

token

String

Authentication

Authorization Token can optionally be sent as a query parameter.

fields

Comma separated list

Dynamic Fields

Specify the fields that should be obtained in the response object

Header

Parameter

Required?

Description

X-Auth-Header

Yes

Authentication Token of account

$ curl -X GET 'https://industrial.api.ubidots.com/api/v2.0/organizations/<organization_key>' \
 -H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73'
{
    "app": {
        "id": "5dfa39901a9ca53020c6938d",
        "label": "my_application",
        "name": "Ubidots App of Me",
        "url": "https://industrial.api.ubidots.com/api/v2.0/apps/5dfa39901a9ca53020c6938d"
    },
    "createdAt": "2020-01-01T14:05:55.471155Z",
    "description": "Other Organization",
    "devicesCount": 0,
    "favicon":  {
        "h36": "https://iot.cdnedge.bluemix.net/ind/media/logos/ubidots-white_36.png",
         "h50": "https://iot.cdnedge.bluemix.net/ind/media/logos-big/ubidots-white_50.png",
         "raw": "https://iot.cdnedge.bluemix.net/ind/media/logos-raw/ubidots-white.png"   
    },
    "id": "435ab418805c32fa400f",
    "isActive": true,
    "label": "my-second-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": {
        "h36": "https://iot.cdnedge.bluemix.net/ind/media/logos/ubidots-white_36.png",
        "h50": "https://iot.cdnedge.bluemix.net/ind/media/logos-big/ubidots-white_50.png",
        "raw": "https://iot.cdnedge.bluemix.net/ind/media/logos-raw/ubidots-white.png"
    },
    "name": "My Second Customer",
    "properties": {"any": "thing"},
    "url": "https://industrial.api.ubidots.com/api/v2.0/organizations/435ab418805c32fa400f",
    "usersCount": 0
}
{
    "code": 400001,
    "message": "Validation Error.",
    "detail": {
        ....
    }
}
{
    "code": 401001,
    "message": "Authentication credentials were not provided.",
    "detail": "Authentication credentials were not provided."
}

Response

Returns an Organitzation object with the requested organization.