Customers
Endpoints to work with the customers of a partner.
Get customers
GET /api/internal/v1/partners/:partner_id/customers
Get the customers of a partner.
The request must be performed by an authenticated user with permission customers.read and partner access.
Path Parameters
partner_id
integer
The if of the partner.
Query Parameters
search
string
Filter customers by name.
Create customer
POST /api/internal/v1/partners/:partner_id/customers
Create a new customer.
The request must be performed by an authenticated user with permission customers.create and partner access.
Path Parameters
partner_id
integer
The id of the partner.
Request Body
first_name
string
The first name of the customer.
last_name
string
The last name of the customer.
gender
string
The gender of the customer. Allowed values: 0,1,2. More details here: https://en.wikipedia.org/wiki/ISO/IEC_5218
string
The email address of the customer.
birthdate
string
The customer birthdate. Format: YYYY-MM-DD
color_code
string
Hex color code used in the calendar for this customer.
note
string
Internal note about the customer.
position
string
The customer position (occupation, eg: Software Developer).
number
string
The customer number.
phone_number.prefix
string
The phone number prefix of the customer.
phone_number.number
string
The phone number of the customer.
address.country_id
integer
The country of the address. Required if any of the following are given: address.state_id, address.post_code, address.street_name, address.street_number, address.additional_information
address.state_id
integer
The state of the address. Required if any of the following are present: address.country_id, address.post_code, address.street_name, address.street_number, address.additional_information
address.city
string
The city of the address. Required if any of the following are present: address.country_id, address.state_id, address.post_code, address.street_name, address.street_number, address.additional_information
address.post_code
string
The post code of the address. Required if any of the following are present: address.country_id, address.state_id, address.city, address.street_name, address.street_number, address.additional_information
address.street_name
string
The street name of the address. Required if any of the following are present: address.country_id, address.state_id, address.city, address.post_code, address.street_number, address.additional_information
address.street_number
string
The address street number.
address.additional_info
string
Additional info for the address
PUT /api/internal/v1/partners/:partner_id/operators/:operator_id
Request Body
address.street_name
string
The street name of the address. Required if any of the following are present: address.country_id, address.street_number, address.post_code, address.city, address.state_id, address.country_id
PUT /api/internal/v1/partners/:partner_id/operators/:operator_id
Request Body
address.street_name
string
The street name of the address. Required if any of the following are present: address.country_id, address.street_number, address.post_code, address.city, address.state_id, address.country_id
PUT /api/internal/v1/partners/:partner_id/operators/:operator_id
Request Body
address.street_name
string
The street name of the address. Required if any of the following are present: address.country_id, address.street_number, address.post_code, address.city, address.state_id, address.country_id
Get customer
GET /api/internal/v1/partners/:partner_id/customers/:customer_id
Get a customer by its id.
The action must be performed by an authenticated user with permission customers.read and partner access.
Path Parameters
customer_id
integer
The id of the customer.
partner_id
integer
The id of the partner.
Update customer
PUT /api/internal/v1/partners/:partner_id/customers/:customer_id
Update a customer by its id.
The action must be performed by an authenticated user with permission customers.update and partner access.
Path Parameters
customer_id
integer
The id of the customer.
partner_id
integer
The id of the partner.
Get customer groups
GET /api/internal/v1/partners/:partner_id/customers/:customer_id/groups
Get the groups of a customer.
The operation must be performed by an authenticated user with permission customers.readand partner access.
Path Parameters
partner_id
integer
The ID of the partner.
customer_id
integer
The ID of the customer.
Get customer organizations
GET /api/internal/v1/partners/:partner_id/customers/:customer_id/organizations
Get the organizations of a customer.
The operation must be performed by an authenticated user with permission customers.read and partner access.
Path Parameters
partner_id
integer
The ID of the partner.
customer_id
integer
The ID of the customer.
Get customer contact persons
GET /api/internal/v1/partners/:partner_id/customers/:customer_id/contact-persons
Get the contact persons of a customer.
Path Parameters
partner_id
integer
The ID of the partner.
customer_id
integer
The ID of the customer.
Create a customer contact person
POST /api/internal/v1/partners/:partner_id/customers/:customer_id/contact-persons
Create a contact person for the given customer.
Path Parameters
partner_id
integer
The ID of the partner.
customer_id
integer
The ID of the customer.
Request Body
department
string
The department of the contact person (in german Funktion | Beruf | Position)
first_name
string
The first name of the contact person.
last_name
string
The last name of the contact person.
title
string
The title of the contact person. Eg. Dipl. Ing.
gender
integer
The gender of the contact person. Allowed values: 0,1,2. More details here: https://wikipedia.org/wiki/ISO/IEC_5218
string
The email address of the contact person.
phone_number.prefix
number
The phone number prefix of the contact person.
phone_number.number
number
The phone number of the contact person.
Get customer contact person
GET /api/internal/v1/partners/:partner_id/customers/:customer_id/contact-persons/:contact_person_id
Get a specific contact person of the customer.
Path Parameters
partner_id
integer
The ID of the partner.
customer_id
integer
The ID of the customer.
contact_person_id
integer
The ID of the customer contact person.
Update a customer contact person
PUT /api/internal/v1/partners/:partner_id/customers/:customer_id/contact-persons/:contact_person_id
This endpoint accepts the same body parameters as the one used to create a customer contact person.
Path Parameters
partner_id
integer
The ID of the partner.
customer_id
integer
The ID of the customer.
contact_person_id
integer
The ID of the contact person.
Delete a customer contact person
DELETE /api/internal/v1/partners/:partner_id/customers/:customer_id/contact-persons/:contact_person_id
Path Parameters
partner_id
integer
The ID of the partner.
customer_id
integer
The ID of the customer.
contact_person_id
integer
The ID of the contact person.
Get customer participants
GET /api/internal/v1/partners/:partner_id/customers/:customer_id/participants
Path Parameters
partner_id
integer
customer_id
integer
Last updated
Was this helpful?