Return membership of a workspace. User must have a workspace admin role to retrieve membership records.
Returns a paginated, per-user membership report covering the workspace and all of its active projects. Requires the `canGetWorkspaceMembers` right. `isBillable=true` restricts to billable roles. Only one of the name sorts (`firstName`, `lastName`, `displayName`) may be used at a time.
Returns a paginated, per-user membership report covering the workspace and all of its active projects. Requires the canGetWorkspaceMembers right. isBillable=true restricts to billable roles. Only one of the name sorts (firstName, lastName, displayName) may be used at a time.
OAuth 2.1 authorization code flow with PKCE (required of every client, public or confidential). Scopes are a ceiling on the credential, not a grant of access: a token also cannot exceed what the user who approved it may already do. A write scope does not imply its matching read — ask for both.
In: header
Scope: workspaces:read
Path Parameters
The ID of the workspace to retrieve membership records for.
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$uuidQuery Parameters
Optional name search to filter membership records by user names.
Flag 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
curl -X GET "https://example.com/memberships/workspace/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", "email": "dana@example.com" }, "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}