Gateway groups API

get listing

GET /api/rest/admin/gateway-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

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MzE1Nzg3NTYsInN1YiI6MTI0fQ.Y9gtHxvMsDTnIl0-wZVnWiAWR4kJf53H3oIqZJKclO8
Host: example.org
Cookie: 

Route

GET /api/rest/admin/gateway-groups

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"3f3857559e395333fb230d17b4ba4828"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 09865bf7-f0f4-4b69-aaa5-245ea3f18a22
X-Runtime: 0.008167
Content-Length: 996

Status

200 OK

Body

{
  "data": [
    {
      "id": "14",
      "type": "gateway-groups",
      "links": {
        "self": "http://example.org/api/rest/admin/gateway-groups/14"
      },
      "attributes": {
        "name": "gateway_group_12"
      },
      "relationships": {
        "vendor": {
          "links": {
            "self": "http://example.org/api/rest/admin/gateway-groups/14/relationships/vendor",
            "related": "http://example.org/api/rest/admin/gateway-groups/14/vendor"
          },
          "data": {
            "type": "contractors",
            "id": "76"
          }
        }
      }
    },
    {
      "id": "15",
      "type": "gateway-groups",
      "links": {
        "self": "http://example.org/api/rest/admin/gateway-groups/15"
      },
      "attributes": {
        "name": "gateway_group_13"
      },
      "relationships": {
        "vendor": {
          "links": {
            "self": "http://example.org/api/rest/admin/gateway-groups/15/relationships/vendor",
            "related": "http://example.org/api/rest/admin/gateway-groups/15/vendor"
          },
          "data": {
            "type": "contractors",
            "id": "77"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/gateway-groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/gateway-groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}