Team
Members are the people who log in to the workspace. They aren't the same as the tagged people on your posts. Every call runs as the key's creator, with that person's role in the workspace, so the same rules apply as in Settings → Team. These endpoints need the members:read and members:write scopes.
Base path: https://api.shortsync.app/v1
| Endpoint | Method | Path | Scope | Purpose |
|---|---|---|---|---|
| List members | GET | /members | members:read | Everyone in the workspace, owner first |
| Change a member's role | PATCH | /members/{user_id} | members:write | Member, admin, or transfer ownership |
| Remove a member | DELETE | /members/{user_id} | members:write | Remove someone, or leave the workspace |
| List invitations | GET | /invitations | members:read | Pending invitations |
| Invite a member | POST | /invitations | members:write | Email an invitation, or resend one |
| Revoke an invitation | DELETE | /invitations/{invitation_id} | members:write | Stop an invitation link from working |
Who can do what
| Field | Type | Description |
|---|---|---|
| List members | everyone | Any member of the workspace. |
| List, send and revoke invitations | owner, admin | Sending invitations needs a Team plan. Only the owner can invite admins or owners. |
| Change roles | owner | Not on yourself. Making someone owner transfers ownership and makes you an admin. |
| Remove members | owner, admin | Admins can't remove owners or other admins. The owner can't be removed. |
| Leave | everyone but the owner | Pass your own user_id. The owner has to transfer ownership first. |
List members
/members·members:readEveryone who can log in to the workspace, owner first.
Example response
{ "data": [{
"user_id": "5b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
"email": "alex@example.com",
"full_name": "Alex Doe",
"role": "admin",
"joined_at": "2026-09-14T08:12:00.000Z",
"created_at": "2026-09-14T08:12:00.000Z"
}] }Change a member's role
/members/{user_id}·members:writeSets the role to member, admin or owner. Owner only. owner transfers ownership: you become an admin and the response has ownership_transferred: true.
Example request
curl -X PATCH https://api.shortsync.app/v1/members/$USER_ID \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ "role": "admin" }'Remove a member
/members/{user_id}·members:writeRemoves the person from the workspace, or leaves it when user_id is your own. Returns 204.
Example request
curl -X DELETE https://api.shortsync.app/v1/members/$USER_ID \
-H "Authorization: Bearer $TOKEN"List invitations
/invitations·members:readPending invitations that haven't expired. Owners and admins only.
Example response
{ "data": [ ...invitations ] }Invite a member
/invitations·members:writeEmails an invitation to join the workspace. Needs a Team plan. The link works for 7 days and comes back as invite_url too, so you can share it yourself if email_sent is false. Inviting an email that already has a pending invitation sends a fresh link with a new expiry, which is how you resend one. Up to 10 invitations a minute.
Request body
| Field | Type | Description |
|---|---|---|
| string | Required. Who to invite. | |
| role | string | member (default), admin, owner or client. |
Example response
{
"id": "8e7d6c5b-4a3f-4e2d-9c1b-0a9f8e7d6c5b",
"email": "sam@example.com",
"role": "member",
"status": "pending",
"expires_at": "2026-11-08T10:00:00.000Z",
"created_at": "2026-11-01T10:00:00.000Z",
"invited_by": "5b1c2d3e-4f5a-4b6c-8d7e-9f0a1b2c3d4e",
"invite_url": "https://www.shortsync.app/invite/…",
"email_sent": true
}Revoke an invitation
/invitations/{invitation_id}·members:writeStops the invitation link from working. Owners and admins only. Returns 204.
Errors on this page
| Field | Type | Description |
|---|---|---|
| 403 ADMIN_REQUIRED | error | Only owners and admins can do this. |
| 403 OWNER_REQUIRED | error | Only the owner can do this. |
| 403 TEAM_PLAN_REQUIRED | error | Sending invitations needs a Team plan. |
| 400 ALREADY_MEMBER | error | That person is already in the workspace. |
| 400 CANNOT_CHANGE_OWN_ROLE | error | Change someone else's role, or transfer ownership. |
| 400 OWNER_CANNOT_LEAVE | error | Transfer ownership before leaving. |
| 403 CANNOT_REMOVE_OWNER | error | The owner can't be removed. |
| 404 MEMBER_NOT_FOUND | error | No member with that user_id. |
| 404 INVITATION_NOT_FOUND | error | No pending invitation with that id. |