users.md

Users

This API allows you to read users you are connected with in Kona.

Schema

{
  "users": [{
    "id": integer, readonly,
    "email": string, required,
    "name": string,
    "picture_thumb" :string, readonly,
    "updated_at": datetime, readonly,
    "href": string, readonly
  }]
}

Get users

GET /users will return all users you are connected with.

Filter parameters

GET /users?like=:pattern will return users whose name or email starts with pattern.

GET /users?space_id=:space_id will return users who are members of the given space.

GET /users/:id will return the specified user.

GET /userinfo will return the current user which is useful after authenticating. It will also include information of the current account. Thus, its response has the following schema

  {
  "users": [{
    "id": integer, readonly,
    "email": string, required,
    "name": string,
    "picture_thumb" :string, readonly,
    "updated_at": datetime, readonly,
    "href": string, readonly,
    "current_account": {
        "id": integer,
        "member": boolean
      }
    }]
}

See get response.