Team Members API

Team members are the users who have access to your Synapse workspace. Each member has a role that determines their permissions within the workspace. You can invite new members by email, update roles, deactivate access, and manage pending invitations through this API.

Note

For a user guide on managing team members in the dashboard, see Team Roles & Permissions.

Endpoints

Method	Path	Description
`GET`	`/v1/workspace/members`	List team members
`POST`	`/v1/workspace/members/invite`	Invite a new member
`PUT`	`/v1/workspace/members/{member_id}/role`	Update a member's role
`DELETE`	`/v1/workspace/members/{member_id}`	Deactivate a member
`POST`	`/v1/workspace/members/{member_id}/activate`	Re-activate a member
`GET`	`/v1/workspace/members/invitations`	List pending invitations for current user
`POST`	`/v1/workspace/members/invitations/{invitation_id}/accept`	Accept a pending invitation

List Members

Returns all team members for the current workspace, including both active members and pending invitations by default.

bash

curl "https://synapse-api.pyrx.tech/v1/workspace/members?include_inactive=true" \

-H "Authorization: Bearer <jwt>"

Auth: JWT (dashboard). Requires members:read permission.

Query Parameters

Parameter	Type	Default	Description
`include_inactive`	boolean	`true`	Include inactive members (pending invitations, deactivated members)

Response

json

