Skip to content
Catalyzed Docs

List user invites

GET
/auth/user-invites

List all user invites with optional filtering. System admin only.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
emails
string
nullable
createdByUserIds
string
nullable
isExpired
boolean
nullable
isUsed
boolean
nullable
isRevoked
boolean
nullable
page
number
>= 1
pageSize
number
>= 1 <= 100
orderBy
string
Allowed values: createdAt expiresAt email
orderDirection
string
Allowed values: asc desc

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Invites retrieved successfully

object
userInvites
required
Array<object>
object
userInviteId
required
string
email
required
string format: email
expiresAt
required
string format: date-time
createdByUserId
required
string
usedAt
required
string format: date-time
nullable
revokedAt
required
string format: date-time
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
total
required
number
page
required
number
pageSize
required
number

401

Section titled “401 ”

Unauthorized - invalid or missing token

403

Section titled “403 ”

Forbidden - insufficient permissions (system admin required)