Request
|
Endpoint:
|
/api/customers
|
|
Method:
|
GET
|
|
Headers:
|
Accept: application/vnd.cloudlx.v1+json
|
|
Authorization: Bearer <access_token>
|
Response
Example:
{
"customers": [
{
"id": 915,
"name": "Customer 1",
"currency": {
"name": "GBP - British Pound",
"iso_2": "GB",
"iso_3": "GBP"
},
"country": {
"name": "United Kingdom",
"iso_2": "GB",
},
"realms": [
{
"id": 2,
"name": "Networking",
"description": "Cloud Link Exchange"
},
{
"id": 7,
"name": "Voice",
"description": "Use the Voice app to buy geographic, toll free, mobile, and premium rate numbers globally."
}
],
"sub_realms": [
{
"id": 313,
"name": "SD WAN",
"description": null,
"has_access": true
}
]
},
{
"id": 1051,
"name": "Customer 2",
"currency": {
"name": "GBP - British Pound",
"iso_2": "GB",
"iso_3": "GBP"
},
"country": {
"name": "United Kingdom",
"iso_2": "GB",
},
"realms": [
{
"id": 2,
"name": "Networking",
"description": "Cloud Link Exchange"
},
{
"id": 7,
"name": "Voice",
"description": "Use the Voice app to buy geographic, toll free, mobile, and premium rate numbers globally."
}
],
"sub_realms": [
{
"id": 313,
"name": "SD WAN",
"description": null,
"has_access": true
}
]
},
...
]
}
|
id
|
Description
|
The id of the customer
|
|
Type
|
Integer
|
|
Example
|
915
|
|
name
|
Description
|
The customer name
|
|
Type
|
String
|
|
Example
|
Customer 1
|
|
currency
|
Description
|
A currency model describing the customer's default currency
|
|
Type
|
Object
|
|
country
|
Description
|
A currency model describing the customer's country
|
|
Type
|
Object
|
|
realms
|
Description
|
The realms that the customer has access to
|
|
Type
|
Array[Object]
|
|
shown_sub_realms
|
Description
|
The sub-realms that the customer can see. Access to sub-realms managed in the enabled_sub_realms parameter
|
|
Type
|
Array[Object]
|
|
enabled_sub_realms
|
Description
|
The sub-realms that the customer can access.
|
|
Type
|
Array[Object]
|