List Users

Request

GET /v2/users HTTP/1.1
Authorization: Bearer oauth_token

URL Parameters

Parameter Description
email Optional filter param for looking up users by email using exact match.
mailbox Optional filter param for looking up users by mailbox.

Response

HTTP/1.1 200 OK
Content-Type: application/hal+json;charset=UTF-8

{
  "_embedded" : {
    "users" : [ {
      "id" : 4,
      "firstName" : "Vernon",
      "lastName" : "Bear",
      "email" : "bear@acme.com",
      "role" : "owner",
      "timezone" : "America/New_York",
      "photoUrl" : "http://somesite.com/images/avatar.jpg",
      "createdAt" : "2011-04-01T03:18:33Z",
      "updatedAt" : "2012-07-24T20:18:33Z",
      "type" : "user",
      "_links" : {
        "self" : {
          "href" : "..."
        }
      }
    } ]
  },
  "_links" : {
    "first" : {
      "href" : "..."
    },
    "last" : {
      "href" : "..."
    },
    "page" : {
      "href" : "...",
      "templated" : true
    },
    "self" : {
      "href" : "..."
    }
  },
  "page" : {
    "size" : 50,
    "totalElements" : 1,
    "totalPages" : 1,
    "number" : 1
  }
}

Response fields

Path Type Description
_embedded.users Array Array of User objects
Relation Description
page Templated link to grab any result page
first Link to grab the first page
last Link to grab the last page
next Link to grab the next page
previous Link to grab the previous page