HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference
Start typing to search…

List all invitations.

get https://{tenanturl}/v1.0/usc/user/invitation

Entitlements required: inviteUser (Invite user).

This API is a public preview and is enabled for a tenant that includes invite user beta support.

Searching, sorting, and paging are supported. A maximum of 1000 records are returned for a search query. By default up to 200 records are returned, unless you specify the pagination limit to return.

Example search query:

search=email="bob@mailinator.com"&sort=+email&pagination=limit=1000&page=1
The search query URL encoded:
search=email%3D%22bob%40mailinator.com%22&sort=%2Bemail&pagination=limit%3D1000%26page%3D1


Always URL encode query parameter values to ensure that they do not become malformed during transmission.

Query Params
string

Returns results based on the search criteria.

The format to use the search query parameter is 'search={parameter}{operator}{value}
The following search parameters are allowed: email.

Valid operators for string values are =.

Example: search=email="john@abc.com"

string

Returns sorted results.
The following sort parameters are allowed: email.
Each sort parameter must be prefixed with either + or -.

Example: Sort attributes by ascending 'email': sort=+email

string

Returns results based on the requested limit and page. The following pagination parameters are allowed: limit, page
The limit is 1000 and page starts at 1.
Example: pagination=limit=1000&page=1

Responses

Updated 9 months ago

Did this page help you?
Language
URL
Choose an example:
application/json

Updated 9 months ago

Did this page help you?