List Invites - Documentação DEVMOB

{ "data": [ { "inviteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "invitedByUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "invitedUserId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "roleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "token": "<string>", "email": "<string>", "phoneIso": "<string>", "phoneDdi": "<string>", "phoneNumber": "<string>", "expiresAt": "2023-11-07T05:31:56Z", "acceptedAt": "2023-11-07T05:31:56Z", "revokedAt": "2023-11-07T05:31:56Z", "rejectedAt": "2023-11-07T05:31:56Z", "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "createdAt": "2023-11-07T05:31:56Z" } ], "meta": { "page": 1, "limit": 20, "total": 125, "totalPages": 7 } }

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"

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

data

object[]

required

Show child attributes