API ReferenceProject Members

Retrieve Project Members

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 can 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

projectIdstringRequiredformat: "uuid"
Reference to the project

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Query parameters

includeAllUsersbooleanOptionalDefaults to false
Set to true to include all users in the workspace

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeobject or null
The HTTP code of the response.
datalist of objects or null
If the API call succeeded, this will contain the results.