Overview
The Public Members API allows organization administrators to programmatically manage organization membership.All endpoints require organization-scoped authentication. See Public API Overview for authentication details.
List Members
Retrieve all members of the organization.Response
string
Always “list”
array
required
Array of member objects
Member Object
string
required
Member’s unique identifier
string
User account ID (null if invited but not accepted)
string
required
Member’s email address
string
Member’s display name
number
required
Member role (0=Owner, 1=Admin, 2=User, 3=Manager, 4=Custom)
number
required
Status (0=Invited, 1=Accepted, 2=Confirmed, -1=Revoked)
boolean
required
Whether member has 2FA enabled
array
Collections assigned to member
Get Member
Retrieve details of a specific member.string
required
Member ID
Get Member Group IDs
Retrieve the groups a member belongs to.string
required
Member ID
Response
Returns an array of group IDs:Invite Member
Invite a new user to the organization.Request Body
string
required
Email address to invite
number
required
Member role (0=Owner, 1=Admin, 2=User, 3=Manager, 4=Custom)
string
External identifier for directory sync
boolean
default:"false"
Grant access to all collections
array
Collection access assignments
array
Group IDs to add member to
Collection Assignment Object
string
required
Collection ID
boolean
default:"false"
Read-only access
boolean
default:"false"
Hide password fields
Update Member
Update member’s role, permissions, or assignments.string
required
Member ID
Request Body
All fields from Create Member - provide complete member object.Update Member Groups
Update only the groups a member belongs to.string
required
Member ID
array
required
Complete array of group IDs
Remove Member
Permanently remove a member from the organization.string
required
Member ID to remove
Reinvite Member
Resend invitation email to a member.string
required
Member ID
Revoke Member
Revoke a member’s access (soft delete).string
required
Member ID
Revoked members can be restored later without re-invitation.
Restore Member
Restore a revoked member’s access.string
required
Member ID