List Invitations

See who you invited and has not signed up yet.

GET

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Query

FiltersNarrow list results with a provider-supported where expression. Learn more

string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Response fields

idstring

The invitation's id: the pending member's userId (List Members), until they sign up.

emailstring

Who was invited.

roleIdstring

The role they get when they join, from List Roles.

roleNamestring

That role's name.

statusstring

pending while they have not signed up. Create Invitation answers accepted for someone who already had a MindCloud account and joined at once; they are then a member (List Members).

pending
accepted

createdOndate

When they were invited.