# \GroupControllerApi
All URIs are relative to *https://api.mailslurp.com*
[**add_contacts_to_group**](GroupControllerApi.md#add_contacts_to_group) | **Put** /groups/{groupId}/contacts | Add contacts to a group
[**create_group**](GroupControllerApi.md#create_group) | **Post** /groups | Create a group
[**delete_group**](GroupControllerApi.md#delete_group) | **Delete** /groups/{groupId} | Delete group
[**get_all_groups**](GroupControllerApi.md#get_all_groups) | **Get** /groups/paginated | Get all Contact Groups in paginated format
[**get_group**](GroupControllerApi.md#get_group) | **Get** /groups/{groupId} | Get group
[**get_group_with_contacts**](GroupControllerApi.md#get_group_with_contacts) | **Get** /groups/{groupId}/contacts | Get group and contacts belonging to it
[**get_group_with_contacts_paginated**](GroupControllerApi.md#get_group_with_contacts_paginated) | **Get** /groups/{groupId}/contacts-paginated | Get group and paginated contacts belonging to it
[**get_groups**](GroupControllerApi.md#get_groups) | **Get** /groups | Get all groups
[**remove_contacts_from_group**](GroupControllerApi.md#remove_contacts_from_group) | **Delete** /groups/{groupId}/contacts | Remove contacts from a group
## add_contacts_to_group
> crate::models::GroupContactsDto add_contacts_to_group(group_id, update_group_contacts_option)
Add contacts to a group
### Parameters
**group_id** | [**String**](.md) | groupId | [required] |
**update_group_contacts_option** | [**UpdateGroupContacts**](UpdateGroupContacts.md) | updateGroupContactsOption | [required] |
### Return type
[**crate::models::GroupContactsDto**](GroupContactsDto.md)
### Authorization
[API_KEY](../README.md#API_KEY)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## create_group
> crate::models::GroupDto create_group(create_group_options)
Create a group
### Parameters
**create_group_options** | [**CreateGroupOptions**](CreateGroupOptions.md) | createGroupOptions | [required] |
### Return type
[**crate::models::GroupDto**](GroupDto.md)
### Authorization
[API_KEY](../README.md#API_KEY)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## delete_group
> delete_group(group_id)
Delete group
### Parameters
**group_id** | [**String**](.md) | groupId | [required] |
### Return type
(empty response body)
### Authorization
[API_KEY](../README.md#API_KEY)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_all_groups
> crate::models::PageGroupProjection get_all_groups(page, size, sort)
Get all Contact Groups in paginated format
### Parameters
**page** | Option<**i32**> | Optional page index in inbox list pagination | |[default to 0]
**size** | Option<**i32**> | Optional page size in inbox list pagination | |[default to 20]
**sort** | Option<**String**> | Optional createdAt sort direction ASC or DESC | |[default to ASC]
### Return type
[**crate::models::PageGroupProjection**](PageGroupProjection.md)
### Authorization
[API_KEY](../README.md#API_KEY)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_group
> crate::models::GroupDto get_group(group_id)
Get group
### Parameters
**group_id** | [**String**](.md) | groupId | [required] |
### Return type
[**crate::models::GroupDto**](GroupDto.md)
### Authorization
[API_KEY](../README.md#API_KEY)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_group_with_contacts
> crate::models::GroupContactsDto get_group_with_contacts(group_id)
Get group and contacts belonging to it
### Parameters
**group_id** | [**String**](.md) | groupId | [required] |
### Return type
[**crate::models::GroupContactsDto**](GroupContactsDto.md)
### Authorization
[API_KEY](../README.md#API_KEY)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_group_with_contacts_paginated
> crate::models::PageContactProjection get_group_with_contacts_paginated(group_id, page, size, sort)
Get group and paginated contacts belonging to it
### Parameters
**group_id** | [**String**](.md) | groupId | [required] |
**page** | Option<**i32**> | Optional page index in group contact pagination | |[default to 0]
**size** | Option<**i32**> | Optional page size in group contact pagination | |[default to 20]
**sort** | Option<**String**> | Optional createdAt sort direction ASC or DESC | |[default to ASC]
### Return type
[**crate::models::PageContactProjection**](PageContactProjection.md)
### Authorization
[API_KEY](../README.md#API_KEY)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## get_groups
> Vec<crate::models::GroupProjection> get_groups()
Get all groups
### Parameters
This endpoint does not need any parameter.
### Return type
[**Vec<crate::models::GroupProjection>**](GroupProjection.md)
### Authorization
[API_KEY](../README.md#API_KEY)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
## remove_contacts_from_group
> crate::models::GroupContactsDto remove_contacts_from_group(group_id, update_group_contacts_option)
Remove contacts from a group
### Parameters
**group_id** | [**String**](.md) | groupId | [required] |
**update_group_contacts_option** | [**UpdateGroupContacts**](UpdateGroupContacts.md) | updateGroupContactsOption | [required] |
### Return type
[**crate::models::GroupContactsDto**](GroupContactsDto.md)
### Authorization
[API_KEY](../README.md#API_KEY)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)