Sales | Customer Groups
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.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the groups.
Filter by one or multiple specific group categories
Filter by one or multiple company names related to the group
Parameters according to which groups can be sorted.
Order in which the result of a list request is sorted.
Specifies the index of the first item to return
0Specifies the maximum number of items to return (min: 1; max: 1000)
100OK: The requested groups.
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested customer could not be found.
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"
}
}The group will be related to the customer given in the url parameter.
You can only create groups for customers of your provider entity.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
Type of the group.
The name of the group.
Project 1337A customizable category of the group. Can be used to categorize groups independent from the group type.
Projects 2024A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.
Projects 2024The description of the group.
The team is responsible for customer inquiries.The email of the group.
group.mailbox@company.comPattern: ^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$Created: The created group.
Type of the group.
A customizable category of the group. Can be used to categorize groups independent from the group type.
Projects 2024A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.
Projects 2024The description of the group.
Project start: 2024/04/01The email address of the group.
group.mailbox@company.comAssigned tags
The id to identify the group in the system.
42The name of the group.
Project 1337Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
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"
}
}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.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
The identifier of the group.
OK: The requested group.
Type of the group.
A customizable category of the group. Can be used to categorize groups independent from the group type.
Projects 2024A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.
Projects 2024The description of the group.
Project start: 2024/04/01The email address of the group.
group.mailbox@company.comAssigned tags
The id to identify the group in the system.
42The name of the group.
Project 1337Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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"
}
}Overwrites all existing data with that from the request body.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
The identifier of the group to be updated.
The name of the group.
Project 1337A customizable category of the group. Can be used to categorize groups independent from the group type.
Projects 2024A customizable company name of the group. Can be used to distinguish same departments between different sub companies of the tenant.
Projects 2024The description of the group.
The team is responsible for customer inquiries.The email of the group.
group.mailbox@company.comPattern: ^[a-zA-Z0-9.!#$%&’*+/=?^_`{|}~-]+@[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$NoContent: Request has succeeded.
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
The identifier of the group to be deleted.
NoContent: Request has succeeded.
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
DELETE /v1/sales/customers/{customerId}/groups/{groupId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
No content
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.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
The identifier of the group.
Parameters according to which an employee can be sorted.
Order in which the result of a list request is sorted.
Specifies the index of the first item to return
0Specifies the maximum number of items to return (min: 1; max: 1000)
100OK: The requested group members.
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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-01-01T00:00:00.000Z",
"onboardingDate": "2026-01-01T00:00:00.000Z",
"offboardingDate": "2026-01-01T00:00:00.000Z",
"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"
}
}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.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
The identifier of the group to which new members are to be added.
The id of the group member.
132NoContent: Request has succeeded.
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
The identifier of the group whose members are to be deleted.
The id of the group member.
132NoContent: Request has succeeded.
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Ok
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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"
}
}Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
The identifier of the group for which the metadata entry is to be created.
DTO for creating a new metadata entry for a given resource which implements the logic
Key for the new metadata entry
Metadata value
Created: The created metadata entry.
Metadata value
EQ1337555Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.
SupplierMetadata key used as a unique identifier for the metadata item.
ExternalSystemIdBad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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"
}
}Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Ok
Metadata value
EQ1337555Metadata scope. Can be Customer or Supplier to indicate the metadata is specific to a customer or supplier.
SupplierMetadata key used as a unique identifier for the metadata item.
ExternalSystemIdBad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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"
}
}Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
NoContent
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
DELETE /v1/sales/customers/{customerId}/groups/{groupId}/metadata/{key} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
No content
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.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
The identifier of the group.
Filter by one or multiple specific services of your portfolio
Filter by one or multiple specific statuses
Filter the instances which are active or not active. When null, all instances will be returned. Default: null
Filter by one or multiple specific values for the period renewal, e.g. to filter all without a renewal use 0
Filter the instances modified after the specified date. A modification is identified when: the assignment changed, the instance got activated, the instance got cancelled
Filter the instances which expire after this date
Filter the instances which expire before this date
Filter for id, service name, inventory number, employee first and last name, group, location name or metadata values
Sort the items by a given criterion.
Order in which the result of a list request is sorted.
Specifies the index of the first item to return
0Specifies the maximum number of items to return (min: 1; max: 1000)
100OK: The requested service instances of a group.
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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-01-01T00:00:00.000Z",
"lastModifiedDate": "2026-01-01T00:00:00.000Z",
"expirationDate": "2026-01-01T00:00:00.000Z",
"processStatus": "ordered",
"active": true,
"oneTimeCosts": 92.99,
"recurringCosts": 109.9,
"currencyCode": "EUR",
"subscriptionPeriod": 12,
"subscriptionPeriodRenewal": 1,
"differentInvoiceIssuer": "equipme Leasing Corp",
"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"
}
}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.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
The identifier of the group to which new service instances are to be added.
The id of the service instance.
28NoContent: Request has succeeded.
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
The identifier of the customer which owns the group.
The identifier of the group from which the service instances are to be deleted.
The id of the service instance.
28NoContent: Request has succeeded.
No content
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
NotFound: Requested resource could not be found.
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
Was this helpful?