Organizations
Endpoints for working with organizations.
Get organizations
GET /api/internal/v1/partners/:partner_id/organizations
Get the organizations of the given partner.
Path Parameters
partner_id
string
The id of the partner.
Query Parameters
search
string
Filter organizations by name.
types
array
Filter organizations by type. Any of the following are allowed: company, school, kindergarten, hobby_group, club.
Get organization types
GET /api/internal/v1/partners/:partner_id/organizations/types
Get the allowed types of an organization.
Path Parameters
partner_id
integer
The id of the partner.
Get organization
GET /api/internal/v1/partners/:partner_id/organizations/:organization_id
Get a specific organization.
Path Parameters
partner_id
integer
The id of the partner.
organization_id
integer
The id of the organization.
Create organization
POST /api/internal/v1/partners/:partner_id/organizations
Create a new organization.
Path Parameters
partner_id
integer
The id of the partner.
Request Body
address.country_id
integer
address.state_id
integer
address.city
string
address.post_code
number
address.street_name
string
address.street_number
string
address.additional_information
string
fax_number.number
string
The number of the organization's fax number.
fax_number.prefix
string
The prefix of the organization's fax number.
phone_number.number
string
The number of the organization's phone number.
phone_number.prefix
string
The prefix of the organization's phone number.
name
string
The name of the organization.
type
string
The type of the organization. Possible values: club, company, school, hobby_group, kindergarten. Since new types can be added, use the provided endpoint to get the allowed types.
string
The E-Mail address of the organization.
internal_note
string
Internal note regarding the organization.
founding_year
number
The founding year of the organization.
uid
string
The UID of the organization.
zvr
string
The ZVR of the organization.
dvr
string
The DVR of the organization.
Update organization
PUT /api/internal/v1/partners/:partner_id/organizations/:organization_id
Update the given organization.
Path Parameters
partner_id
integer
The id of the partner.
organization_id
integer
The id of the organization to update.
Request Body
address.country_id
integer
address.state_id
integer
address.city
string
address.post_code
number
address.street_name
string
address.street_number
string
address.additional_information
string
fax_number.number
string
The number of the organization's fax number.
fax_number.prefix
string
The prefix of the organization's fax number.
phone_number.number
string
The number of the organization's phone number.
phone_number.prefix
string
The prefix of the organization's phone number.
name
string
The name of the organization.
type
string
The type of the organization. Allowed values are the same as for the create organization endpoint.
string
The E-Mail address of the organization.
internal_note
string
Internal note regarding the organization.
founding_year
number
The founding year of the organization.
uid
string
The UID of the organization.
zvr
string
The ZVR of the organization.
dvr
string
The DVR of the organization.
POST /api/internal/v1/partners/:partner_id/organizations
Path Parameters
partner_id
integer
The ID of the partner.
Request Body
type
string
The type of the organization. Possible values: club, company, school, hobby_group, kindergarten. Since new types can be added, use the provided endpoint to get the allowed types.
Get organization customers
GET /api/internal/v1/partners/:partner_id/organizations/:organization_id/customers
Get the customers of an organization.
Path Parameters
partner_id
integer
The ID of the partner.
organization_id
integer
The ID of the organization.
Add a customer to the organization
POST /api/internal/v1/partners/:partner_id/organizations/:organization_id/customers
Add a customer to an organization. If the customer is already added, nothing will happen.
Path Parameters
partner_id
integer
The ID of the partner.
organization_id
integer
The ID of the organization.
Request Body
customer_id
integer
The ID of the customer that should be added to the organization.
Remove customer from the organization
DELETE /api/internal/v1/partners/:partner_id/organizations/:organization_id/customers
Remove the given customer from the given organization.
Path Parameters
partner_id
integer
The ID of the partner.
organization_id
integer
The ID of the organization from which the partner is removed.
customer_id
integer
The ID of the customer being removed.
Last updated
Was this helpful?