Deskhero Developer Hub
Back to deskhero.com
User invites

List

Returns the invites of this workspace that are still active and not yet past their expiry window, each with the role, the groups it grants and when it expires. Accepted, denied, revoked and expired invites are not included, and there is no paging.

GET /api/{tenant:minlength(2)}/v{version:apiVersion}/user_invites/list
Authorisation
Minimum role: ADMIN

Request arguments

Name Type Source
Request body example
No input arguments

Response

Status
200 (OK)
Type
DTO_user_invite[]
Wrapper
DTO_response_wrap
Other statuses
400 (BadRequest), 403 (Forbidden)
Response body example
DTO_user_invite
NameTypeReadOnlyDescription
groupsDTO_reference[]Groups
idInt32ReadOnlyId
emailStringEmail
tenant_roleENUM tenant_user_roleTenant role
expires_dateDateTimeReadOnlyExpires date
expires_relativeStringReadOnlyExpires relative
DTO_reference
NameTypeReadOnlyDescription
idInt32The id of the reference
labelObjectReadOnlyName/Label from referenced object.
ENUM tenant_user_role
ValueNameDescription
0UNKNOWNUNKNOWN
1OWNEROwner
2ADMINAdmin
3USERUser

Generated Aug 4, 2026 18:37