Get all Organization invitations
GET https://{{base_url}}/v3/organizations/{{organization_uid}}/share
The Get all organization invitations call gives you a list of all the Organization invitations. Only the owner or the admin of the Organization can resend the invitation to add users to an Organization.
To use the API Request, you will need to authenticate yourself either with a Management Token (highly recommended) or an Authtoken.
Read more about it in Authentication.
For more information, refer to the Get all Organization invitations API Reference document
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
limit | number | The ‘limit’ parameter will return a specific number of sent organization invitations in the output. Example, if 10 invitations were sent out and you wish to fetch only the first 8, you need to specify '2' as the value in this parameter. | |
skip | number | The ‘skip’ parameter will skip a specific number of organization roles in the output. Example, if there are 12 organization roles and you want to skip the last 2 to get only the first 10 in the response body, you need to specify ‘2’ here. | |
asc | string | The ‘asc’ parameter allows you to sort the list of organization invitations in ascending order on the basis of a specific parameter. | |
desc | string | The ‘desc’ parameter allows you to sort the list of organization invitations in descending order on the basis of a specific parameter. | |
include_count | boolean | The ‘include_count’ parameter returns the total number of organization invitations sent out. Example: If you wish to know the total number of organization invitations, you need to mention ‘true’. | |
include_roles | boolean | The ‘include_roles’ parameter, when set to ‘true’, will display the details of the roles that are assigned to the user in an organization. | |
include_invited_by | boolean | The ‘include_invited_by’ parameter, when set to ‘true’, includes the details of the user who sent out the organization invitation. | |
include_user_details | boolean | The ‘include_user_details’ parameter, when set to ‘true’, lets you know whether the user who has been sent the organization invitation has enabled Two-factor Authentication or not. | |
typeahead | string | The ‘typeahead’ parameter allows you to perform a name-based search on all the stacks on an organization based on the value provided. For example, it allows you to perform an email-ID-based search on all users based on the email ID provided. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
authtoken | string | Enter the authtoken of the user. | |
Content-Type | string |