Teams API
Manage your organization's team members. Invite collaborators, assign roles, update permissions, and remove members.
- Roles and Permissions
- List Team Members
- Example Request
- Example Response
- Invite a Team Member
- Request Body
- Example Request
- Example Response
- Resend Invitation
- Example Request
- Example Response
- Revoke Invitation
- Example Request
- Example Response
- Validate an Invitation (Public)
- Request Body
- Example Response
- Accept an Invitation (Public)
- Request Body
- Example Request
- Example Response
- Update Member Role
- Request Body
- Example Request
- Example Response
- Remove a Team Member
- Example Request
- Example Response
- Plan Limits
Teams API
The Teams API lets you manage the members of your organization. You can invite new collaborators, assign roles, update permissions, and remove members. Team member limits are enforced based on your subscription plan.
Base URL: https://api.zenflip.io/v1/teams
Roles and Permissions
ZenFlip uses four roles with hierarchical permissions:
Role | Publications | Settings | Team Management | Billing |
| Full access | Full access | Full access | Full access |
| Full access | Full access | Invite, remove, change roles | View only |
| Create, edit, publish, archive | View only | No access | No access |
| View only | No access | No access | No access |
Every organization has exactly one owner. The owner role cannot be removed or demoted. Ownership transfer must be performed through the dashboard.
List Team Members
Retrieve all members of your organization.
Example Request
Example Response
The status field indicates whether the member is active (accepted the invitation) or invited (pending acceptance).
Invite a Team Member
Send an email invitation to a new team member. The invitee receives a link to set their password and join the organization.
Required role: admin or above.
Request Body
Field | Type | Required | Description |
| string | Yes | Email address of the person to invite |
| string | Yes | Display name for the invited member |
| string | Yes | Role to assign: |
Example Request
Example Response
If the organization has reached its plan's team member limit, the API returns a 403 error with a message indicating the limit has been reached.
Resend Invitation
Resend the invitation email to a pending team member.
Required role: admin or above.
Example Request
Example Response
Revoke Invitation
Cancel a pending invitation before it has been accepted.
Required role: admin or above.
Example Request
Example Response
Validate an Invitation (Public)
Check whether an invitation token is valid without consuming it. This is a public endpoint used by the frontend to display the invitation acceptance form.
No authentication required.
Request Body
Field | Type | Required | Description |
| string | Yes | Invitation token |
Example Response
Accept an Invitation (Public)
Accept an invitation and set a password. This endpoint creates the user account, generates JWT tokens, and logs the user in immediately.
No authentication required.
Request Body
Field | Type | Required | Description |
| string | Yes | Invitation token |
| string | Yes | Password for the account |
Example Request
Example Response
Update Member Role
Change the role of an existing team member.
Required role: admin or above.
Request Body
Field | Type | Required | Description |
| string | Yes | New role: |
Example Request
Example Response
Restrictions:
You cannot change the
ownerrole.An
admincannot promote another member toowner.You cannot change your own role.
Remove a Team Member
Remove a member from the organization. This revokes all their access immediately.
Required role: admin or above.
Example Request
Example Response
Restrictions:
The organization
ownercannot be removed.A member cannot remove themselves (use the dashboard to leave an organization).
Plan Limits
Team member limits vary by subscription plan:
Plan | Team Members |
Explorer | 1 (owner only) |
Creator | 3 |
Business | 15 |
Enterprise | Unlimited |
Attempting to invite a member beyond your plan limit returns a 403 error. Upgrade your plan through the billing settings to increase the limit.