Skip to navigation
APIsProject ResourcesProject User Roles

List all project user roles

Returns a list of user role assignments on the project.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

projectIdstringRequiredformat: "^pjt_[a-zA-Z0-9]{10,22}$"
The unique identifier of the project.

Headers

X-Studies-Api-VersionstringOptional

Query parameters

perPageintegerOptional1-100Defaults to 10
The number of results to return per page, up to a maximum of 100.
pageintegerOptional>=1Defaults to 1
The page of results to return. The first page is 1.
role_namestringOptional
Filter project user roles to return by role name.
user_namestringOptional
Filter project user roles to return by user name.
user_emailstringOptionalformat: "email"
Filter project user roles to return by user email.

Response headers

X-RateLimit-LimitintegerOptional
The number of requests permitted in the current rate limit window.
X-RateLimit-RemainingintegerOptional

The number of requests still available in the current rate limit window. When several limits apply, this reflects the per-API-key limit, so a request can be rejected while this value is above zero.

X-RateLimit-ResetintegerOptional
The number of seconds until the current rate limit window resets.

Response

A page of project user roles.
datalist of objects
The project user roles on this page of results.
metaobject
Pagination counters describing the returned page of results.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error