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

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJhdWQiOlsiY3VzdG9tZXItdjEiXSwic3ViIjo1NywiZXhwIjoxNzY3MzU4MDM3fQ.ON73KIo6Ri6t80BoGaRhlvKEXKSyVbGSVd4sh6tgHrU
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/"61fb927813bb1da3587cc23f4a3bb0a4"
cache-control: max-age=0, private, must-revalidate
x-request-id: 9d34729c-c27d-4568-93d0-b41da9a6292d
x-runtime: 0.011789
content-length: 2097

Status

200 OK

Body

{
  "data": [
    {
      "id": "cf7b9ebf-0a55-4284-9ce5-22ccff416960",
      "type": "services",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/services/cf7b9ebf-0a55-4284-9ce5-22ccff416960"
      },
      "attributes": {
        "name": "Service_15",
        "state": "Active",
        "initial-price": "0.94",
        "renew-price": "31.91",
        "created-at": "2026-01-02T03:29:17.330Z",
        "renew-at": null,
        "renew-period": "Disabled",
        "service-type": "Service Type 21",
        "ui-type": "phone_systems"
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/services/cf7b9ebf-0a55-4284-9ce5-22ccff416960/relationships/account",
            "related": "http://example.org/api/rest/customer/v1/services/cf7b9ebf-0a55-4284-9ce5-22ccff416960/account"
          }
        },
        "transactions": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/services/cf7b9ebf-0a55-4284-9ce5-22ccff416960/relationships/transactions",
            "related": "http://example.org/api/rest/customer/v1/services/cf7b9ebf-0a55-4284-9ce5-22ccff416960/transactions"
          }
        }
      }
    },
    {
      "id": "221637f2-456c-422b-aba6-2e611d31c3aa",
      "type": "services",
      "links": {
        "self": "http://example.org/api/rest/customer/v1/services/221637f2-456c-422b-aba6-2e611d31c3aa"
      },
      "attributes": {
        "name": "Service_16",
        "state": "Active",
        "initial-price": "83.91",
        "renew-price": "66.38",
        "created-at": "2026-01-02T12:01:17.346Z",
        "renew-at": null,
        "renew-period": "Disabled",
        "service-type": "Service Type 22",
        "ui-type": "phone_systems"
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/services/221637f2-456c-422b-aba6-2e611d31c3aa/relationships/account",
            "related": "http://example.org/api/rest/customer/v1/services/221637f2-456c-422b-aba6-2e611d31c3aa/account"
          }
        },
        "transactions": {
          "links": {
            "self": "http://example.org/api/rest/customer/v1/services/221637f2-456c-422b-aba6-2e611d31c3aa/relationships/transactions",
            "related": "http://example.org/api/rest/customer/v1/services/221637f2-456c-422b-aba6-2e611d31c3aa/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"
  }
}