API Reference

List outstanding Invites for an Organization or a User Group

get
https://app.yoodli.ai/api/v3/orgs//invites

Returns outstanding invites scoped to an Organization or a User Group. Several filtering, sorting, and pagination options are available.

Rate limit category: Fast API

Path Params
string
required

Organization ID.

Query Params
string
enum

Sort option. If not specified, invites are sorted by email in ascending order.

Possible values:

  • email – Sort by email in ascending order.
  • -email – Sort by email in descending order.
  • date_invited – Sort by date invited in ascending order.
  • -date_invited – Sort by date invited in descending order.
Allowed:
string

Start index of the list. If not specified, 0 is used.

string

Maximum number of elements in paginated response. Maximum is 1000. If not specified, 20 is used as the default value.

string

User Group ID. If specified, limit the response to invites for a specific User Group.

string

Filter invites matching a prefix for the selected sort field. Works only with email or -email sort options.

Responses

Updated 6 months ago

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

Updated 6 months ago