The Teams & Members API provides operations for inviting Team Members, verifying invitations, completing invitations, resending or canceling invitations, viewing inactive members, changing roles, removing members, and blocking or unblocking workspace access.
Endpoints
| Method | Path | Purpose |
| POST | /auth/invite | Invite Team Member |
| GET | /auth/verify-invitation | Validate invitation |
| POST | /auth/complete-invitation | Complete invitation |
| POST | /auth/resend-invitation/:invitationId | Resend invitation |
| DELETE | /auth/invitation/:invitationId | Cancel invitation |
| GET | /auth/inactive-members | List pending/expired invitations |
Invitation creation uses:
{
“email”: “member@example.com”,
“role”: “AGENT”
}
Optional permission fields are supported according to the audited DTO:
permissions
useCustomPermissions
Seat limits can also be enforced for member creation.
Need Help?
Email: support@ysdesk.com
Documentation: https://docs.ysplugins.com/ys-desk