Get Services

GET /v2/service

Retrieves a list of services with pricing, availability, media, and selectable options (tiers). Each service may include nested "select" items and minimal references to required products. Use this endpoint to discover available services in the catalog and understand their configuration, pricing structure, and associated options.

Query Parameters

• filter[status.deleted] - Parameter for filter[status.deleted]

Request Example

GET /v2/service?filter[status.deleted]=false

Response Example

[
  {
    "id": "service-id-1",
    "vendor": { "name": "Example Vendor" },
    "status": { "active": true, "deleted": false },
    "name": "Example Service",
    "ingress": "Short one-line summary",
    "description": "Brief description of the service.",
    "type": 1,
    "price": 0,
    "currency": { "code": "USD", "id": "currency-id-1" },
    "country": { "code": "US", "id": "country-id-1" },
    "sku": "svc-0001",
    "subscription_term": 8640,
    "payment_period": 720,
    "sales_channel": "Shop",
    "image": "https://example.com/image.png",
    "media": ["https://example.com/media-1.png"],
    "tags": [],
    "integration": [],
    "reference": "service-ref-1",
    "resell": false,
    "msp": false,
    "permission_features": [],
    "customInputs": [],
    "tenant": "tenant-id-1",
    "created": "2025-01-01T00:00:00.000Z",
    "updated": "2025-01-02T00:00:00.000Z",
    "select": [
      {
        "id": "select-id-1",
        "name": "Tier 40GB",
        "type": 2,
        "status": { "active": true, "deleted": false },
        "description": "Includes backup of Mail, OneDrive, SharePoint & Teams.",
        "price": 35,
        "list_price": 35,
        "cost_price": 35,
        "sku": "opt-0001",
        "currency": { "code": "USD", "id": "currency-id-1" },
        "country": { "code": "US", "id": "country-id-1" },
        "image": "https://example.com/option.png",
        "media": [],
        "services": ["service-id-1"],
        "input": { "enabled": false },
        "featurelist": [],
        "tags": [],
        "required": [
          {
            "id": "product-id-1",
            "group_id": "product-group-id-1",
            "tenant": "tenant-id-1",
            "name": "BaaS M365 40GB",
            "status": { "active": true, "deleted": false },
            "sales_channel": "Shop",
            "subscription_term": 720,
            "payment_period": 8640,
            "subscription": true,
            "referenced": true,
            "amount": { "min": 1, "max": 9999, "default": 1 },
            "products": [
              {
                "id": "line-id-1",
                "sku": "sku-10000",
                "price": 50,
                "cost_price": 39,
                "amount": { "default": 1, "min": 1, "max": 9999 },
                "reference": "line-ref-1"
              }
            ],
            "services": ["service-id-1"],
            "consumption": {
              "integration": "",
              "property": "protected_users",
              "metadata": { "service": "backup" }
            },
            "managementLink": { "title": "", "url": "" },
            "description": "Mail, OneDrive, SharePoint & Teams (40GB per user)",
            "integration": [
              { "uuid": "exchange-uuid-1", "id": "int-id-1" },
              { "uuid": "sharepoint-uuid-1", "id": "int-id-2" },
              { "uuid": "onedrive-uuid-1", "id": "int-id-3" },
              { "uuid": "teams-uuid-1", "id": "int-id-4" }
            ],
            "permission_features": [
              { "namespace": "Backup/Initiate" },
              { "namespace": "Backup/Management" }
            ],
            "vendor": { "name": "Example Vendor" },
            "customInputs": [],
            "country": { "code": "US", "id": "country-id-1" },
            "currency": { "code": "USD", "id": "currency-id-1" },
            "type": 3,
            "list_price": 39,
            "resell": false,
            "msp": false,
            "created": "2025-01-01T00:00:00.000Z",
            "updated": "2025-01-02T00:00:00.000Z",
            "__v": 0
          }
        ],
        "optional": [],
        "vat": {
          "countrycode": "",
          "type": "ZERO_RATE_VAT",
          "rate": 0,
          "id": "vat-id-1",
          "__v": 0
        },
        "integration": [],
        "reference": "option-ref-1",
        "resell": false,
        "msp": false,
        "permission_features": [],
        "vendor": { "name": "Example Vendor" },
        "customInputs": [],
        "tenant": "tenant-id-1",
        "created": "2025-01-01T00:00:00.000Z",
        "updated": "2025-01-02T00:00:00.000Z",
        "__v": 1
      }
    ],
    "required": [],
    "optional": [],
    "vat": {
      "countrycode": "",
      "type": "ZERO_RATE_VAT",
      "rate": 0,
      "id": "vat-id-1",
      "__v": 0
    },
    "_id": "service-id-1"
  },
  {
    "id": "service-id-2",
    "vendor": { "name": "Example Vendor 2" },
    "status": { "active": false, "deleted": false },
    "name": "New Service",
    "description": "",
    "type": 1,
    "price": 0,
    "currency": { "code": "USD", "id": "currency-id-1" },
    "country": { "code": "US", "id": "country-id-1" },
    "sku": "svc-0002",
    "subscription_term": 0,
    "payment_period": 0,
    "sales_channel": "Shop",
    "image": "https://example.com/logo.png",
    "media": [],
    "tags": [],
    "integration": [],
    "reference": "service-ref-2",
    "resell": false,
    "msp": false,
    "permission_features": [],
    "customInputs": [],
    "tenant": "tenant-id-1",
    "created": "2025-01-03T00:00:00.000Z",
    "updated": "2025-01-03T00:00:00.000Z",
    "select": [],
    "required": [],
    "optional": [],
    "vat": {
      "countrycode": "",
      "type": "ZERO_RATE_VAT",
      "rate": 0,
      "id": "vat-id-1",
      "__v": 0
    },
    "_id": "service-id-2"
  }
]