Get project users' list

GET/projectusers

Get details of members in a project

Example

Use resource IDs from your own project. Keep the API token in your server or CI environment.

TypeScript SDK
HTTP

import { createConfiguration, ProjectUsersApi } from '@testcollab/sdk';

const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new ProjectUsersApi(config);

const result = await api.getProjectUsers({
  "project": 123
});
console.log(result);

curl --request GET \
  "https://api.testcollab.io/projectusers?token=$TESTCOLLAB_TOKEN&project=123"

Parameters

Name	Location	Type	Required	Description
`project`	query	integer	Yes	Project 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

200 — List of project users

Field	Type	Required	Description
`[].id`	number	Yes	—
`[].project`	Project Mini	Yes	—
`[].project.id`	number	Yes	—
`[].project.name`	string	Yes	—
`[].project.archived`	boolean	Yes	—
`[].project.activity`	string	No	—
`[].project.totalTimeSpentLabel`	string	No	—
`[].project.created_at`	string	Yes	—
`[].project.updated_at`	string	Yes	—
`[].user`	User	Yes	—
`[].user.id`	number	Yes	—
`[].user.name`	string	Yes	—
`[].user.about_me`	string	No	—
`[].user.email`	string	Yes	If email is modified then a confirmation should be sent
`[].user.avatar`	Upload	No	—
`[].user.avatar.id`	number	Yes	—
`[].user.avatar.name`	string	Yes	—
`[].user.avatar.hash`	string	Yes	—
`[].user.avatar.ext`	string	Yes	—
`[].user.avatar.mime`	string	Yes	—
`[].user.avatar.size`	string	Yes	—
`[].user.avatar.url`	string	Yes	—
`[].user.avatar.created_by`	number	No	—
`[].user.avatar.created_at`	string	Yes	—
`[].user.avatar.updated_at`	string	Yes	—
`[].user.username`	string	No	—
`[].user.last_active`	string	No	—
`[].user.confirmed`	boolean	No	—
`[].user.rank`	string	No	Values: `User`, `Administrator`.
`[].user.projects`	Project User Minified Collection	No	—
`[].user.projects[].id`	number	Yes	—
`[].user.projects[].user`	number	Yes	—
`[].user.projects[].project`	number	Yes	—
`[].user.projects[].role`	number	Yes	—
`[].user.projects[].created_at`	string	Yes	—
`[].user.projects[].updated_at`	string	Yes	—
`[].user.created_at`	string	No	—
`[].user.is_guest`	number	No	—
`[].role`	Role	Yes	—
`[].role.id`	number	Yes	—
`[].role.name`	string	Yes	—
`[].role.permissions`	Array of string	Yes	—
`[].role.readonly`	boolean	Yes	—
`[].role.created_at`	string	Yes	—
`[].role.updated_at`	string	Yes	—
`[].created_at`	string	Yes	—
`[].updated_at`	string	Yes	—

[]

Errors

Status	Meaning
`403`	Forbidden

Get project users' list

Example

Parameters

Response

Errors

Next steps