List Users

Workspace directory, by name. One page of it: the admin page pages through this, and the pickers use /users/options instead.

search covers what is typed, role and groups what is picked — the split the filter chips on every other board make.

GET/api/v1/users

Authorization

AuthorizationBearer token · headerrequired

AuthorizationOAuth2 access token · headerrequired

Query parameters

searchstring | any

case-insensitive match on name / email

roleRole[] | any

any of these roles; repeat the param

groupsUserGroup[] | any

in any of these groups; repeat the param

limitinteger

min 1 · max 100 · default: 20

offsetinteger

min 0 · default: 0

Responses

200Successful Response

successboolean

default: true

dataUsersList | any

Show properties

Any of:

UsersList

usersUserSchema[]required

Show properties

Array of UserSchema

idstringrequired

emailstring | any

Show properties

Any of:

string

string

any

any

namestring | any

Show properties

Any of:

string

string

any

any

image_urlstring | any

Show properties

Any of:

string

string

any

any

rolestring

default: "member"

groupsstring[]

created_atstring<date-time> | any

Show properties

Any of:

string<date-time>

string<date-time>

any

any

metaPaginationMetarequired

Show properties

totalintegerrequired

limitintegerrequired

offsetintegerrequired

any

any

messagestring | any

Show properties

Any of:

string

string

any

any

errorsstring[] | any

Show properties

Any of:

string[]

Array of string

string

any

any

422Validation Error

detailValidationError[]

Show properties

Array of ValidationError

locstring | integer[]required

Show properties

Array of string | integer

Any of:

string

string

integer

integer

msgstringrequired

typestringrequired

inputany

ctxobject

Request

curl -X GET "/api/v1/users" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("/api/v1/users", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "/api/v1/users",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "success": true,
  "data": {
    "users": [
      {
        "id": "string",
        "email": "string",
        "name": "string",
        "image_url": "string",
        "role": "member",
        "groups": [
          "string"
        ],
        "created_at": "2019-08-24T14:15:22Z"
      }
    ],
    "meta": {
      "total": 0,
      "limit": 0,
      "offset": 0
    }
  },
  "message": "string",
  "errors": [
    "string"
  ]
}