Search pending sponsored invitations

get

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v2/tenants/tenant/tenant-id/{tenantId}/users/invitations/pending-sponsorship

Path Params

tenantId

string

required

Tenant identifier.

Query Params

limit

number

1 to 100

Limit. Default value is 20.

startingAfter

string

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

string

Contributor email.

brandCode

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".

firstName

string

length between 1 and 100

Contributor's first name.

lastName

string

length between 1 and 100

Contributor's last name.

businessName

string

length between 1 and 200

Business name.

openSinceDays

number

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

Implementation: Filters by invitation createdAt timestamp using $gte MongoDB operator.

openUntilDays

number

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

Implementation: Filters by invitation createdAt timestamp using $gte MongoDB operator.
Combine with openSinceDays: Create date windows (e.g., openSinceDays=20&openUntilDays=25 = 20-25 days old).

sortBy

string

enum

Sort response by field.

Allowed:

orderBy

string

enum

Sort response order.

Allowed:

lock

boolean

Filter users who have lock.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The list of invitations.