Lists all CM servers

This API requires the Account Administrator role.

Returns the list of all available Communication Manager servers by account id

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 6 and 6
^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Query Params
int32
≥ 1
Defaults to 1

The page number of the records to retrieve. Default value is 1.

int32
5 to 50
Defaults to 10

The maximum number of records to retrieve per page. Default value is 10 and maximum 10 records will be retrieved.

string
length ≤ 255

Specifies details of a row filter.

The possible fields that can be filtered on are:

  • name

The allowed format:

  • Begins with the column name to be filtered, followed by a colon, then:
    • Either an exact string to match, or
    • A string expression including the * wildcard character
      • :{PREFIX}* will be used to find out word start with.
      • :*{POSTFIX} will be used to find out word end with
      • : will be used to match exact word
  • Begin with column name to be filtered, followed by a = operator. (this will be used to match exact string)
string
length ≤ 255
Defaults to name

Field name on which ordering needs to be performed. The default order is ascending.

The possible fields that can be ordered on are:

  • name

Field Names are case-senstive (should be written as it is in description).

To specify descending order, a suffix " desc" should be added. For example, "name" for ascending or "name desc" for descending".

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json
application/problem+json