The Companies 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/companies
companies was introduced in API version V1
Companies has not been marked for deprecation
API entrypoint to list the companies that the authenticated request is authorised to access. The result is a page of companies and more may be available via the nextPage URL. The endpoint returns both the associated authenticated company as well as other companies the authenticated access is authorised to administer
This endpoint supports the following CRUD operations in line with our API conventions. See the conventions section for more details.
Company Page
A page of companies
{
"companies" : [ {
"urn" : "32a90f18-aaa0-4bdc-a63e-4efd2e16c28c",
"url" : "/n/v1/company/32a90f18-aaa0-4bdc-a63e-4efd2e16c28c"
} ]
}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.