Sales | Customers
Retrieve a list of customers.
You can only access 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.
If null, all customers are returned. True: only active | false: only inactive customers are returned.
Filter the customers created after the specified date.
Filter the customers by one or multiple names
Filter the customers by one or multiple customer numbers
Parameters according to which a customer 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: A list of customers.
Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
GET /v1/sales/customers HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"previous": {
"href": "text",
"method": "text"
},
"next": {
"href": "text",
"method": "text"
},
"items": [
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"active": true,
"contactName": "John Doe",
"contactEmail": "contact@foo.inc",
"contactPhone": "+49 555 6273",
"customAttribute1": "text",
"customAttribute2": "text",
"customAttribute3": "text",
"accountManager": {
"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"
}
},
"language": "en",
"companyAddress": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234",
"id": 83,
"self": {
"href": "text",
"method": "text"
}
},
"referredBy": {
"referredOn": "2026-01-01T00:00:00.000Z",
"company": {
"id": 4,
"name": "foo Inc.",
"customerNumber": "C00001",
"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"
}
}
},
"id": 4,
"name": "foo Inc.",
"customerNumber": "C00001",
"self": {
"href": "text",
"method": "text"
}
}
],
"total": 1,
"self": {
"href": "text",
"method": "text"
}
}You can only create customers for your provider entity.
When a customer is created, an instance of the "Customer Account" system service is also always added to the customer's approval cart.
Note: active customers are allowed to place orders.
Required for authorization in every request. You can request an API-Key for your tenant in the integrations section of the equipme App.
Request payload to create a new customer for the calling provider entity.
The name of the customer.
foo Inc.Optional identifier of the customer defined by the supplier.
C00001The description of the customer.
True if the customer is active and is allowed to place orders, false otherwise.
trueValue of the first custom attribute as defined in the settings
Value of the second custom attribute as defined in the settings
Value of the third custom attribute as defined in the settings
The name of the contact person at the customer.
John DoeThe mail of the contact person at the customer.
contact@foo.incThe phone number of the contact person at the customer.
+49 555 6273Language options for a customer or user interaction
The id of the responsible sales person for the customer. This employee receives planner access to the customer, when not specified otherwise through the tenant permissions.
Created: The created customer.
The identifier of the customer.
The description of the customer.
True if the customer is active, false otherwise.
trueThe name of the contact person at the customer.
John DoeThe email address of the contact person at the customer.
contact@foo.incThe phone number of the contact person at the customer.
+49 555 6273Value of the first custom attribute as defined in the settings
Value of the second custom attribute as defined in the settings
Value of the third custom attribute as defined in the settings
Language options for a customer or user interaction
The identifier of the customer.
4The name of the customer.
foo Inc.Optional identifier of the customer defined by the supplier.
C00001Bad request: See response message for details.
Unauthorized: Invalid api key.
Forbidden: Resource access denied or resource does not exist anymore.
POST /v1/sales/customers HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 890
{
"name": "foo Inc.",
"customerNumber": "C00001",
"description": "text",
"active": true,
"customAttribute1": "text",
"customAttribute2": "text",
"customAttribute3": "text",
"contactName": "John Doe",
"contactEmail": "contact@foo.inc",
"contactPhone": "+49 555 6273",
"language": "en",
"tenantPermissions": [
{
"employeeId": 42,
"role": "administrator"
}
],
"accountManager": 1,
"companyAddress": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234"
},
"billingAddress": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234"
}
}{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"active": true,
"contactName": "John Doe",
"contactEmail": "contact@foo.inc",
"contactPhone": "+49 555 6273",
"customAttribute1": "text",
"customAttribute2": "text",
"customAttribute3": "text",
"accountManager": {
"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"
}
},
"language": "en",
"companyAddress": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234",
"id": 83,
"self": {
"href": "text",
"method": "text"
}
},
"referredBy": {
"referredOn": "2026-01-01T00:00:00.000Z",
"company": {
"id": 4,
"name": "foo Inc.",
"customerNumber": "C00001",
"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"
}
}
},
"id": 4,
"name": "foo Inc.",
"customerNumber": "C00001",
"self": {
"href": "text",
"method": "text"
}
}You can only access 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.
OK: The requested customer.
The identifier of the customer.
The description of the customer.
True if the customer is active, false otherwise.
trueThe name of the contact person at the customer.
John DoeThe email address of the contact person at the customer.
contact@foo.incThe phone number of the contact person at the customer.
+49 555 6273Value of the first custom attribute as defined in the settings
Value of the second custom attribute as defined in the settings
Value of the third custom attribute as defined in the settings
Language options for a customer or user interaction
The identifier of the customer.
4The name of the customer.
foo Inc.Optional identifier of the customer defined by the supplier.
C00001Bad 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} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"active": true,
"contactName": "John Doe",
"contactEmail": "contact@foo.inc",
"contactPhone": "+49 555 6273",
"customAttribute1": "text",
"customAttribute2": "text",
"customAttribute3": "text",
"accountManager": {
"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"
}
},
"language": "en",
"companyAddress": {
"line1": "equipme GmbH",
"street": "W 55th St",
"number": "240",
"addition": "3rd floor",
"city": "New York",
"postalCode": "10019",
"countryCode": "US",
"regionCode": "NY",
"regionName": "New York",
"dependentLocality": "Chilmington Green",
"phoneNumber": "+1 212-555-1234",
"id": 83,
"self": {
"href": "text",
"method": "text"
}
},
"referredBy": {
"referredOn": "2026-01-01T00:00:00.000Z",
"company": {
"id": 4,
"name": "foo Inc.",
"customerNumber": "C00001",
"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"
}
}
},
"id": 4,
"name": "foo Inc.",
"customerNumber": "C00001",
"self": {
"href": "text",
"method": "text"
}
}Overwrites all existing data with that from the request body.
Note: active customers are allowed to place orders.
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.
The name of the customer.
foo Inc.Optional identifier of the customer defined by the supplier.
C00001The description of the customer. Note: Value null won't override the current value. You can provide an empty string to clear this field.
True if the customer is active and is allowed to place orders, false otherwise.
trueValue of the first custom attribute as defined in the settings Note: Value null won't override the current value. You can provide an empty string to clear this field.
Value of the second custom attribute as defined in the settings Note: Value null won't override the current value. You can provide an empty string to clear this field.
Value of the third custom attribute as defined in the settings Note: Value null won't override the current value. You can provide an empty string to clear this field.
Id of the responsible sales person for the customer. On update, this employee receives planner access to the customer.
The name of the contact person at the customer.
John DoeThe email address of the contact person at the customer.
contact@foo.incThe phone number of the contact person at the customer.
+49 555 6273NoContent: 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} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 267
{
"name": "foo Inc.",
"customerNumber": "C00001",
"description": "text",
"active": true,
"customAttribute1": "text",
"customAttribute2": "text",
"customAttribute3": "text",
"accountManagerId": 1,
"contactName": "John Doe",
"contactEmail": "contact@foo.inc",
"contactPhone": "+49 555 6273"
}No content
Please provide a valid JSON Patch document with the allowed fields to update. See example below for further details.
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.
NoContent: Customer successfully updated.
No content
Bad request: Body validation failed. 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.
PATCH /v1/sales/customers/{customerId} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 663
[
{
"op": "add",
"path": "/active",
"value": "true"
},
{
"op": "add",
"path": "/name",
"value": "foo Inc."
},
{
"op": "add",
"path": "/customerNumber",
"value": "C00001"
},
{
"op": "add",
"path": "/description",
"value": "stringValue"
},
{
"op": "add",
"path": "/active",
"value": "true"
},
{
"op": "add",
"path": "/customAttribute1",
"value": "stringValue"
},
{
"op": "add",
"path": "/customAttribute2",
"value": "stringValue"
},
{
"op": "add",
"path": "/customAttribute3",
"value": "stringValue"
},
{
"op": "add",
"path": "/accountManagerId",
"value": 123
},
{
"op": "add",
"path": "/contactName",
"value": "John Doe"
},
{
"op": "add",
"path": "/contactEmail",
"value": "contact@foo.inc"
},
{
"op": "add",
"path": "/contactPhone",
"value": "+49 555 6273"
}
]No content
You can only set the theme for customers of your provider entity.
Colors and logo are looked up via Brandfetch. domain can be an exact domain
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.
Request to auto-generate a customer's theme from a brand domain.
The customer's domain, name, or other Brandfetch-searchable identifier, used to look up colors and logo.
acme.comNoContent: Theme successfully updated.
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, or no brand data exists for the given domain.
Too many requests: Retry after the period given in the Retry-After header.
ServiceUnavailable: The brand lookup service could not be reached. Try again later.
PUT /v1/sales/customers/{customerId}/branding HTTP/1.1
X-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21
{
"domain": "acme.com"
}No content
Retrieve all metadata items for a customer.
Note: The metadata is not versioned.
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.
OK: The requested metadata items.
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}/metadata HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
[
{
"value": "EQ1337555",
"scope": "Supplier",
"key": "ExternalSystemId",
"self": {
"href": "text",
"method": "text"
}
}
]If the metadata key already exists, the value will be updated.
Note: The metadata is not versioned.
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.
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.
Not Found
POST /v1/sales/customers/{customerId}/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"
}
}Retrieve the metadata item for a customer.
Note: The metadata is not versioned.
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.
The metadata key to be retrieved.
OK: The requested metadata item.
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}/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.
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}/metadata/{key} HTTP/1.1
X-API-KEY: YOUR_API_KEY
Accept: */*
No content
Last updated
Was this helpful?