Search invitations with advanced filtering and date-based queries

  Retrieve invitations with comprehensive filtering capabilities including date-based filtering.
  
  **Key Features:**
  - **Date Filtering**: Use `openSinceDays` and/or `openUntilDays` to filter invitations by creation date
  - **Text Search**: Filter by email, first name, last name, or business name with partial matching
  - **Pagination**: Built-in pagination with configurable limits and offsets
  - **Sorting**: Sort results by various fields (creation date, name, etc.)
  
  **Date Filter Examples:**
  - `openSinceDays=30`: Get invitations from the last 30 days (30 days or newer)
  - `openUntilDays=90`: Get invitations older than 90 days
  - `openSinceDays=20&openUntilDays=25`: Get invitations between 20-25 days old (time window)
  
  **Combined Filter Examples:**
  - `openSinceDays=30&firstName=John`: Recent invitations for users named John
  - `openUntilDays=180&businessName=Acme`: Older invitations for Acme company
  - `openSinceDays=20&openUntilDays=25&limit=20`: Invitations in 20-25 day window with pagination
.
Path Params
string
required

Tenant identifier.

Query Params
number
1 to 100

Limit. Default value is 20.

string

Starting after is an object ID that defines your place in the list.

string

Contributor email.

string
length between 1 and 50

The affiliate code (brandCode) is an identifier for the "brand" or "affiliate" within a Tenant. The affiliate code is the version of the brand name that appears in the URL. A brand name may be "Corporate ABC", for example. Then the affiliate code might be something like "corporate-abc".

string
length between 1 and 100

Contributor's first name.

string
length between 1 and 100

Contributor's last name.

string
length between 1 and 200

Business name.

integer
1 to 3650

Filter invitations created in the last X days.

Valid Range: 1 to 3650 days (approximately 10 years)
Examples:

  • 7: Last week
  • 30: Last month
  • 90: Last quarter
  • 365: Last year

Note: This filters by invitation creation date (createdAt field).

integer
1 to 3650

Filter invitations created up to X days ago (older than X days).

Valid Range: 1 to 3650 days (approximately 10 years)
Examples:

  • 7: Older than one week
  • 30: Older than one month
  • 90: Older than one quarter
  • 365: Older than one year

Combine with openSinceDays: Create date windows for specific time periods
Note: This filters by invitation creation date (createdAt field).

string
enum

Sort response by field.

Allowed:
string
enum

Sort response order.

Allowed:
boolean

Filter users who have lock.

Response

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json