{

"members": [

{

"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",

"name": "Jane Nguyen",

"email": "[email protected]",

"role": "owner",

"is_active": true,

"created_at": "2026-01-10T08:00:00Z",

"invite_accepted_at": "2026-01-10T08:05:00Z"

{

"id": "b2c3d4e5-f678-9012-abcd-ef1234567890",

"name": "Alex Chen",

"email": "[email protected]",

"role": "admin",

"is_active": true,

"created_at": "2026-01-15T10:00:00Z",

"invite_accepted_at": "2026-01-15T10:30:00Z"

{

"id": "c3d4e5f6-7890-1234-abcd-ef1234567890",

"name": "",

"email": "[email protected]",

"role": "marketing",

"is_active": false,

"created_at": "2026-04-20T14:00:00Z",

"invite_accepted_at": null

}

"total": 3

}

Members with is_active: false and invite_accepted_at: null are pending invitations that have not yet been accepted.

Invite a Member

Sends an invitation to a new team member. The invited user appears as an inactive member until they accept. Plan limits on member count are enforced at invite time.

bash

curl -X POST https://synapse-api.pyrx.tech/v1/workspace/members/invite \

-H "Authorization: Bearer <jwt>" \

-H "Content-Type: application/json" \

-d '{

"email": "[email protected]",

"role": "developer",

"name": "Sam Park"

Auth: JWT (dashboard). Requires members:write permission.

Request Body

Field	Type	Required	Description
`email`	string	Yes	Email address of the person to invite (must be a valid email)
`role`	string	Yes	Role to assign: `admin`, `developer`, `marketing`, `operations`, or `viewer`
`name`	string	No	Display name for the invited member (max 255 characters)

Note

You cannot invite someone with the owner role. Each workspace has exactly one owner, enforced at the database level.

Response (201 Created)

json

{

"id": "d4e5f678-9012-3456-abcd-ef1234567890",

"name": "Sam Park",

"email": "[email protected]",

"role": "developer",

"is_active": false,

"created_at": "2026-04-25T09:00:00Z",

"invite_accepted_at": null

}

Error: Duplicate Invite (409 Conflict)

json

{

"detail": "A member with this email already exists in the workspace"

}

Error: Plan Limit Reached (403 Forbidden)

json

{

"detail": "Member limit reached for your plan. Upgrade to add more members.",

"code": "plan_limit_reached"

}

Update Member Role

Change the role of an existing team member. You cannot change your own role, and you cannot assign the owner role.

bash

curl -X PUT https://synapse-api.pyrx.tech/v1/workspace/members/b2c3d4e5-f678-9012-abcd-ef1234567890/role \

-H "Authorization: Bearer <jwt>" \

-H "Content-Type: application/json" \

-d '{

"role": "developer"

Auth: JWT (dashboard). Requires members:write permission.

Request Body

Field	Type	Required	Description
`role`	string	Yes	New role: `admin`, `developer`, `marketing`, `operations`, or `viewer`

Response (200 OK)

json

{

"id": "b2c3d4e5-f678-9012-abcd-ef1234567890",

"name": "Alex Chen",

"email": "[email protected]",

"role": "developer",

"is_active": true,

"created_at": "2026-01-15T10:00:00Z",

"invite_accepted_at": "2026-01-15T10:30:00Z"

}

Error: Invalid Operation (400 Bad Request)

Returned when attempting to change your own role or change the owner's role:

json

{

"detail": "Cannot change your own role"

}

Deactivate a Member

Soft-deactivates a team member, revoking their access to the workspace. The member record is retained for audit purposes. You cannot deactivate yourself or the workspace owner.

bash

curl -X DELETE https://synapse-api.pyrx.tech/v1/workspace/members/b2c3d4e5-f678-9012-abcd-ef1234567890 \

-H "Authorization: Bearer <jwt>"

Auth: JWT (dashboard). Requires members:write permission.

Response

Returns 204 No Content on success.

Error: Invalid Operation (400 Bad Request)

json

{

"detail": "Cannot deactivate yourself"

}

Re-activate a Member

Restores access for a previously deactivated member, returning them to their original role.

bash

curl -X POST https://synapse-api.pyrx.tech/v1/workspace/members/b2c3d4e5-f678-9012-abcd-ef1234567890/activate \

-H "Authorization: Bearer <jwt>"

Auth: JWT (dashboard). Requires members:write permission.

Response (200 OK)

json

{

"id": "b2c3d4e5-f678-9012-abcd-ef1234567890",

"name": "Alex Chen",

"email": "[email protected]",

"role": "developer",

"is_active": true,

"created_at": "2026-01-15T10:00:00Z",

"invite_accepted_at": "2026-01-15T10:30:00Z"

}

List Pending Invitations

Lists pending workspace invitations for the currently authenticated user across all workspaces. This is used by the dashboard to show the user which workspaces they have been invited to join.

bash

curl https://synapse-api.pyrx.tech/v1/workspace/members/invitations \

-H "Authorization: Bearer <jwt>"

Auth: JWT (dashboard). No specific permission required beyond authentication.

Response

json

{

"invitations": [

{

"invitation_id": "e5f67890-1234-5678-abcd-ef1234567890",

"workspace_name": "Acme Marketing",

"workspace_id": "ws_m4k8j2n6",

"role": "marketing",

"invited_by": "Jane Nguyen",

"invited_at": "2026-04-20T14:00:00Z"

}

]

}

If the user has no pending invitations, invitations is an empty array.

Accept an Invitation

Accepts a pending invitation, activating the membership and linking the current user's identity to the new workspace. After accepting, the frontend should switch the workspace context.

bash

curl -X POST https://synapse-api.pyrx.tech/v1/workspace/members/invitations/e5f67890-1234-5678-abcd-ef1234567890/accept \

-H "Authorization: Bearer <jwt>"

Auth: JWT (dashboard). The invitation must belong to the current user's email address.

Response (200 OK)

json

{

"id": "e5f67890-1234-5678-abcd-ef1234567890",

"name": "Alex Chen",

"email": "[email protected]",

"role": "marketing",

"is_active": true,

"created_at": "2026-04-20T14:00:00Z",

"invite_accepted_at": "2026-04-25T09:15:00Z"

}

Error: Not Found (404)

json

{

"detail": "Invitation not found or already accepted"

}

Roles Reference

Role	Description
`owner`	Full access including billing and workspace deletion. One per workspace.
`admin`	All CRM permissions plus user management. No billing access.
`developer`	Flows, templates, segments, contacts, logs, and dev tools.
`marketing`	Flows, templates, segments, and analytics.
`operations`	Contacts (read-only), email logs, and analytics.
`viewer`	Analytics read-only.

Plan Limits

Plan	Max Members
Free	1
Starter	3
Growth	10
Enterprise	Unlimited

When the member limit is reached, invite requests return 403 with plan_limit_reached.