The Organisation endpoint and fields are described below including details of the supported RESTful CRUD verbs. For details of the conventions of the API see the general conventions.
Endpoint path prefix:
/n/v1/organisation/
organisation was introduced in API version V1
Organisation has not been marked for deprecation
The organisation endpoint is provided for completeness as a reference to the top level container for different representations in Baack. The organisation holds a number of client companies which in turn are the owners for most representations. Client companies have a defined organisation. These typically are associated with billing accounts etc.
This endpoint supports the following CRUD operations in line with our API conventions. See the conventions section for more details.
Organisation
Representation of an organisation which holds multiple account related companies which own data regarding other companies in the platform etc.
{
"urn" : "0225cc24-77fc-40fe-88dd-66f358a17d56",
"url" : "/n/v1/organisation/0225cc24-77fc-40fe-88dd-66f358a17d56"
}API code READ_SUCCESS HTTP status code 200 : On read when the request is successful. The returned representation is given with the relevant 2XX HTTP code without further detail.
API code NOT_FOUND HTTP status code 404 : When the request referenced a representation or a concept that was not found including other request context requirements. Note that if a request is missing other concepts including authorisation, permissions or restrictions on the visibility HTTP not found (404) will typically be returned. Note that when creating a representation if the owner or other references can't be resolved the endpoint may return not found.