Este endpoint devuelve todas las Organizations.
Solicitud HTTP
Para obtener todas las Organizations, haz una petición GET a la siguiente URL:
HTTP Method | URL |
---|---|
GET | https://api.netux.com/api/v2.0/organizations/ |
Parámetros de consulta
Parameter | Type | Use | Description |
---|---|---|---|
token | String | Authentication | Authentication Token can optionally be sent as a query parameter. |
page | Number | Pagination | Returns the corresponding page of the result |
page_size | Number | Pagination | Number of items per page, if not provided takes default values of 50 (for variables 200) |
created_at | String | Sort | Sort all Variables based on date created. Default descending. |
label | String | Sort | Sort by label |
name | String | Sort | Sort by name |
fields | Comma separated list | Dynamic Fields | Specify the fields that should be obtained in the response object. |
search | String | Search | Allows to search on the following fields with one request label , name , description , username , firstName , lastName |
id | String | Filter | Filter by id |
label | String | Filter | Filter by label |
name | String | Filter | Filter by name |
description | String | Filter | Filter by description |
properties | Json | Filter | Filter by properties |
createdAt | String | Filter | Filter by date of creation |
app | App Object | Related Filter | Filter by app |
Cabecera
Parameter | Required? | Description |
---|---|---|
X-Auth-Token | Yes | Authentication Token of account |
$ curl -X GET 'https://api.netux.com/api/v2.0/organizations/' \
-H 'X-Auth-Token: oaXBo6ODhIjPsusNRPUGIK4d72bc73' \
Respuesta
Devuelve un objeto con un array results
que contiene todas las Organizations.
{
"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://api.netux.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."
}