v3

latestOpenAPI 3.0.12026-07-31240345599.7 KB

Forwarding rules

List forwarding rules

Lists the all forwarding rules user can view. It optionally takes three parameters - offset, size and showAll.

get/api/{cloudId}/v1/forwarding-rules

Query parameters

showAllboolean

Display all forwardings of the account.

offsetinteger

The offset parameter controls the starting point within the collection of resource results.

sizeinteger

The limit parameter controls the maximum number of items that may be returned for a single request.

Response

Returned if the request is successful.

Example response

{
  "values": [
    {
      "id": "6667cb5b-a5ce-4550-9469-1dbcabac6ffb",
      "fromUserId": "e58d6ee3-37bd-432f-9ded-64808b761ae0",
      "toUserId": "4b26961a-a837-49d2-a1fe-0973013e3c3b",
      "startDate": "2022-07-05T08:00:00Z",
      "endDate": "2022-07-06T18:00:00Z"
    }
  ],
  "links": {
    "next": "/v1/forwarding-rules?offset=1&size=5"
  }
}