GET organization/…/staff

GET Retrieves a list of staff users that are part of an organization. This endpoint also allows searching in the list of staff users.

Resource URL

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

or

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

Parameters

Field Type Description
organization_id
optional
String

The organization ID to retrieve the staff users for. May be replaced with self to refer to the own organization.

Example value: nPjYUn0upc8dIm7yzTIBgQ

query
optional
String

The text to search for.

resultStart
optional
Integer

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

Currently only multiples of ten are allowed.

resultSize
optional
Integer

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

Currently only a result size of 10 is supported.

Response

An 2.0 Actors object.

Example request

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

Response

{
  "total" : 2,
  "users" : [ {
    "type" : "USER",
    "id" : "m3XfGV1LQhu729lfVYa_sQ",
    "name" : "Jane Doe",
    "emailAddress" : "jane@example.com",
    "locale" : "en_US",
    "description" : "",
    "quota" : 500,
    "created" : "2015-09-21T07:59:01Z"
  }, {
    "type" : "USER",
    "id" : "Q0JTcAQJR32XMXSx3C4WMw",
    "name" : "John Doe",
    "emailAddress" : "john@example.com",
    "locale" : "nl_NL",
    "description" : "",
    "quota" : 500,
    "created" : "2015-09-21T07:59:01Z"
  } ]
}