Sales | Customer Groups

List groups of a customer

get

Retrieve a list of groups related to the customer specified in the url parameter.

You can only access groups of customers of your provider entity.

Authorizations

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 groups.

Query parameters

categoriesstring[]Optional

Filter by one or multiple specific group categories

companyNamesstring[]Optional

Filter by one or multiple company names related to the group

sortBystring · enumOptional

Parameters according to which groups can be sorted.

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 item to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of items to return (min: 1; max: 1000)

Default: 100

Responses

200

OK: The requested groups.

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

404

NotFound: Requested customer could not be found.

application/json

get/v1/sales/customers/{customerId}/groups

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

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "type": "custom",
      "category": "Projects 2024",
      "companyName": "Projects 2024",
      "description": "Project start: 2024/04/01",
      "email": "group.mailbox@company.com",
      "manager": [
        {
          "id": 1,
          "firstName": "Pierce",
          "lastName": "Bell",
          "fullName": "text",
          "email": "p.bell@foo.io",
          "username": "j.doe@foo.inc",
          "costCenter": "4645-2343",
          "costCenterId": 1,
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      ],
      "tags": [
        "text"
      ],
      "id": 42,
      "name": "Project 1337",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Create a group for a customer

post

The group will be related to the customer given in the url parameter.

You can only create groups for customers of your provider entity.

Authorizations

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 group.

Body

typestring · enumRequired

Type of the group.

Possible values:

namestring · max: 100Required

The name of the group.

Example: Project 1337

categorystring · max: 50 · nullableOptional

A customizable category of the group. Can be used to categorize groups independent from the group type.

Example: Projects 2024

companyNamestring · max: 100 · nullableOptional

A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.

Example: Projects 2024

descriptionstring · max: 500 · nullableOptional

The description of the group.

Example: The team is responsible for customer inquiries.

emailstring · max: 100 · nullableOptional

The email of the group.

Example: group.mailbox@company.comPattern: ^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$

Responses

201

Created: The created group.

application/json

typestring · enumOptional

Type of the group.

Possible values:

categorystring · nullableOptional

A customizable category of the group. Can be used to categorize groups independent from the group type.

Example: Projects 2024

companyNamestring · max: 100 · nullableOptional

A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.

Example: Projects 2024

descriptionstring · nullableOptional

The description of the group.

Example: Project start: 2024/04/01

emailstring · nullableOptional

The email address of the group.

Example: group.mailbox@company.com

tagsstring[] · nullableOptional

Assigned tags

idinteger · int32Required

The id to identify the group in the system.

Example: 42

namestring · max: 50Required

The name of the group.

Example: Project 1337

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

post/v1/sales/customers/{customerId}/groups

POST /v1/sales/customers/{customerId}/groups HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 196

{
  "type": "custom",
  "name": "Project 1337",
  "category": "Projects 2024",
  "companyName": "Projects 2024",
  "description": "The team is responsible for customer inquiries.",
  "email": "group.mailbox@company.com"
}

{
  "type": "custom",
  "category": "Projects 2024",
  "companyName": "Projects 2024",
  "description": "Project start: 2024/04/01",
  "email": "group.mailbox@company.com",
  "manager": [
    {
      "id": 1,
      "firstName": "Pierce",
      "lastName": "Bell",
      "fullName": "text",
      "email": "p.bell@foo.io",
      "username": "j.doe@foo.inc",
      "costCenter": "4645-2343",
      "costCenterId": 1,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "tags": [
    "text"
  ],
  "id": 42,
  "name": "Project 1337",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Retrieve a single group by its id

get

The requested group must be related to the customer given in the url parameter otherwise it can not be found.

You can only access groups of customers of your provider entity.

Authorizations

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 group.

groupIdinteger · int32Required

The identifier of the group.

Responses

200

OK: The requested group.

application/json

typestring · enumOptional

Type of the group.

Possible values:

categorystring · nullableOptional

A customizable category of the group. Can be used to categorize groups independent from the group type.

Example: Projects 2024

companyNamestring · max: 100 · nullableOptional

A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.

Example: Projects 2024

descriptionstring · nullableOptional

The description of the group.

Example: Project start: 2024/04/01

emailstring · nullableOptional

The email address of the group.

Example: group.mailbox@company.com

tagsstring[] · nullableOptional

Assigned tags

idinteger · int32Required

The id to identify the group in the system.

Example: 42

namestring · max: 50Required

The name of the group.

Example: Project 1337

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

404

NotFound: Requested resource could not be found.

application/json

get/v1/sales/customers/{customerId}/groups/{groupId}

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

{
  "type": "custom",
  "category": "Projects 2024",
  "companyName": "Projects 2024",
  "description": "Project start: 2024/04/01",
  "email": "group.mailbox@company.com",
  "manager": [
    {
      "id": 1,
      "firstName": "Pierce",
      "lastName": "Bell",
      "fullName": "text",
      "email": "p.bell@foo.io",
      "username": "j.doe@foo.inc",
      "costCenter": "4645-2343",
      "costCenterId": 1,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "tags": [
    "text"
  ],
  "id": 42,
  "name": "Project 1337",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Update an existing group

put

Overwrites all existing data with that from the request body.

Authorizations

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 group.

groupIdinteger · int32Required

The identifier of the group to be updated.

Body

namestring · max: 100Required

The name of the group.

Example: Project 1337

categorystring · max: 50 · nullableOptional

A customizable category of the group. Can be used to categorize groups independent from the group type.

Example: Projects 2024

companyNamestring · max: 100 · nullableOptional

A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.

Example: Projects 2024

descriptionstring · max: 500 · nullableOptional

The description of the group.

Example: The team is responsible for customer inquiries.

emailstring · max: 100 · nullableOptional

The email of the group.

Example: group.mailbox@company.comPattern: ^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$

Responses

204

NoContent: Request has succeeded.

No content

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

404

NotFound: Requested resource could not be found.

application/json

put/v1/sales/customers/{customerId}/groups/{groupId}

PUT /v1/sales/customers/{customerId}/groups/{groupId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 180

{
  "name": "Project 1337",
  "category": "Projects 2024",
  "companyName": "Projects 2024",
  "description": "The team is responsible for customer inquiries.",
  "email": "group.mailbox@company.com"
}

No content

Delete a group

delete

Authorizations

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 group.

groupIdinteger · int32Required

The identifier of the group to be deleted.

Responses

204

NoContent: Request has succeeded.

No content

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

404

NotFound: Requested resource could not be found.

application/json

delete/v1/sales/customers/{customerId}/groups/{groupId}

DELETE /v1/sales/customers/{customerId}/groups/{groupId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Retrieve the members of a group

get

The requested group must be related to the customer given in the url parameter otherwise it can not be found.

You can only access groups of customers of your provider entity.

Authorizations

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 group.

groupIdinteger · int32Required

The identifier of the group.

Query parameters

sortBystring · enumOptional

Parameters according to which an employee can be sorted.

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 item to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of items to return (min: 1; max: 1000)

Default: 100

Responses

200

OK: The requested group members.

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

404

NotFound: Requested resource could not be found.

application/json

get/v1/sales/customers/{customerId}/groups/{groupId}/members

GET /v1/sales/customers/{customerId}/groups/{groupId}/members HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "employer": {
        "id": 83,
        "name": "equipme GmbH",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "workplace": {
        "id": 1,
        "name": "HQ New York",
        "type": "location",
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "supervisor": {
        "id": 1,
        "firstName": "Pierce",
        "lastName": "Bell",
        "fullName": "text",
        "email": "p.bell@foo.io",
        "username": "j.doe@foo.inc",
        "costCenter": "4645-2343",
        "costCenterId": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "employeeNumber": 42,
      "position": "Account Manager",
      "privateEmail": "p.bell@abc.com",
      "phoneBusiness": "+49 555 6273",
      "phoneMobile": "+49 555 4523",
      "notes": "Will take a sabbatical in July.",
      "created": "2026-07-15T16:58:08.730Z",
      "onboardingDate": "2026-07-15T16:58:08.730Z",
      "offboardingDate": "2026-07-15T16:58:08.730Z",
      "status": "onboarding",
      "groups": [
        {
          "type": "custom",
          "category": "Projects 2024",
          "companyName": "Projects 2024",
          "description": "Project start: 2024/04/01",
          "email": "group.mailbox@company.com",
          "manager": [
            {
              "id": 1,
              "firstName": "Pierce",
              "lastName": "Bell",
              "fullName": "text",
              "email": "p.bell@foo.io",
              "username": "j.doe@foo.inc",
              "costCenter": "4645-2343",
              "costCenterId": 1,
              "self": {
                "href": "text",
                "method": "text"
              }
            }
          ],
          "tags": [
            "text"
          ],
          "id": 42,
          "name": "Project 1337",
          "self": {
            "href": "text",
            "method": "text"
          }
        }
      ],
      "id": 1,
      "firstName": "Pierce",
      "lastName": "Bell",
      "fullName": "text",
      "email": "p.bell@foo.io",
      "username": "j.doe@foo.inc",
      "costCenter": "4645-2343",
      "costCenterId": 1,
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Add group members

post

The group will be related to the customer given in the url parameter.

You can only add members to groups for customers of your provider entity.

Authorizations

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 group.

groupIdinteger · int32Required

The identifier of the group to which new members are to be added.

Bodyobject · GroupMemberReference[]

idinteger · int32Optional

The id of the group member.

Example: 132

Responses

204

NoContent: Request has succeeded.

No content

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

404

NotFound: Requested resource could not be found.

application/json

post/v1/sales/customers/{customerId}/groups/{groupId}/members

POST /v1/sales/customers/{customerId}/groups/{groupId}/members HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 12

[
  {
    "id": 132
  }
]

No content

Delete group members

delete

Authorizations

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 group.

groupIdinteger · int32Required

The identifier of the group whose members are to be deleted.

Bodyobject · GroupMemberReference[]

idinteger · int32Optional

The id of the group member.

Example: 132

Responses

204

NoContent: Request has succeeded.

No content

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

404

NotFound: Requested resource could not be found.

application/json

delete/v1/sales/customers/{customerId}/groups/{groupId}/members

DELETE /v1/sales/customers/{customerId}/groups/{groupId}/members HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 12

[
  {
    "id": 132
  }
]

No content

Get all metadata entries for a specific group

get

Authorizations

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

groupIdinteger · int32Required

Responses

200

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

404

NotFound: Requested resource could not be found.

get/v1/sales/customers/{customerId}/groups/{groupId}/metadata

GET /v1/sales/customers/{customerId}/groups/{groupId}/metadata HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "previous": {
    "href": "text",
    "method": "text"
  },
  "next": {
    "href": "text",
    "method": "text"
  },
  "items": [
    {
      "value": "EQ1337555",
      "scope": "Supplier",
      "key": "ExternalSystemId",
      "self": {
        "href": "text",
        "method": "text"
      }
    }
  ],
  "total": 1,
  "self": {
    "href": "text",
    "method": "text"
  }
}

Create a metadata entry for a group

post

Authorizations

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 group.

groupIdinteger · int32Required

The identifier of the group for which the metadata entry is to be created.

Body

DTO for creating a new metadata entry for a given resource which implements the logic

keystring · max: 150 · nullableOptional

Key for the new metadata entry

valuestring · max: 500 · nullableOptional

Metadata value

Responses

201

Created: The created metadata entry.

application/json

valuestring · max: 500 · nullableOptional

Metadata value

Example: EQ1337555

scopestring · nullableOptional

Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.

Example: Supplier

keystring · max: 150Required

Metadata key used as a unique identifier for the metadata item.

Example: ExternalSystemId

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

404

NotFound: Requested resource could not be found.

application/json

post/v1/sales/customers/{customerId}/groups/{groupId}/metadata

POST /v1/sales/customers/{customerId}/groups/{groupId}/metadata HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "key": "text",
  "value": "text"
}

{
  "value": "EQ1337555",
  "scope": "Supplier",
  "key": "ExternalSystemId",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Get a metadata entry for a specific group by key

get

Authorizations

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

groupIdinteger · int32Required

keystringRequired

Responses

200

application/json

valuestring · max: 500 · nullableOptional

Metadata value

Example: EQ1337555

scopestring · nullableOptional

Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.

Example: Supplier

keystring · max: 150Required

Metadata key used as a unique identifier for the metadata item.

Example: ExternalSystemId

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

404

NotFound: Requested resource could not be found.

get/v1/sales/customers/{customerId}/groups/{groupId}/metadata/{key}

GET /v1/sales/customers/{customerId}/groups/{groupId}/metadata/{key} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

{
  "value": "EQ1337555",
  "scope": "Supplier",
  "key": "ExternalSystemId",
  "self": {
    "href": "text",
    "method": "text"
  }
}

Delete a metadata entry for a specific group

delete

Authorizations

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

groupIdinteger · int32Required

keystringRequired

Responses

204

NoContent

No content

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

404

NotFound: Requested resource could not be found.

delete/v1/sales/customers/{customerId}/groups/{groupId}/metadata/{key}

DELETE /v1/sales/customers/{customerId}/groups/{groupId}/metadata/{key} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*

No content

Retrieve the service instances of a group

get

The requested group must be related to the customer given in the url parameter otherwise it can not be found.

You can only access groups of customers of your provider entity.

Authorizations

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 group.

groupIdinteger · int32Required

The identifier of the group.

Query parameters

servicesinteger · int32[]Optional

Filter by one or multiple specific services of your portfolio

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 items 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 item to return

Default: 0

limitinteger · int32Optional

Specifies the maximum number of items to return (min: 1; max: 1000)

Default: 100

Responses

200

OK: The requested service instances of a group.

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

404

NotFound: Requested resource could not be found.

application/json

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

GET /v1/sales/customers/{customerId}/groups/{groupId}/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": "p.bell@foo.io",
        "username": "j.doe@foo.inc",
        "costCenter": "4645-2343",
        "costCenterId": 1,
        "self": {
          "href": "text",
          "method": "text"
        }
      },
      "activationDate": "2026-07-15T16:58:08.730Z",
      "lastModifiedDate": "2026-07-15T16:58:08.730Z",
      "expirationDate": "2026-07-15T16:58:08.730Z",
      "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"
  }
}

Add service instances to a group

post

The group will be related to the customer given in the url parameter.

You can only add service instances to groups for customers of your provider entity.

Note: Service instances can only be related to one group. Therefore if one of the given service instances is already assigned to another group, this relation will change and the instance will not be related to the previous group anymore.

Authorizations

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 group.

groupIdinteger · int32Required

The identifier of the group to which new service instances are to be added.

Bodyobject · GroupServiceInstanceReference[]

idinteger · int32 · min: 1 · max: 2147483647Required

The id of the service instance.

Example: 28

Responses

204

NoContent: Request has succeeded.

No content

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

404

NotFound: Requested resource could not be found.

application/json

post/v1/sales/customers/{customerId}/groups/{groupId}/service-instances

POST /v1/sales/customers/{customerId}/groups/{groupId}/service-instances HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 11

[
  {
    "id": 28
  }
]

No content

Delete service instances from a group

delete

Authorizations

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 group.

groupIdinteger · int32Required

The identifier of the group from which the service instances are to be deleted.

Bodyobject · GroupServiceInstanceReference[]

idinteger · int32 · min: 1 · max: 2147483647Required

The id of the service instance.

Example: 28

Responses

204

NoContent: Request has succeeded.

No content

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

404

NotFound: Requested resource could not be found.

application/json

delete/v1/sales/customers/{customerId}/groups/{groupId}/service-instances

DELETE /v1/sales/customers/{customerId}/groups/{groupId}/service-instances HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 11

[
  {
    "id": 28
  }
]

No content

Last updated 4 hours ago

Was this helpful?