Skip to main content
GET
List Invites

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:10

Items per page

Example:

10

page
number
default:1

Page number

Example:

1

organizationId
string<uuid> | null

Organization identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

invitedByUserId
string<uuid>

Issuer user identifier

Example:

"0195e7a1-8b5c-7d3e-9f4a-2c6b8d0e1f3a"

email
string<email> | null

Invitee email

Example:

"novo@example.com"

createdAt
string

Available operators: >, >=, <, <=, =.

Example:

">=2024-01-01;<=2024-12-31"

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
expiresAt,
acceptedAt,
revokedAt,
email
Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

List invites

data
object[]
required
meta
object
required