GET organization

GET Retrieves the details of an organization.

Please note: only the details for the "own" organization may be retrieved.

Resource URL

https://www.drillster.com/api/2/organization

or

https://www.drillster.com/api/2/organization/{organization_id}

Parameters

Field Type Description
organization_id
optional
String

The organization ID to retrieve details for. If omitted, the details for user's own organization are returned.

Example value: nPjYUn0upc8dIm7yzTIBgQ

Response

An 2.0 Organization object with the details of the requested organization.

Example request

GET https://www.drillster.com/api/2/organization

Response

{
  "type" : "ORGANIZATION",
  "id" : "nPjYUn0upc8dIm7yzTIBgQ",
  "name" : "Acme Corp",
  "emailAddress" : "info@example.com",
  "locale" : "en_US",
  "contract" : {
    "type" : "BUSINESS"
  }
}

Error responses

The following error situations are possible:

ID Description
not_linked_to_organization No specific organization was requested, and the requesting user is not linked to an organization.
not_found Requested organization does not exist.