# CustomFieldSetsApi

All URIs are relative to *http://localhost:8889/api*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getAll**](#getall) | **GET** /customfieldsets | Get custom field sets|
|[**getAllBySetId**](#getallbysetid) | **GET** /customfieldsets/{customFieldSetId}/customfields | Get custom field definitions by custom field set|

# **getAll**
> Array<CustomFieldSetMeta> getAll()


### Example

```typescript
import {
    CustomFieldSetsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new CustomFieldSetsApi(configuration);

let offset: number; //Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results (optional) (default to undefined)
let limit: number; //Pagination, the number of elements to retrieve, used in combination with offset to paginate results (optional) (default to undefined)
let paginationDetails: 'ON' | 'OFF'; //Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs (optional) (default to 'OFF')
let detailsLevel: 'BASIC' | 'FULL'; //The level of details to return: `FULL` means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and `BASIC` will return only the first level elements of the object. (optional) (default to undefined)
let availableFor: Array<'CLIENT' | 'GROUP' | 'CREDIT_ARRANGEMENT' | 'LOAN_ACCOUNT' | 'GUARANTOR' | 'ASSET' | 'DEPOSIT_ACCOUNT' | 'DEPOSIT_PRODUCT' | 'TRANSACTION_CHANNEL' | 'TRANSACTION_TYPE' | 'BRANCH' | 'CENTRE' | 'USER'>; //The entity that the custom field set is associated with (optional) (default to undefined)
let displaySettingsBuiltIn: boolean; //Indicates if it is a built in custom field set or not  (optional) (default to undefined)

const { status, data } = await apiInstance.getAll(
    offset,
    limit,
    paginationDetails,
    detailsLevel,
    availableFor,
    displaySettingsBuiltIn
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **offset** | [**number**] | Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results | (optional) defaults to undefined|
| **limit** | [**number**] | Pagination, the number of elements to retrieve, used in combination with offset to paginate results | (optional) defaults to undefined|
| **paginationDetails** | [**&#39;ON&#39; | &#39;OFF&#39;**]**Array<&#39;ON&#39; &#124; &#39;OFF&#39;>** | Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs | (optional) defaults to 'OFF'|
| **detailsLevel** | [**&#39;BASIC&#39; | &#39;FULL&#39;**]**Array<&#39;BASIC&#39; &#124; &#39;FULL&#39;>** | The level of details to return: &#x60;FULL&#x60; means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and &#x60;BASIC&#x60; will return only the first level elements of the object. | (optional) defaults to undefined|
| **availableFor** | **Array<&#39;CLIENT&#39; &#124; &#39;GROUP&#39; &#124; &#39;CREDIT_ARRANGEMENT&#39; &#124; &#39;LOAN_ACCOUNT&#39; &#124; &#39;GUARANTOR&#39; &#124; &#39;ASSET&#39; &#124; &#39;DEPOSIT_ACCOUNT&#39; &#124; &#39;DEPOSIT_PRODUCT&#39; &#124; &#39;TRANSACTION_CHANNEL&#39; &#124; &#39;TRANSACTION_TYPE&#39; &#124; &#39;BRANCH&#39; &#124; &#39;CENTRE&#39; &#124; &#39;USER&#39;>** | The entity that the custom field set is associated with | (optional) defaults to undefined|
| **displaySettingsBuiltIn** | [**boolean**] | Indicates if it is a built in custom field set or not  | (optional) defaults to undefined|


### Return type

**Array<CustomFieldSetMeta>**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Custom field sets returned. |  * Items-Limit - Pagination details, the requested page size <br>  * Items-Offset - Pagination details, the index of the first returned item <br>  * Items-Total - Pagination details, the total available items <br>  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |

[[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)

# **getAllBySetId**
> Array<CustomFieldMeta> getAllBySetId()


### Example

```typescript
import {
    CustomFieldSetsApi,
    Configuration
} from './api';

const configuration = new Configuration();
const apiInstance = new CustomFieldSetsApi(configuration);

let customFieldSetId: string; //The encoded key or ID of the custom field set used to get all the custom field definitions of that set. (default to undefined)
let offset: number; //Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results (optional) (default to undefined)
let limit: number; //Pagination, the number of elements to retrieve, used in combination with offset to paginate results (optional) (default to undefined)
let paginationDetails: 'ON' | 'OFF'; //Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs (optional) (default to 'OFF')
let detailsLevel: 'BASIC' | 'FULL'; //The level of details to return: `FULL` means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and `BASIC` will return only the first level elements of the object. (optional) (default to undefined)

const { status, data } = await apiInstance.getAllBySetId(
    customFieldSetId,
    offset,
    limit,
    paginationDetails,
    detailsLevel
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **customFieldSetId** | [**string**] | The encoded key or ID of the custom field set used to get all the custom field definitions of that set. | defaults to undefined|
| **offset** | [**number**] | Pagination, index to start searching at when retrieving elements, used in combination with limit to paginate results | (optional) defaults to undefined|
| **limit** | [**number**] | Pagination, the number of elements to retrieve, used in combination with offset to paginate results | (optional) defaults to undefined|
| **paginationDetails** | [**&#39;ON&#39; | &#39;OFF&#39;**]**Array<&#39;ON&#39; &#124; &#39;OFF&#39;>** | Flag specifying whether the pagination  details should be provided in response headers. Please note that by default it is disabled (OFF), in order to improve the performance of the APIs | (optional) defaults to 'OFF'|
| **detailsLevel** | [**&#39;BASIC&#39; | &#39;FULL&#39;**]**Array<&#39;BASIC&#39; &#124; &#39;FULL&#39;>** | The level of details to return: &#x60;FULL&#x60; means the full details of the object will be returned (custom field values, address, contact info, or any other related objects) and &#x60;BASIC&#x60; will return only the first level elements of the object. | (optional) defaults to undefined|


### Return type

**Array<CustomFieldMeta>**

### Authorization

[basic](../README.md#basic)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/vnd.mambu.v2+json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Custom field list returned. |  * Items-Limit - Pagination details, the requested page size <br>  * Items-Offset - Pagination details, the index of the first returned item <br>  * Items-Total - Pagination details, the total available items <br>  |
|**400** | A validation error occurred |  -  |
|**401** | Unauthorized |  -  |
|**403** | Forbidden |  -  |
|**404** | Custom field set not found. |  -  |

[[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)