Get users
GET
/usersGet list of all users in a company
Example
Section titled “Example”Use resource IDs from your own project. Keep the API token in your server or CI environment.
import { createConfiguration, UsersApi } from '@testcollab/sdk';
const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);const api = new UsersApi(config);
const result = await api.getUsers({ "company": 123});console.log(result);curl --request GET \ "https://api.testcollab.io/users?token=$TESTCOLLAB_TOKEN&company=123"Parameters
Section titled “Parameters”| Name | Location | Type | Required | Description |
|---|---|---|---|---|
company |
query | integer | Yes | Company ID |
_limit |
query | integer | No | Limit the size of the returned results |
_start |
query | integer | No | Skip a specific number of entries (for pagination) |
_sort |
query | string | No | Sort according to a specific field. |
_filter |
query | string | No | Stringified filter object (the filtering guide) |
Response
Section titled “Response”200 — Users array
| Field | Type | Required | Description |
|---|---|---|---|
[].id |
number | Yes | — |
[].name |
string | Yes | — |
[].about_me |
string | No | — |
[].email |
string | Yes | If email is modified then a confirmation should be sent |
[].avatar |
Upload | No | — |
[].avatar.id |
number | Yes | — |
[].avatar.name |
string | Yes | — |
[].avatar.hash |
string | Yes | — |
[].avatar.ext |
string | Yes | — |
[].avatar.mime |
string | Yes | — |
[].avatar.size |
string | Yes | — |
[].avatar.url |
string | Yes | — |
[].avatar.created_by |
number | No | — |
[].avatar.created_at |
string | Yes | — |
[].avatar.updated_at |
string | Yes | — |
[].username |
string | No | — |
[].last_active |
string | No | — |
[].confirmed |
boolean | No | — |
[].rank |
string | No | Values: User, Administrator. |
[].projects |
Project User Minified Collection | No | — |
[].projects[].id |
number | Yes | — |
[].projects[].user |
number | Yes | — |
[].projects[].project |
number | Yes | — |
[].projects[].role |
number | Yes | — |
[].projects[].created_at |
string | Yes | — |
[].projects[].updated_at |
string | Yes | — |
[].created_at |
string | No | — |
[].is_guest |
number | No | — |
[]Errors
Section titled “Errors”| Status | Meaning |
|---|---|
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not found |
500 |
Internal server error |