Get Enterprises
DescriptionList Customers
Request
URLURL
Query Parameters
Query Parameters
Filter by accountNumber[contains]
Filter by accountNumber[notContains]
Filter by domain[contains]
Filter by domain[notContains]
A comma-separated list of field names corresponding to linked resources. Where supported, the server will resolve resource attributes for the specified resources.
Limits the maximum size of the result set.
Filter by name[contains]
Filter by name[notContains]
A nextPageLink value, as fetched via a past call to a list API method. When a nextPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.
A prevPageLink value, as fetched via a past call to a list API method. When a prevPageLink value is specified, any other query parameters that may ordinarily be used to sort or filter the result set are ignored.
sortBy query param to sort the resultset. Format of sortBy is
Response
Response BodyResponse Body
200 OK
Request successfully processed
{
"_href": "string",
"data": [
{
"_href": "string",
"accountNumber": "string",
"alertsEnabled": false,
"bastionState": "UNCONFIGURED",
"city": "string",
"contactEmail": "string",
"contactMobile": "string",
"contactName": "string",
"contactPhone": "string",
"country": "string",
"created": "string",
"description": "string",
"domain": "string",
"endpointPkiMode": "CERTIFICATE_DISABLED",
"gatewayPool": {
"_href": "string"
},
"lat": 0,
"locale": "string",
"logicalId": "string",
"lon": 0,
"modified": "string",
"name": "string",
"operatorAlertsEnabled": false,
"postalCode": "string",
"prefix": "string",
"state": "string",
"streetAddress": "string",
"streetAddress2": "string",
"timezone": "string"
}
],
"metaData": {
"limit": 0,
"more": false,
"nextPageLink": "string",
"prevPageLink": "string"
}
}
Errors
ValidationError
Unauthorized
Resource not found
Rate Limit Exceeded
Internal server error
