Skip to main content
POST
Create an organisation

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Exchange your client_id and client_secret for an access token scoped to the organisation that provides data access.

Headers

Cula-Organisation-Id
string
required

ID of the organisation the request operates on behalf of (e.g. org_...). Must be an organisation the API client has access to.

Example:

"org_01k83mfmhgchya944v86ryvhpq"

Body

application/json
name
string
required

Human-readable name for the new organisation.

Required string length: 3 - 100
address
string
required

Postal address of the organisation.

Required string length: 3 - 200
managed_by_site
object
required

The site that manages the new organisation. Must be a site of the organisation in the Cula-Organisation-Id header that is not managed itself. Reference it either by its ID or by its external ID, but not both.

external_id
string

An optional custom ID that can be set to an internal ID from your system. This ID must be unique within all objects of the organisation you operate in. You can later use this external ID to reference and query this object. Be aware that you can update this ID later. If you need an immutable ID, use the object ID returned when creating the object.

Required string length: 1 - 100
Pattern: ^[A-Za-z0-9\-_]+$
Example:

"MY-CUSTOM-ID"

Response

Organisation

id
string
required

The ID of the organisation.

Example:

"org_01k83mfmhgchya944v86ryvhpq"

name
string | null
required

Human-readable name of the organisation.

Example:

"Pyrolysis GmbH"

address
string | null
required

Postal address of the organisation, if known.

Example:

"Business Street 1, 10115 Berlin, DE"

full_address
string | null
required
deprecated

Deprecated: use address instead.

Example:

"Business Street 1, 10115 Berlin, DE"

external_id
string | null
required

The external ID you assigned to this organisation, if any.

Example:

"MY-CUSTOM-ID"

managed_by_site
object | null
required

For a managed organisation, the site that manages it. null if the organisation is not managed.

Example: