List workspace members
curl --request GET \
--url https://{platformHost}/api/public/v1/workspaces/{workspaceId}/members \
--header 'X-API-Key: <api-key>'{
"success": true,
"data": {
"data": [
{
"memberId": "0193f1c2-7a4e-7b10-9c3d-5e6f7a8b9c0d",
"role": {
"roleId": "builtin.workspace.restricted_member",
"name": "RESTRICTED_MEMBER",
"type": "system",
"source": "direct"
},
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"revision": 1,
"userId": "<string>",
"email": "jsmith@example.com",
"name": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"attributes": {},
"assignmentSource": "api",
"projects": [
{
"id": "<string>",
"role": {
"roleId": "builtin.workspace.restricted_member",
"name": "RESTRICTED_MEMBER",
"type": "system",
"source": "direct"
},
"name": "<string>"
}
],
"projectsTruncated": true
}
],
"nextCursor": "<string>"
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}List workspace members
List the members of a workspace with filters and cursor pagination.
GET
/
api
/
public
/
v1
/
workspaces
/
{workspaceId}
/
members
List workspace members
curl --request GET \
--url https://{platformHost}/api/public/v1/workspaces/{workspaceId}/members \
--header 'X-API-Key: <api-key>'{
"success": true,
"data": {
"data": [
{
"memberId": "0193f1c2-7a4e-7b10-9c3d-5e6f7a8b9c0d",
"role": {
"roleId": "builtin.workspace.restricted_member",
"name": "RESTRICTED_MEMBER",
"type": "system",
"source": "direct"
},
"status": "pending",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"revision": 1,
"userId": "<string>",
"email": "jsmith@example.com",
"name": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"attributes": {},
"assignmentSource": "api",
"projects": [
{
"id": "<string>",
"role": {
"roleId": "builtin.workspace.restricted_member",
"name": "RESTRICTED_MEMBER",
"type": "system",
"source": "direct"
},
"name": "<string>"
}
],
"projectsTruncated": true
}
],
"nextCursor": "<string>"
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}workspace.members.read scope. You can filter the list by status, roleId, emails, externalId, and updatedSince. To filter by email address, use Search workspace members so addresses stay out of URLs.
Results are paginated with a cursor. Pass nextCursor from the response as cursor in the next request. A cursor works only with the filters it was issued for. Set include to projects to return each member’s project memberships. The maximum limit is then 50.
The status filter takes up to six values: active, pending, expired, suspended, deactivated, and locked. The pending and expired statuses are invitations that grant no access. Use limit to set the page size from 1 to 200. The default is 50.Authorizations
platformApiKeybearerPlatformKey
Query Parameters
Was this page helpful?