This schema describes objects returned by the Workspace Member endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the workspace member (read-only) |
email | string (email) | Yes | Email address of the workspace member |
user_id | string (uuid) | Yes | User ID of the workspace member (read-only) |
user_email | string (email), nullable | No | Email address of the user |
name | object | No | Read-only |
name.first | string | No | Workspace member first name |
name.last | string | No | Workspace member last name |
role | string | Yes | THe role of the workspace member defining their access level. While the “owner” role is listed in the enum, it cannot be created via the API, and is only assigned to the user who creates the workspace.. Possible values: owner (Owner - Full access and workspace management), admin (Admin - Full access except workspace deletion), editor (Editor - Can edit but not manage workspace settings), view (View - Read-only access), client (This is a special role for users in the whitelabel (agency) view. It is not available in the API.) |
timestamp_created | string (date-time) | Yes | Timestamp when the workspace member was created (read-only) |
workspace_id | string (uuid) | Yes | ID of the workspace this member belongs to (read-only) |
accepted | boolean | Yes | Whether the member has accepted the workspace invitation (read-only) |
issuer_id | string (uuid), nullable | No | ID of the user who added this member to the workspace (read-only) |
permissions | array, nullable | No | The permissions for this workspace member. Used in the app to restrict access to certain sections |