Project Members

Retrieve Project Members

GET

Returns a list of users that are currently members of a specified project, as well as their current project security roles and available project security roles. Optionally include users who are not currently members of the project, but who are available to be added.

A project member is a user who has access to a specific project. Project members are assigned a project security role, which controls the level of access they have to the project. Possible project security roles include manage, edit, collaborate, creator, and guest.

Path parameters

projectIdstringRequired
Reference to the project

Query parameters

includeAllUsersbooleanOptional
Set to true to include all users in the workspace

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
list of objectsOptional
If the API call succeeded, this will contain the results.
GET
1curl /api/data/projects/projectId/members \
2 -H "Authorization: Bearer <token>"
200
Retrieved
1{
2 "error": {
3 "technicalError": "technicalError",
4 "additionalErrors": [
5 "additionalErrors"
6 ],
7 "message": "message"
8 },
9 "success": true,
10 "hasError": true,
11 "statusCode": "Continue",
12 "data": [
13 {
14 "id": "id",
15 "initials": "initials",
16 "name": "name",
17 "avatarUrl": "avatarUrl",
18 "role": "role",
19 "permission": "permission",
20 "color": "color"
21 }
22 ]
23}