GET organizations

GET Searches through the list of organizations.

Please note: this API call is not available to the general public.

Resource URL

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

Parameters

Field Type Description
query
optional
String

The text to search for. If no query is given, the full list is returned.

resultStart
optional
Integer

The index number (zero-based) of the organization to include in the result. Use this parameter, in combination with resultSize, to apply pagination of the result; it will limit the number of organizations included in the result. Defaults to 0.

resultSize
optional
Integer

The maximum number of organizations to include in the result. If not specified, a fixed number of results is returned.

Response

An Actors object.

Example request

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

Response

[ {
  "type" : "ORGANIZATION",
  "id" : "nPjYUn0upc8dIm7yzTIBgQ",
  "name" : "Acme Corp",
  "avatar" : {
    "type" : "image/png",
    "url" : "https://www.drillster.com/bin/avatar/a3c6d0dafdd8ab21ec70c1c458cf9c34ac80ab08"
  },
  "locale" : "en",
  "contract" : {
    "type": "BUSINESS",
  },
  "groupMemberQuota" : 10
}, {
  "type" : "ORGANIZATION",
  "id" : "1OJGyD-lT1-fRJ0OHLFGBx",
  "name" : "Ajax Corporation",
  "avatar" : {
    "type" : "image/png",
    "url" : "https://www.drillster.com/bin/avatar/7a2f6aef0792116af78eab8267a4e7071dba05da"
  },
  "contract" : {
    "type": "BUSINESS"
  }
} ]