Sales | Customer Service Instances

List all service instances of a direct customer (inventory).

get

This is endpoint provides similar data to the /inventory/service-instances endpoint of the requested customer. So it also includes instances which are internally provided or provided by a third party.

Remarkable notes:

• you can only request data of your direct customers and not for any partner related customers
• you might not be allowed to access details of externally provided instances
• the "customer" field will always be null since the result is only about the requested customer

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

customerIdinteger · int32Required

The identifier of the customer which owns the service instances

Query parameters

servicesinteger · int32[]Optional

Filter by one or multiple specific services of your portfolio

locationsinteger · int32[]Optional

Filter by one or multiple specific locations

employeesinteger · int32[]Optional

Filter by one or multiple specific employees

groupsinteger · int32[]Optional

Filter by one or multiple specific groups

statusesstring[]Optional

Filter by one or multiple specific statuses

activebooleanOptional

Filter the instances which are active or not active. When null, all instances will be returned. Default: null

subscriptionPeriodRenewalsinteger · int32[]Optional

Filter by one or multiple specific values for the period renewal, e.g. to filter all without a renewal use 0

modifiedSincestring · date-timeOptional

Filter the instances modified after the specified date. A modification is identified when: the assignment changed, the instance got activated, the instance got cancelled

expiresAfterstring · date-timeOptional

Filter the instances which expire after this date

expiresBeforestring · date-timeOptional

Filter the instances which expire before this date

searchstringOptional

Filter for id, service name, inventory number, employee first and last name, group, location name or metadata values

sortBystring · enumOptional

Sort the instances by a given criterion

Possible values:

sortOrderstring · enumOptional

Order in which the result of a list request is sorted.

Possible values:

offsetinteger · int32Optional

Specifies the index of the first instances to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of instances to return

Default: 100

Responses

200

OK: A list of service instances.

application/json

totalinteger · int32Required

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key.

application/json

403

Forbidden: Resource access denied or resource does not exist anymore.

application/json

get/v1/sales/customers/{customerId}/service-instances

HTTPcURLJavaScriptPython

GET /v1/sales/customers/{customerId}/service-instances HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "supplier": {
        "id": 4,
        "name": "foo Inc.",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "service": {
        "id": 4,
        "name": "Basic Plan",
        "category": "text",
        "ean": "0194253408253",
        "externalId": "E54363",
        "supplierName": "text",
        "previewImageLink": "text",
        "type": "service",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "customer": {
        "id": 4,
        "name": "foo Inc.",
        "customerNumber": "C00001",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "location": {
        "id": 1,
        "name": "HQ New York",
        "type": "location",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "group": {
        "id": 42,
        "name": "Project 1337",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "employee": {
        "id": 1,
        "firstName": "Pierce",
        "lastName": "Bell",
        "fullName": "text",
        "email": "[e-mail]",
        "username": "[e-mail]",
        "costCenter": "4645-2343",
        "costCenterId": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "activationDate": "2026-07-15T16:46:44.790Z",
      "lastModifiedDate": "2026-07-15T16:46:44.790Z",
      "expirationDate": "2026-07-15T16:46:44.790Z",
      "processStatus": "ordered",
      "active": true,
      "oneTimeCosts": 92.99,
      "recurringCosts": 109.9,
      "currencyCode": "EUR",
      "subscriptionPeriod": 12,
      "subscriptionPeriodRenewal": 1,
      "note": "This is just a <b>custom note</b>.",
      "metadata": [
        {
          "key": "Serial number",
          "value": "SN45346X2345",
          "scope": "public"
        }
      ],
      "id": 42,
      "inventoryNumber": "EQ642",
      "costCenter": "4645-2343",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single service instance of a customer by its id

get

Authorizations

ApiKey

X-API-KEYstringRequired

Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.

Path parameters

customerIdinteger · int32Required

The identifier of the customer which owns the service instance.

instanceIdinteger · int32Required

The identifier of the service instance.

Responses

200

OK: The requested service instance.

application/json

activationDatestring · date-time · nullableOptional

The date the service instance was activated.

lastModifiedDatestring · date-time · nullableOptional

The date the service instance was last modified.

expirationDatestring · date-time · nullableOptional

The date when the service instance should expire.

processStatusstring · nullableOptional

The processing status of the service instance.

Example: ordered

activebooleanOptional

True if the service instance is active, otherwise false.

Example: true

oneTimeCostsnumber · doubleOptional

One-time purchase costs of the instance in its life cycle to date.

Example: 92.99

recurringCostsnumber · doubleOptional

The current recurring costs for the service instance. Only calculated for active instances.

Example: 109.9

currencyCodestring · nullableOptional

Currency in ISO 4217

Example: EUR

subscriptionPeriodinteger · int32 · nullableOptional

The minimum subscription period (in months) for the services instance.

Example: 12

subscriptionPeriodRenewalinteger · int32 · nullableOptional

Number of months a subscription is renewed after its expiration time if it has not been terminated.

Example: 1

notestring · nullableOptional

A note on the service instance. Supports html formatted text including inline css styles.

Example: This is just a <b>custom note</b>.

idinteger · int32Required

The id to identify the service instance in the system.

Example: 42

inventoryNumberstring · max: 50 · nullableOptional

The inventory number of the service instance.

Example: EQ642

costCenterstring · nullableOptional

The name of the cost center to which the service instance belongs.

Example: 4645-2343

400

Bad request: See response message for details.

application/json

401

Unauthorized: Invalid api key or expired access token.

application/json

403

Forbidden: Resource access denied.

application/json

404

NotFound: Requested resource could not be found.

application/json

get/v1/sales/customers/{customerId}/service-instances/{instanceId}

HTTPcURLJavaScriptPython

GET /v1/sales/customers/{customerId}/service-instances/{instanceId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "supplier": {
    "id": 4,
    "name": "foo Inc.",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "service": {
    "id": 4,
    "name": "Basic Plan",
    "category": "text",
    "ean": "0194253408253",
    "externalId": "E54363",
    "supplierName": "text",
    "previewImageLink": "text",
    "type": "service",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "customer": {
    "id": 4,
    "name": "foo Inc.",
    "customerNumber": "C00001",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "location": {
    "id": 1,
    "name": "HQ New York",
    "type": "location",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "group": {
    "id": 42,
    "name": "Project 1337",
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "employee": {
    "id": 1,
    "firstName": "Pierce",
    "lastName": "Bell",
    "fullName": "text",
    "email": "[e-mail]",
    "username": "[e-mail]",
    "costCenter": "4645-2343",
    "costCenterId": 1,
    "self": {
      "href": "text",
      "method": "text"
    }
  },
  "activationDate": "2026-07-15T16:46:44.790Z",
  "lastModifiedDate": "2026-07-15T16:46:44.790Z",
  "expirationDate": "2026-07-15T16:46:44.790Z",
  "processStatus": "ordered",
  "active": true,
  "oneTimeCosts": 92.99,
  "recurringCosts": 109.9,
  "currencyCode": "EUR",
  "subscriptionPeriod": 12,
  "subscriptionPeriodRenewal": 1,
  "note": "This is just a <b>custom note</b>.",
  "metadata": [
    {
      "key": "Serial number",
      "value": "SN45346X2345",
      "scope": "public"
    }
  ],
  "id": 42,
  "inventoryNumber": "EQ642",
  "costCenter": "4645-2343",
  "self": {
    "href": "text",
    "method": "text"
  }
}