listPendingOrganizationInvitations method

Future<OrganizationInvitations?> listPendingOrganizationInvitations(
  1. String organizationId, {
  2. int? limit,
  3. int? offset,
})

Get a list of pending organization invitations

This request returns the list of organization invitations with "pending" status. These are the organization invitations that can still be used to join the organization, but have not been accepted by the invited user yet. Results can be paginated using the optional limit and offset query parameters. The organization invitations are ordered by descending creation date. Most recent invitations will be returned first. Any invitations created as a result of an Organization Domain are not included in the results.

Parameters:

  • String organizationId (required): The organization ID.

  • int limit: Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

  • int offset: Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Implementation

Future<OrganizationInvitations?> listPendingOrganizationInvitations(
  String organizationId, {
  int? limit,
  int? offset,
}) async {
  final response = await listPendingOrganizationInvitationsWithHttpInfo(
    organizationId,
    limit: limit,
    offset: offset,
  );
  if (response.statusCode >= HttpStatus.badRequest) {
    throw ApiException(response.statusCode, await _decodeBodyBytes(response));
  }
  // When a remote server returns no body with a status of 204, we shall not decode it.
  // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
  // FormatException when trying to decode an empty string.
  if (response.body.isNotEmpty &&
      response.statusCode != HttpStatus.noContent) {
    return await apiClient.deserializeAsync(
      await _decodeBodyBytes(response),
      'OrganizationInvitations',
    ) as OrganizationInvitations;
  }
  return null;
}