Routing groups API

get listing

GET /api/rest/admin/routing-groups

Parameters

Name	Description
filter[id]	id filter
filter[name]	name filter
filter[name-eq]	name eq filter
filter[name-not-eq]	name not eq filter
filter[name-cont]	name cont filter
filter[name-start]	name start filter
filter[name-end]	name end filter
filter[name-in]	name in filter
filter[name-not-in]	name not in filter
filter[name-cont-any]	name cont any filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE5MCwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU3MH0.9-JszJXn30xjyU6dDoVwMWiHK1F3WRN-GfTsAfmOqB0
Host: example.org
Cookie: 

Route

GET /api/rest/admin/routing-groups

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
vary: Accept
etag: W/"0b6433da5aff7a0a573ae3d9c7a7b09a"
cache-control: max-age=0, private, must-revalidate
x-request-id: d1feec70-e0e3-455f-af5f-772d94b55e85
x-runtime: 0.009311
content-length: 1324

Status

200 OK

Body

{
  "data": [
    {
      "id": "20",
      "type": "routing-groups",
      "links": {
        "self": "http://example.org/api/rest/admin/routing-groups/20"
      },
      "attributes": {
        "name": "Example Group #1"
      },
      "relationships": {
        "routing-plans": {
          "links": {
            "related": "http://example.org/api/rest/admin/routing-groups/20/routing-plans"
          }
        }
      }
    },
    {
      "id": "21",
      "type": "routing-groups",
      "links": {
        "self": "http://example.org/api/rest/admin/routing-groups/21"
      },
      "attributes": {
        "name": "Example Group #2"
      },
      "relationships": {
        "routing-plans": {
          "links": {
            "related": "http://example.org/api/rest/admin/routing-groups/21/routing-plans"
          }
        }
      }
    },
    {
      "id": "33",
      "type": "routing-groups",
      "links": {
        "self": "http://example.org/api/rest/admin/routing-groups/33"
      },
      "attributes": {
        "name": "routing_group_12"
      },
      "relationships": {
        "routing-plans": {
          "links": {
            "related": "http://example.org/api/rest/admin/routing-groups/33/routing-plans"
          }
        }
      }
    },
    {
      "id": "34",
      "type": "routing-groups",
      "links": {
        "self": "http://example.org/api/rest/admin/routing-groups/34"
      },
      "attributes": {
        "name": "routing_group_13"
      },
      "relationships": {
        "routing-plans": {
          "links": {
            "related": "http://example.org/api/rest/admin/routing-groups/34/routing-plans"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 4
  },
  "links": {
    "first": "http://example.org/api/rest/admin/routing-groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/routing-groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}