Workspace.Members.Fields

Tags: members, users

Endpoints

• GET /member-field-definitions - Member Field Definitions
• GET /members/{member_id}/fields - Fields
• POST /members/{member_id}/fields - Fields
• DELETE /members/{member_id}/fields/{field_id} - Delete Fields
• PUT /members/{member_id}/fields/{field_id} - Update Fields

Member Field Definitions

GET /api/v2/w/{workspace_uuid}/member-field-definitions

Description:

Workspace member management

Get available field definitions for this workspace.

Returns field keys and labels from active app connections' managed field definitions, plus any distinct user-created field keys.

Authorization: Requires members:read scope

Response: See MemberFieldDefinitionListResponse

---

Fields

GET /api/v2/w/{workspace_uuid}/members/{member_id}/fields

Description:

Workspace member management

Get all fields for a member.

Returns all key-value fields associated with this member, including service-owned fields and placeholder entries for managed field definitions that don't have a value yet.

Authorization: Requires members:read scope

Parameters:

• member_id (Integer)

Response: See MemberFieldListResponse

---

Fields

POST /api/v2/w/{workspace_uuid}/members/{member_id}/fields

Description:

Workspace member management

Create a new field for a member.

When serviceId is provided, creates a managed field owned by that app connection. The key must match a managed field definition declared by the connection. Otherwise creates a user-owned field.

Authorization: Requires members:write scope

Parameters:

• member_id (Integer)
• request - See CreateMemberFieldRequest

Response: See MemberFieldResponse

---

Delete Fields

DELETE /api/v2/w/{workspace_uuid}/members/{member_id}/fields/{field_id}

Description:

Workspace member management

Delete a member field.

Only user-created fields (service_id is null) can be deleted. Service-owned fields are read-only.

Authorization: Requires members:write scope

Parameters:

• member_id (Integer)
• field_id (Integer)

---

Update Fields

PUT /api/v2/w/{workspace_uuid}/members/{member_id}/fields/{field_id}

Description:

Workspace member management

Update a member field value.

Both user-created and service-owned (managed) fields can have their values updated. The app connection owns the field's existence; the admin owns the value.

Authorization: Requires members:write scope

Parameters:

• member_id (Integer)
• field_id (Integer)
• request - See UpdateMemberFieldRequest

Response: See MemberFieldResponse

---