OutgoingNumberlist API

get listing

GET /api/rest/customer/v1/outgoing-numberlists

Parameters

Name Description
filter[id] id 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
filter[default-action-id-eq] default action id eq filter
filter[default-action-id-not-eq] default action id not eq filter
filter[default-action-id-gt] default action id gt filter
filter[default-action-id-gteq] default action id gteq filter
filter[default-action-id-lt] default action id lt filter
filter[default-action-id-lteq] default action id lteq filter
filter[default-action-id-in] default action id in filter
filter[default-action-id-not-in] default action id not in filter
filter[mode-id-eq] mode id eq filter
filter[mode-id-not-eq] mode id not eq filter
filter[mode-id-gt] mode id gt filter
filter[mode-id-gteq] mode id gteq filter
filter[mode-id-lt] mode id lt filter
filter[mode-id-lteq] mode id lteq filter
filter[mode-id-in] mode id in filter
filter[mode-id-not-in] mode id not in filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjo0NywiZXhwIjoxNzY3MzU4MDM2fQ.XW3zULpycGakLF0igEEUeBHJwQLoF5uI-cON20UR7bw
Host: example.org
Cookie: 

Route

GET /api/rest/customer/v1/outgoing-numberlists

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/"e8a6d90bdd1a2cb6db9b1b1d346d1889"
cache-control: max-age=0, private, must-revalidate
x-request-id: 7c3f5b4a-c464-4c98-83f1-dfa02f318bf7
x-runtime: 0.009840
content-length: 448

Status

200 OK

Body

{
  "data": [
    {
      "id": "20",
      "type": "outgoing-numberlists",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/outgoing-numberlists/20"
      },
      "attributes": {
        "name": "test",
        "default-action-id": 1,
        "mode-id": 1
      }
    }
  ],
  "meta": {
    "total-count": 1
  },
  "links": {
    "first": "http://example.org/api/rest/customer/v1/outgoing-numberlists?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/customer/v1/outgoing-numberlists?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}