Get a workspace member

Returns the member with their project memberships.

Required scope: workspace.members.read

GET /api/public/v1/workspaces/{workspaceId}/members/{memberId}

Get a workspace member

cURL

curl --request GET \
  --url https://{platformHost}/api/public/v1/workspaces/{workspaceId}/members/{memberId} \
  --header 'X-API-Key: <api-key>'

200

{
  "success": true,
  "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": "[e-mail]",
    "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
  }
}

Use this endpoint to get one workspace member and their project memberships. The response includes the member’s status, role, externalId, and attributes.

The ETag response header holds the member’s revision. Send it in the If-Match header when you update the member. The request needs the workspace.members.read scope.

Authorizations

platformApiKeybearerPlatformKey

X-API-Key · string · header · required

Platform key, for example abl_ws_….

Path Parameters

workspaceId · string · required

Minimum string length: 1

memberId · string · required

Minimum string length: 1

Response

200

application/json

Success

success · enum<boolean> · required

Available options: true

data · object · required

Show child attributes