listInstanceOrganizationInvitations method

Future<OrganizationInvitationsWithPublicOrganizationData?> listInstanceOrganizationInvitations({
  1. String? orderBy,
  2. String? status,
  3. String? query,
  4. int? limit,
  5. int? offset,
})

Get a list of organization invitations for the current instance

This request returns the list of organization invitations for the instance. Results can be paginated using the optional limit and offset query parameters. You can filter them by providing the 'status' query parameter, that accepts multiple values. You can change the order by providing the 'order' query parameter, that accepts multiple values. You can filter by the invited user email address providing the query query parameter. The organization invitations are ordered by descending creation date by default.

Parameters:

  • String orderBy: Allows to return organization invitations in a particular order. At the moment, you can order the returned organization invitations either by their created_at or email_address. In order to specify the direction, you can use the +/- symbols prepended in the property to order by. For example, if you want organization invitations to be returned in descending order according to their created_at property, you can use -created_at. If you don't use + or -, then + is implied. Defaults to -created_at.

  • String status: Filter organization invitations based on their status

  • String query: Filter organization invitations based on their email_address

  • 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<OrganizationInvitationsWithPublicOrganizationData?>
    listInstanceOrganizationInvitations({
  String? orderBy,
  String? status,
  String? query,
  int? limit,
  int? offset,
}) async {
  final response = await listInstanceOrganizationInvitationsWithHttpInfo(
    orderBy: orderBy,
    status: status,
    query: query,
    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),
      'OrganizationInvitationsWithPublicOrganizationData',
    ) as OrganizationInvitationsWithPublicOrganizationData;
  }
  return null;
}