Services API

get listing

GET /api/rest/admin/services

Parameters

Name Description
filter[id] id 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[type-id-eq] type id eq filter
filter[type-id-not-eq] type id not eq filter
filter[type-id-in] type id in filter
filter[type-id-not-in] type id not in filter
filter[uuid-eq] uuid eq filter
filter[uuid-not-eq] uuid not eq filter
filter[uuid-in] uuid in filter
filter[uuid-not-in] uuid not in 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[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.eyJzdWIiOjIyNCwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU3MX0.2U2aJJ5t0kLDZ_PcokvMe7YFDMSoJH3fgYuP0gEZbFg
Host: example.org
Cookie: 

Route

GET /api/rest/admin/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/"d3cf5d2b24f063224055fbde20a00f93"
cache-control: max-age=0, private, must-revalidate
x-request-id: f4a90451-0eb9-4a20-a467-73c438294d6f
x-runtime: 0.007278
content-length: 2436

Status

200 OK

Body

{
  "data": [
    {
      "id": "7",
      "type": "services",
      "links": {
        "self": "http://example.org/api/rest/admin/services/7"
      },
      "attributes": {
        "name": "Service_7",
        "variables": {
          "baz": 123
        },
        "state": "Active",
        "initial-price": "25.82",
        "renew-price": "87.57",
        "created-at": "2026-01-02T08:47:11.945Z",
        "renew-at": null,
        "renew-period": "Disabled",
        "uuid": "58c8775e-c16f-498b-b20b-d89756ea691c"
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/admin/services/7/relationships/account",
            "related": "http://example.org/api/rest/admin/services/7/account"
          },
          "data": {
            "type": "accounts",
            "id": "87"
          }
        },
        "service-type": {
          "links": {
            "self": "http://example.org/api/rest/admin/services/7/relationships/service-type",
            "related": "http://example.org/api/rest/admin/services/7/service-type"
          }
        },
        "transactions": {
          "links": {
            "self": "http://example.org/api/rest/admin/services/7/relationships/transactions",
            "related": "http://example.org/api/rest/admin/services/7/transactions"
          }
        },
        "package-counters": {
          "links": {
            "self": "http://example.org/api/rest/admin/services/7/relationships/package-counters",
            "related": "http://example.org/api/rest/admin/services/7/package-counters"
          }
        }
      }
    },
    {
      "id": "8",
      "type": "services",
      "links": {
        "self": "http://example.org/api/rest/admin/services/8"
      },
      "attributes": {
        "name": "Service_8",
        "variables": {
          "baz": 123
        },
        "state": "Active",
        "initial-price": "37.14",
        "renew-price": "16.46",
        "created-at": "2026-01-02T06:53:11.977Z",
        "renew-at": null,
        "renew-period": "Disabled",
        "uuid": "4f4f997a-9ead-4192-85cf-eeb607105c23"
      },
      "relationships": {
        "account": {
          "links": {
            "self": "http://example.org/api/rest/admin/services/8/relationships/account",
            "related": "http://example.org/api/rest/admin/services/8/account"
          },
          "data": {
            "type": "accounts",
            "id": "88"
          }
        },
        "service-type": {
          "links": {
            "self": "http://example.org/api/rest/admin/services/8/relationships/service-type",
            "related": "http://example.org/api/rest/admin/services/8/service-type"
          }
        },
        "transactions": {
          "links": {
            "self": "http://example.org/api/rest/admin/services/8/relationships/transactions",
            "related": "http://example.org/api/rest/admin/services/8/transactions"
          }
        },
        "package-counters": {
          "links": {
            "self": "http://example.org/api/rest/admin/services/8/relationships/package-counters",
            "related": "http://example.org/api/rest/admin/services/8/package-counters"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/services?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/services?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}