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

EndpointMethodPathScopePurpose
List membersGET/membersmembers:readEveryone in the workspace, owner first
Change a member's rolePATCH/members/{user_id}members:writeMember, admin, or transfer ownership
Remove a memberDELETE/members/{user_id}members:writeRemove someone, or leave the workspace
List invitationsGET/invitationsmembers:readPending invitations
Invite a memberPOST/invitationsmembers:writeEmail an invitation, or resend one
Revoke an invitationDELETE/invitations/{invitation_id}members:writeStop an invitation link from working

Who can do what

FieldTypeDescription
List memberseveryoneAny member of the workspace.
List, send and revoke invitationsowner, adminSending invitations needs a Team plan. Only the owner can invite admins or owners.
Change rolesownerNot on yourself. Making someone owner transfers ownership and makes you an admin.
Remove membersowner, adminAdmins can't remove owners or other admins. The owner can't be removed.
Leaveeveryone but the ownerPass your own user_id. The owner has to transfer ownership first.

List members

GET/members·members:read

Everyone who can log in to the workspace, owner first.

Example response

json
{ "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

PATCH/members/{user_id}·members:write

Sets 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

bash
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

DELETE/members/{user_id}·members:write

Removes the person from the workspace, or leaves it when user_id is your own. Returns 204.

Example request

bash
curl -X DELETE https://api.shortsync.app/v1/members/$USER_ID \
  -H "Authorization: Bearer $TOKEN"

List invitations

GET/invitations·members:read

Pending invitations that haven't expired. Owners and admins only.

Example response

json
{ "data": [ ...invitations ] }

Invite a member

POST/invitations·members:write

Emails 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

FieldTypeDescription
emailstringRequired. Who to invite.
rolestringmember (default), admin, owner or client.

Example response

json
{
  "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

DELETE/invitations/{invitation_id}·members:write

Stops the invitation link from working. Owners and admins only. Returns 204.

Errors on this page

FieldTypeDescription
403 ADMIN_REQUIREDerrorOnly owners and admins can do this.
403 OWNER_REQUIREDerrorOnly the owner can do this.
403 TEAM_PLAN_REQUIREDerrorSending invitations needs a Team plan.
400 ALREADY_MEMBERerrorThat person is already in the workspace.
400 CANNOT_CHANGE_OWN_ROLEerrorChange someone else's role, or transfer ownership.
400 OWNER_CANNOT_LEAVEerrorTransfer ownership before leaving.
403 CANNOT_REMOVE_OWNERerrorThe owner can't be removed.
404 MEMBER_NOT_FOUNDerrorNo member with that user_id.
404 INVITATION_NOT_FOUNDerrorNo pending invitation with that id.