Return membership of a project. Membership retrieved are determined by a user's role in the project. For example, reviewers can only see reviewers.
Returns a paginated, per-user membership report for the project (same shape as the workspace report). Requires `canGetProjectMembership`; the roles visible depend on the caller's inherited permissions in the project. Only one of the name sorts may be used at a time.
Returns a paginated, per-user membership report for the project (same shape as the workspace report). Requires canGetProjectMembership; the roles visible depend on the caller's inherited permissions in the project. Only one of the name sorts may be used at a time.
Authorization
bearerAuth In: header
Path Parameters
The ID of the project to retrieve membership records for.
uuidQuery Parameters
Optional name search to filter membership records by user names.
length <= 105nullFlag to filter memberships based on billable status.
falseSorting criteria for the membership records.
Maximum number of membership records to return (default 20, max limits.membership.maxMembershipRecords).
value <= 10000020Page number for pagination (default 1).
1Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/memberships/project/497f6eca-6276-4993-bfeb-53cbbbba6f08"{ "page": 0, "limit": 0, "totalPages": 0, "totalResults": 0, "queryAt": 0, "results": [ { "user": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "firstName": "string", "lastName": "string", "displayName": "string", "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779", "color": "string", "awards": [ "staff" ], "accountType": "standard" }, "resources": [ { "resourceId": "6733736868949390a715fc63", "resourceType": "project", "name": "Orn Group", "roles": [ "reviewer, creator, projectOwner ect." ] } ], "membershipRecords": [ { "id": "6733736868949390a715fc63", "resourceId": "6733736868949390a715fc63", "resourceType": "project", "roles": [ "creator" ] } ], "createdAt": "2024-11-12T15:25:28.620Z", "updatedAt": "2024-11-12T15:25:28.620Z", "userId": "6733736768949390a715fac4", "roles": [ "reviewer" ], "isBillable": false } ], "totalCreators": 0, "totalReviewers": 0}