getGroups method

Future<DynamiteResponse<GroupsGetGroupsResponseApplicationJson, void>> getGroups({
  1. String? search,
  2. int? limit,
  3. int? offset,
  4. bool? oCSAPIRequest,
})

Get a list of groups.

Returns a Future containing a DynamiteResponse with the status code, deserialized body and headers. Throws a DynamiteApiException if the API call does not return an expected status code.

Parameters:

  • search Text to search for. Defaults to ''.
  • limit Limit the amount of groups returned.
  • offset Offset for searching for groups. Defaults to 0.
  • oCSAPIRequest Required to be true for the API request to pass. Defaults to true.

Status codes:

  • 200: Groups returned

See:

Implementation

Future<DynamiteResponse<GroupsGetGroupsResponseApplicationJson, void>> getGroups({
  String? search,
  int? limit,
  int? offset,
  bool? oCSAPIRequest,
}) async {
  final rawResponse = getGroupsRaw(
    search: search,
    limit: limit,
    offset: offset,
    oCSAPIRequest: oCSAPIRequest,
  );

  return rawResponse.future;
}