getOrganizationInvitationList()
Retrieves a list of organization invitations that have not yet been accepted.
- Name
organizationId
- Type
string
- Description
The ID of the organization to retrieve the list of pending invitations from.
- Name
limit?
- Type
number
- Description
The number of results to return. Must be an integer greater than zero and less than 501.
- Name
offset?
- Type
number
- Description
The number of results to skip.
getOrganizationInvitationList()
examples
getOrganizationInvitationList({ organizationId})
In this example, you can see that the returned PaginatedResourceResponse
includes data
, which is an array of OrganizationInvitation
objects, and totalCount
, which indicates the total number of organization invitations in the system for the specified organization.
getOrganizationInvitationList({ organizationId, status })
Retrieves organization invitation list that is filtered by the status of the invitation.
getOrganizationInvitationList({ organizationId, limit })
Retrieves organization invitation list that is filtered by the number of results.
getOrganizationInvitationList({ organizationId, offset })
Retrieves organization invitation list that is filtered by the number of results to skip.
Backend API (BAPI) endpoint
This method in the SDK is a wrapper around the BAPI endpoint GET/organizations/{organization_id}/invitations
. See the BAPI reference for more details.