Services API

get listing

GET /api/rest/customer/v1/services

Parameters

Name Description
filter[id] id filter
filter[created-at-eq] created at eq filter
filter[created-at-not-eq] created at not eq filter
filter[created-at-gt] created at gt filter
filter[created-at-gteq] created at gteq filter
filter[created-at-lt] created at lt filter
filter[created-at-lteq] created at lteq filter
filter[created-at-in] created at in filter
filter[created-at-not-in] created at not in 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[account-id-eq] account id eq filter
filter[account-id-not-eq] account id not eq filter
filter[account-id-in] account id in filter
filter[account-id-not-in] account id not in filter
filter[initial-price-eq] initial price eq filter
filter[initial-price-not-eq] initial price not eq filter
filter[initial-price-gt] initial price gt filter
filter[initial-price-gteq] initial price gteq filter
filter[initial-price-lt] initial price lt filter
filter[initial-price-lteq] initial price lteq filter
filter[initial-price-in] initial price in filter
filter[initial-price-not-in] initial price not in filter
filter[renew-price-eq] renew price eq filter
filter[renew-price-not-eq] renew price not eq filter
filter[renew-price-gt] renew price gt filter
filter[renew-price-gteq] renew price gteq filter
filter[renew-price-lt] renew price lt filter
filter[renew-price-lteq] renew price lteq filter
filter[renew-price-in] renew price in filter
filter[renew-price-not-in] renew price not in filter
filter[renew-at-eq] renew at eq filter
filter[renew-at-not-eq] renew at not eq filter
filter[renew-at-gt] renew at gt filter
filter[renew-at-gteq] renew at gteq filter
filter[renew-at-lt] renew at lt filter
filter[renew-at-lteq] renew at lteq filter
filter[renew-at-in] renew at in filter
filter[renew-at-not-in] renew at not in filter
filter[renew-period-eq] renew period eq filter
filter[renew-period-not-eq] renew period not eq filter
filter[renew-period-in] renew period in filter
filter[renew-period-not-in] renew period not in filter

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjM5LCJhdWQiOlsiY3VzdG9tZXItdjEiXSwiZXhwIjoxNzQwODUyNTA4fQ.16sx9apXKfdz14zv5nNIv1NanhR2lHC2buLndIvTok4
Host: example.org
Cookie: 

Route

GET /api/rest/customer/v1/services

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/"338e9902344e32e129f6e1387f63b77c"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: c7a1fac4-fe0b-473f-9b41-092049b15b09
X-Runtime: 0.013734
Content-Length: 2098

Status

200 OK

Body

{
  "data": [
    {
      "id": "d789bf40-9b37-46e9-830f-c6fbf4355fbb",
      "type": "services",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/services/d789bf40-9b37-46e9-830f-c6fbf4355fbb"
      },
      "attributes": {
        "name": "Service_13",
        "state": "Active",
        "initial-price": "37.93",
        "renew-price": "27.78",
        "created-at": "2025-03-01T11:55:28.540Z",
        "renew-at": null,
        "renew-period": "Disabled",
        "service-type": "Service Type 19",
        "ui-type": "phone_systems"
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/services/d789bf40-9b37-46e9-830f-c6fbf4355fbb/relationships/account",
            "related": "http://example.org/api/rest/customer/v1/services/d789bf40-9b37-46e9-830f-c6fbf4355fbb/account"
          }
        },
        "transactions": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/services/d789bf40-9b37-46e9-830f-c6fbf4355fbb/relationships/transactions",
            "related": "http://example.org/api/rest/customer/v1/services/d789bf40-9b37-46e9-830f-c6fbf4355fbb/transactions"
          }
        }
      }
    },
    {
      "id": "f829f96b-9a74-4b77-99c8-2ed6eddbda2c",
      "type": "services",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/services/f829f96b-9a74-4b77-99c8-2ed6eddbda2c"
      },
      "attributes": {
        "name": "Service_12",
        "state": "Active",
        "initial-price": "19.37",
        "renew-price": "55.43",
        "created-at": "2025-03-01T13:20:28.507Z",
        "renew-at": null,
        "renew-period": "Disabled",
        "service-type": "Service Type 18",
        "ui-type": "phone_systems"
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/services/f829f96b-9a74-4b77-99c8-2ed6eddbda2c/relationships/account",
            "related": "http://example.org/api/rest/customer/v1/services/f829f96b-9a74-4b77-99c8-2ed6eddbda2c/account"
          }
        },
        "transactions": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/services/f829f96b-9a74-4b77-99c8-2ed6eddbda2c/relationships/transactions",
            "related": "http://example.org/api/rest/customer/v1/services/f829f96b-9a74-4b77-99c8-2ed6eddbda2c/transactions"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/customer/v1/services?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/customer/v1/services?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}