lists out all users of a hub with their id

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
{
  "users": [
      {
        "email": "vbot@test.com",
        "id": "1",
        "invitation_accepted": true,
        "created_at": 1411672027,
        "updated_at": 1411672141
      },
      {
        "id": "4",
        "email": "user@example.com",
        "invitation_accepted": true,
        "created_at": 1411671486,
        "updated_at": 1414789607
      }
  ],
  "summary":{
    "page": 1,
    "per_page": 2,
    "count": 5
  }
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String

per_page
optional

The number of items to show per page
Maximum: 200

Validations:

  • Parameter has to be Integer.

page
optional

The page number to include in the response
Only applies when per_page used
Default: 1

Validations:

  • Parameter has to be Integer.