Kerio Connect API Client Reference

https://manuals.gfi.com/en/kerio/api/connect/client/reference/
Admin
Kerio Connect API Client Reference documentation providing interface definitions and API...
Tokens:92,648
Snippets:1,029
Trust Score:9.4
Update:5 months ago
Show doc for...
Tokens:
Raw
### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1certificates_1_1_certificates.html

Retrieves a list of all certificates from the store.

```APIDOC
## get

### Description
Retrieves a list of all certificates available in the certificate store.

### Method
void

### Returns
- **certificates** (CertificateList) - A list of certificates.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1folders_1_1_folders-members.html

Retrieves a list of all folders.

```APIDOC
## get

### Description
Retrieves a list of all folders.

### Method
Not specified (likely a method call within the SDK)

### Parameters
#### Path Parameters
- **list** (FolderList) - Output - A list of folder objects.

### Response
#### Success Response (200)
- No specific success response details provided.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1certificates_1_1_certificates-members.html

Retrieves a list of all available certificates.

```APIDOC
## get

### Description
Retrieves a list of all certificates available in the system.

### Method
Not specified (assumed to be a method call within an SDK or API)

### Parameters
- **certificates** (CertificateList) - Output parameter to receive the list of certificates.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1folders_1_1_folders.html

Retrieves a list of folders accessible to the currently logged-in user.

```APIDOC
## get

### Description
Obtains a list of folders for the currently logged-in user.

### Parameters
#### Path Parameters
* **list** (FolderList) - Output - A list to be populated with the user's folders.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_folders_8idl_source.html

Retrieves a list of all folders accessible by the currently logged-in user.

```APIDOC
## get

### Description
Obtains a list of all folders belonging to the currently logged-in user.

### Method
void

### Parameters
#### Path Parameters
- **list** (FolderList) - Output - A list of folders.
```

--------------------------------

### Get Sync Key

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1changes_1_1_changes-members.html

Retrieves the general synchronization key.

```APIDOC
## getSyncKey

### Description
Retrieves the general synchronization key.

### Method Signature
`getSyncKey(out SyncKey syncKey)`

### Parameters
#### Output Parameters
- **syncKey** (SyncKey) - The general synchronization key.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1contacts_1_1_contacts-members.html

Retrieves contacts based on folder IDs and a search query.

```APIDOC
## get

### Description
Retrieves a list of contacts from specified folders based on a search query.

### Method
GET

### Endpoint
/contacts/get

### Parameters
#### Path Parameters
None

#### Query Parameters
- **folderIds** (KIdList) - Required - A list of folder IDs to search within.
- **query** (SearchQuery) - Required - The search query parameters.

### Response
#### Success Response (200)
- **list** (ContactList) - A list of contacts matching the query.
- **totalItems** (long) - The total number of items found.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1notes_1_1_notes-members.html

Retrieves notes based on specified folder IDs and search query.

```APIDOC
## get

### Description
Retrieves notes from specified folders, with options for searching and pagination.

### Method
Not specified (assumed to be part of a JSON API call)

### Endpoint
Not specified

### Parameters
#### Path Parameters
None

#### Query Parameters
- **folderIds** (kerio::web::KIdList) - Required - List of folder IDs to retrieve notes from.
- **query** (kerio::web::SearchQuery) - Optional - Search query parameters.

### Request Example
```json
{
  "folderIds": ["folder1", "folder2"],
  "query": {
    "filter": "important",
    "limit": 10,
    "offset": 0
  }
}
```

### Response
#### Success Response (200)
- **list** (NoteList) - A list of notes matching the criteria.
- **totalItems** (long) - The total number of items found.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1alarms_1_1_alarms-members.html

Retrieves a list of alarms within a specified time range.

```APIDOC
## get

### Description
Retrieves alarms that fall within the specified time range.

### Method Signature
get(out AlarmList list, in UtcTime since, in UtcTime until)

### Parameters
- **list** (out AlarmList) - A list to populate with the retrieved alarms.
- **since** (in UtcTime) - The start of the time range (inclusive).
- **until** (in UtcTime) - The end of the time range (inclusive).
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1notes_1_1_notes.html

Retrieves a list of notes based on specified folder IDs and search criteria.

```APIDOC
## get

### Description
Get a list of notes.

### Parameters
- **list** (NoteList) - all found notes
- **totalItems** (long) - number of notes found if there is no limit
- **folderIds** (kerio::web::KIdList) - list of global identifiers of folders to be listed.
- **query** (kerio::web::SearchQuery) - query attributes and limits
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1tasks_1_1_tasks-members.html

Retrieves tasks based on folder IDs and search query. Returns a list of tasks and the total number of items.

```APIDOC
## get

### Description
Retrieves tasks based on folder IDs and search query.

### Method
get

### Parameters
- **list** (out TaskList) - Output parameter for the list of tasks.
- **totalItems** (out long) - Output parameter for the total number of items found.
- **folderIds** (in kerio::web::KIdList) - Input parameter for a list of folder IDs to search within.
- **query** (in kerio::web::SearchQuery) - Input parameter for the search query.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1events_1_1_events.html

Retrieves a list of events based on provided IDs and search query.

```APIDOC
## get

### Description
Retrieves a list of events based on provided IDs and search query.

### Parameters
- **list** (EventList) - Output parameter for all found events.
- **totalItems** (long) - Output parameter for the total number of events found (if no limit is set).
- **ids** (kerio::web::KIdList) - Input parameter: list of global identifiers of folders to be listed.
- **query** (kerio::web::SearchQuery) - Input parameter: query attributes and limits.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1principals_1_1_principals-members.html

Retrieves a list of principals (users, groups, domains) based on specified filters.

```APIDOC
## get

### Description
Retrieves a list of principals, optionally filtering by users, groups, or domains.

### Method Signature
`get(out PrincipalList list, in boolean users, in boolean groups, in boolean domains)`

### Parameters
#### Output Parameters
- **list** (PrincipalList) - Output parameter to store the list of principals.

#### Input Parameters
- **users** (boolean) - If true, include users in the result.
- **groups** (boolean) - If true, include groups in the result.
- **domains** (boolean) - If true, include domains in the result.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1mails_1_1_mails.html

Retrieves a list of e-mails based on specified folder IDs and search queries.

```APIDOC
## get

### Description
Get a list of e-mails.

### Parameters
- **list** (MailList) - out - all found e-mails
- **totalItems** (long) - out - number of mails found if there is no limit
- **folderIds** (kerio::web::KIdList) - in - list of global identifiers of folders to be listed.
- **query** (kerio::web::SearchQuery) - in - query attributes and limits
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1occurrences_1_1_occurrences-members.html

Retrieves a list of occurrences based on specified folder IDs and search criteria.

```APIDOC
## get

### Description
Retrieves a list of occurrences based on specified folder IDs and search criteria.

### Method
Not specified (assumed to be a method call within the SDK/API)

### Parameters
#### Input Parameters
- **folderIds** (kerio::web::KIdList) - Required - The list of folder IDs to search within.
- **query** (kerio::web::SearchQuery) - Required - The search query to filter occurrences.

#### Output Parameters
- **list** (out OccurrenceList) - The list of occurrences found.
- **totalItems** (out long) - The total number of items matching the query.
```

--------------------------------

### init

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1certificates_1_1_certificates.html

Initializes the personal certificate store with a password.

```APIDOC
## init

### Description
Initialize the personal certificate store

### Method
void

### Parameters
#### Path Parameters
- **password** (string) - Required - Password of certificate store
- **isLoginPassword** (boolean) - Required - Given password is the same which user uses to log in
```

--------------------------------

### getPageWithId

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_mails_8idl_source.html

Retrieves a list of emails, similar to 'get', but specifically for a given email ID. It returns the list of emails, a starting index, and the total number of items. It requires folder IDs and search query parameters, with a note that the offset is not used.

```APIDOC
## getPageWithId

### Description
Retrieves a list of emails, similar to 'get', but specifically for a given email ID. It returns the list of emails, a starting index, and the total number of items. It requires folder IDs and search query parameters, with a note that the offset is not used.

### Method
void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **list** (out MailList) - all found e-mails
- **start** (out long) - starting index
- **totalItems** (out long) - number of mails found if there is no limit
- **folderIds** (in kerio::web::KIdList) - list of global identifiers of folders to be listed
- **query** (in kerio::web::SearchQuery) - query attributes and limits. Mind that offset is not used
- **id** (in kerio::web::KId) - global identifier of requested email
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1filters_1_1_filters.html

Gets all user's messages filtering rules. It also provides a dataStamp for concurrent modification protection.

```APIDOC
## get

### Description
Gets all user's messages filtering rules.

### Parameters
#### Path Parameters
* **dataStamp** (unsignedlong) - Output - server as concurrent modification protection and it is an stamp which must be stored by client since it is required for future modification of received list of filter rules (using set method).
* **filters** (FilterRuleList) - Output - list of all messages filtering rules defined by user.

### Response
#### Success Response (200)
* **dataStamp** (unsignedlong) - The current data stamp for modification protection.
* **filters** (FilterRuleList) - The list of all user-defined message filtering rules.
```

--------------------------------

### init

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1certificates_1_1_certificates.html

Initializes the certificate store with a password. Can be used for login password.

```APIDOC
## init

### Description
Initializes the certificate store with a password. The `isLoginPassword` parameter specifies if the password is for login.

### Method
void

### Parameters
- **password** (string) - The password for initialization.
- **isLoginPassword** (boolean) - True if the password is for login, false otherwise.
```

--------------------------------

### init

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1certificates_1_1_certificates-members.html

Initializes a certificate with a given password, specifying if it's for login.

```APIDOC
## init

### Description
Initializes a certificate with a specified password. Can be designated as the login password.

### Method
Not specified (assumed to be a method call within an SDK or API)

### Parameters
- **password** (string) - Required - The password for initialization.
- **isLoginPassword** (boolean) - Required - True if this is the login password, false otherwise.
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1folders_1_1_folders.html

Creates new folders.

```APIDOC
## create

### Description
Creates new folders.

### Method
void

### Parameters
#### Path Parameters
- **folders** (FolderList) - Required - A list of folders to create.

#### Return Values
- **errors** (kerio::web::ErrorList) - A list of errors encountered during creation.
- **result** (kerio::web::CreateResultList) - A list of results for the created folders.
```

--------------------------------

### open

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1certificates_1_1_certificates.html

Opens the certificate store with a given password.

```APIDOC
## open

### Description
Opens the certificate store using the provided password.

### Method
void

### Parameters
- **password** (string) - The password to open the certificate store.
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1folders_1_1_folders-members.html

Creates new folders based on the provided list.

```APIDOC
## create

### Description
Creates new folders. The operation returns a list of errors and creation results.

### Method
Not specified (likely a method call within the SDK)

### Parameters
#### Path Parameters
- **errors** (kerio::web::ErrorList) - Output - A list of errors encountered during creation.
- **result** (kerio::web::CreateResultList) - Output - A list of results for each created folder.
- **folders** (FolderList) - Required - A list of folder objects to create.

### Response
#### Success Response (200)
- No specific success response details provided.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1filters_1_1_filters-members.html

Retrieves all filter rules and their associated data stamp.

```APIDOC
## get

### Description
Retrieves all currently configured email filters and the data stamp for the filters list.

### Method Signature
`get(out unsignedlong dataStamp, out FilterRuleList filters)`

### Parameters
#### Output Parameters
- **dataStamp** (unsignedlong) - The data stamp representing the current state of the filters.
- **filters** (FilterRuleList) - A list containing all the email filter rules.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1contacts_1_1_contacts.html

Retrieves a list of contacts based on specified folder IDs and search queries. Returns the list of contacts and the total number of items found.

```APIDOC
## get

### Description
Retrieves a list of contacts based on specified folder IDs and search queries.

### Method
void

### Parameters
#### Path Parameters
- **_list_** (ContactList) - Output - all found contacts
- **_totalItems_** (long) - Output - number of contacts found if there is no limit
- **_folderIds_** (kerio::web::KIdList) - Input - list of global identifiers of folders to be listed.
- **_query_** (kerio::web::SearchQuery) - Input - query attributes and limits
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1folders_1_1_folders.html

Creates new folders based on the provided list of folder definitions.

```APIDOC
## create

### Description
Creates new folders.

### Parameters
#### Path Parameters
* **errors** (kerio::web::ErrorList) - Output - A list to populate with any error messages.
* **result** (kerio::web::CreateResultList) - Output - A list containing the IDs of the newly created folders.
* **folders** (FolderList) - Input - A list of folder definitions to create.
```

--------------------------------

### Get an event

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_events_8idl_source.html

Retrieves a single event by its global identifier.

```APIDOC
## get

### Description
Retrieves a single event by its global identifier.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method Signature
`void get(out Event result, in kerio::web::KId id)`

### Parameters (detailed)
- **result** (out Event) - The found event.
- **id** (in kerio::web::KId) - The global identifier of the requested event.
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_folders_8idl_source.html

Creates new folders based on the provided list. Returns a list of created folder IDs and any errors encountered.

```APIDOC
## create

### Description
Creates new folders. The method returns a list of IDs for the successfully created folders and a list of any errors that occurred during the process.

### Method
void

### Parameters
#### Path Parameters
- **errors** (kerio::web::ErrorList) - Output - A list of error messages.
- **result** (kerio::web::CreateResultList) - Output - A list containing the IDs of the created folders.
- **folders** (FolderList) - Input - A list of folders to create.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_mails_8idl_source.html

Retrieves a list of emails based on specified criteria. It returns the list of found emails, the total number of items matching the query, and requires folder IDs and search query parameters.

```APIDOC
## get

### Description
Retrieves a list of emails based on specified criteria. It returns the list of found emails, the total number of items matching the query, and requires folder IDs and search query parameters.

### Method
void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **list** (out MailList) - all found e-mails
- **totalItems** (out long) - number of mails found if there is no limit
- **folderIds** (in kerio::web::KIdList) - list of global identifiers of folders to be listed.
- **query** (in kerio::web::SearchQuery) - query attributes and limits
```

--------------------------------

### open

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1certificates_1_1_certificates-members.html

Opens a certificate session using a provided password.

```APIDOC
## open

### Description
Opens a certificate session using the provided password.

### Method
Not specified (assumed to be a method call within an SDK or API)

### Parameters
- **password** (string) - Required - The password to open the certificate session.
```

--------------------------------

### Get Occurrence by ID

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1occurrences_1_1_occurrences.html

Retrieves a specific occurrence by its unique identifiers.

```APIDOC
## getById

### Description
Get an occurrence.

### Method
GET (assumed, based on 'getById' operation)

### Endpoint
/occurrences/{eventId}/{occurrenceId} (assumed path structure)

### Parameters
#### Path Parameters
- **eventId** (kerio::web::KId) - Required - Global identifier of requested occurrence's event.
- **occurrenceId** (kerio::web::KId) - Required - Local identifier of requested occurrence.

#### Response
##### Success Response (200)
- **result** (OccurrenceList) - Found occurrence.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1contacts_1_1_contacts.html

Retrieves contacts based on folder IDs and search criteria.

```APIDOC
## get

### Description
Retrieves a list of contacts from specified folders based on search criteria.

### Method
void

### Parameters
- **list** (ContactList) - out - The list of retrieved contacts.
- **totalItems** (long) - out - The total number of items matching the query.
- **folderIds** (kerio::web::KIdList) - in - A list of folder IDs to search within.
- **query** (kerio::web::SearchQuery) - in - The search query object.
```

--------------------------------

### Get Event Update List

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1events_1_1_events-members.html

Retrieves a list of event updates.

```APIDOC
## GET /events/updates

### Description
Retrieves a list of updates for events.

### Method
GET

### Endpoint
/events/updates
```

--------------------------------

### getSettings

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1session_1_1_session-members.html

Retrieves user settings based on a query.

```APIDOC
## getSettings

### Description
Retrieves user settings based on a query.

### Parameters
#### Path Parameters
- **settings** (out jsonstring) - The user settings in JSON format.
- **query** (in SettingQuery) - The query to specify which settings to retrieve.
```

--------------------------------

### Get Event by ID

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1events_1_1_events-members.html

Retrieves a single event by its unique identifier.

```APIDOC
## GET /events/{id}

### Description
Retrieves a specific event using its unique ID.

### Method
GET

### Endpoint
/events/{id}

### Parameters
#### Path Parameters
- **id** (KId) - Required - The unique identifier of the event.
```

--------------------------------

### openEdit

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1certificates_1_1_certificates-members.html

Opens a certificate for editing with a specified password.

```APIDOC
## openEdit

### Description
Opens a certificate in an editable state using the provided password.

### Method
Not specified (assumed to be a method call within an SDK or API)

### Parameters
- **password** (string) - Required - The password to enable editing.
```

--------------------------------

### Get Event Update List

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1events_1_1_events.html

Retrieves a list of all event updates.

```APIDOC
## getEventUpdateList

### Description
Retrieves a list of all event updates.

### Method
void

### Parameters
#### Path Parameters
- **eventUpdates** (out EventUpdateList) - Output parameter for the list of event updates.
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1notes_1_1_notes.html

Creates new notes.

```APIDOC
## create

### Description
Create notes.

### Parameters
- **errors** (kerio::web::ErrorList) - list of notes that failed on creation
- **result** (CreateResultList) - particular results for all items
- **notes** (NoteList) - list of notes to be created
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1notes_1_1_notes-members.html

Creates new notes.

```APIDOC
## create

### Description
Creates new notes based on the provided list.

### Method
Not specified (assumed to be part of a JSON API call)

### Endpoint
Not specified

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **notes** (NoteList) - Required - A list of notes to create.

### Request Example
```json
{
  "notes": [
    {
      "subject": "New Note 1",
      "content": "This is the content of the first note."
    },
    {
      "subject": "New Note 2",
      "content": "Content for the second note."
    }
  ]
}
```

### Response
#### Success Response (200)
- **errors** (kerio::web::ErrorList) - List of errors encountered during the operation.
- **result** (CreateResultList) - List of results for each created note.
```

--------------------------------

### Get Event Updates

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1events_1_1_events.html

Retrieves updates for a specified list of events.

```APIDOC
## getEventUpdates

### Description
Retrieves updates for a specified list of events.

### Method
void

### Parameters
#### Path Parameters
- **errors** (out kerio::web::ErrorList) - Output parameter for any errors encountered.
- **eventUpdates** (out EventUpdateList) - Output parameter for the list of event updates.
- **ids** (in kerio::web::KIdList) - Input parameter for a list of event IDs.
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_events_8idl_source.html

Creates new events in the system.

```APIDOC
## create

### Description
Create events.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method Signature
void create(out kerio::web::ErrorList errors, out CreateResultList result, in EventList events);
```

--------------------------------

### Get Event by ID

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1events_1_1_events.html

Retrieves a single event by its unique identifier.

```APIDOC
## getById

### Description
Retrieves a single event by its unique identifier.

### Method
void

### Parameters
#### Path Parameters
- **result** (out Event) - Output parameter for the retrieved event.
- **id** (in kerio::web::KId) - Input parameter for the event ID.
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1tasks_1_1_tasks-members.html

Creates new tasks. Returns a list of errors and a creation result list.

```APIDOC
## create

### Description
Creates new tasks.

### Method
create

### Parameters
- **errors** (out kerio::web::ErrorList) - Output parameter for a list of errors.
- **result** (out CreateResultList) - Output parameter for the creation result list.
- **tasks** (in TaskList) - Input parameter for a list of tasks to create.
```

--------------------------------

### Get Inbound Delegation List

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1delegation_1_1_delegation-members.html

Retrieves the list of inbound delegations.

```APIDOC
## getInbound inboundDelegationList

### Description
Retrieves the list of inbound delegations.

### Method
GET (assumed, based on 'get' prefix and 'out' parameter)

### Endpoint
`/jsonrpc.php` (assumed, common for JSON-RPC)

### Parameters
#### Query Parameters
- **list** (InboundDelegationList) - Output parameter for the delegation list.

### Response
#### Success Response (200)
- **list** (InboundDelegationList) - The retrieved inbound delegation list.
```

--------------------------------

### login

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1_call_manager-members.html

Logs a user into the system.

```APIDOC
## login

### Description
Authenticates a user and logs them into the system using their username and password.

### Method
Not specified (assumed to be a method call within the SDK/API).

### Parameters
- **userName** (in string) - The username for login.
- **password** (in string) - The password for authentication.
```

--------------------------------

### Get Outbound Delegation List

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1delegation_1_1_delegation-members.html

Retrieves the list of outbound delegations.

```APIDOC
## get outboundDelegationList

### Description
Retrieves the list of outbound delegations.

### Method
GET (assumed, based on 'get' prefix and 'out' parameter)

### Endpoint
`/jsonrpc.php` (assumed, common for JSON-RPC)

### Parameters
#### Query Parameters
- **list** (OutboundDelagationList) - Output parameter for the delegation list.

### Response
#### Success Response (200)
- **list** (OutboundDelagationList) - The retrieved outbound delegation list.
```

--------------------------------

### login

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1_call_manager.html

Logs in a user with the provided username and password.

```APIDOC
## login

### Description
Logs in a user with the provided username and password.

### Method
void

### Parameters
#### Path Parameters
- **userName** (in string) - The username for login.
- **password** (in string) - The password for login.
```

--------------------------------

### Get Notes By ID

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_notes_8idl_source.html

Retrieves specific notes by their unique identifiers.

```APIDOC
## getById

### Description
Retrieves specific notes by their global identifiers.

### Parameters
#### Path Parameters
None

#### Query Parameters
* **ids** (kerio::web::KIdList) - Required - List of global identifiers of requested notes.

### Request Example
```json
{
  "ids": ["note1_id", "note2_id"]
}
```

### Response
#### Success Response (200)
* **errors** (kerio::web::ErrorList) - A list of errors encountered during retrieval.
* **result** (NoteList) - A list of notes that were successfully retrieved.

#### Response Example
```json
{
  "errors": [],
  "result": [
    {
      "id": "note1_id",
      "folderId": "folder1_id",
      "color": "Yellow",
      "text": "This is a note.",
      "position": {"xOffset": 10, "yOffset": 20, "xSize": 100, "ySize": 80},
      "createDate": "2023-10-27T10:00:00Z",
      "modifyDate": "2023-10-27T10:05:00Z"
    }
  ]
}
```
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_contacts_8idl_source.html

Creates a new contact in a specified folder. It takes contact details and returns a list of created contact IDs and errors.

```APIDOC
## create

### Description
Creates a contact in a particular folder.

### Method
void

### Parameters
#### Path Parameters
- **errors** (out kerio::web::ErrorList) - error message list
- **result** (out CreateResultList) - list of ID of created contacts
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1contacts_1_1_contacts.html

Creates new contacts in a specified folder. Requires a list of contacts and the folder ID to be set.

```APIDOC
## create

### Description
Creates new contacts in a specified folder. Field 'folderId' must be set.

### Method
void

### Parameters
#### Path Parameters
- **_errors_** (kerio::web::ErrorList) - Output - error message list
- **_result_** (CreateResultList) - Output - list of ID of created contacts
- **_contacts_** (ContactList) - Input - new contacts; Field 'folderId' must be set.
```

--------------------------------

### Get Notes

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_notes_8idl_source.html

Retrieves a list of notes based on specified criteria.

```APIDOC
## get

### Description
Retrieves a list of notes. Supports filtering by folder and searching with query parameters.

### Parameters
#### Path Parameters
None

#### Query Parameters
* **folderIds** (kerio::web::KIdList) - Required - List of global identifiers of folders to be listed.
* **query** (kerio::web::SearchQuery) - Required - Query attributes and limits for searching notes.

### Request Example
```json
{
  "folderIds": ["folder1_id", "folder2_id"],
  "query": {
    "search": "example text",
    "limit": 10,
    "offset": 0
  }
}
```

### Response
#### Success Response (200)
* **list** (NoteList) - A list of notes matching the criteria.
* **totalItems** (long) - The total number of notes found without any limit.

#### Response Example
```json
{
  "list": [
    {
      "id": "note1_id",
      "folderId": "folder1_id",
      "color": "Yellow",
      "text": "This is a note.",
      "position": {"xOffset": 10, "yOffset": 20, "xSize": 100, "ySize": 80},
      "createDate": "2023-10-27T10:00:00Z",
      "modifyDate": "2023-10-27T10:05:00Z"
    }
  ],
  "totalItems": 5
}
```
```

--------------------------------

### getPageWithId

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1mails_1_1_mails.html

Retrieves a paginated list of mails starting from a specific ID.

```APIDOC
## getPageWithId

### Description
Retrieves a paginated list of mails starting from a specific ID.

### Method
void

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **folderIds** (kerio::web::KIdList) - Required - The list of folder IDs to search within.
- **query** (kerio::web::SearchQuery) - Required - The search query to filter the mails.
- **id** (kerio::web::KId) - Required - The ID of the mail to start pagination from.
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1contacts_1_1_contacts-members.html

Creates new contacts.

```APIDOC
## create

### Description
Creates new contacts based on the provided list.

### Method
POST

### Endpoint
/contacts/create

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **contacts** (ContactList) - Required - A list of contacts to create.

### Response
#### Success Response (200)
- **errors** (ErrorList) - A list of errors encountered during the operation.
- **result** (CreateResultList) - A list of results for each created contact.
```

--------------------------------

### getExtensions

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1_call_manager-members.html

Retrieves a list of available extensions.

```APIDOC
## getExtensions

### Description
Retrieves a list of all available extensions.

### Method
Not specified (assumed to be a method call within the SDK/API).

### Parameters
- **extensions** (out OperatorExtensionList) - Output parameter to store the list of extensions.
```

--------------------------------

### get

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1mails_1_1_mails-members.html

Retrieves mail items from specified folders based on a search query.

```APIDOC
## get

### Description
Retrieves mail items from specified folders based on a search query.

### Method
Not specified (likely a JSON-RPC or similar method call)

### Parameters
- **list** (out MailList) - Output parameter for the list of retrieved mail items.
- **totalItems** (out long) - Output parameter for the total number of items matching the query.
- **folderIds** (in kerio::web::KIdList) - List of folder IDs to search within.
- **query** (in kerio::web::SearchQuery) - The search query to apply.
```

--------------------------------

### login

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1session_1_1_session.html

Logs in a user with the provided username and password, returning an authentication token.

```APIDOC
## login

### Description
Log in given user.

### Parameters
- **_token_** (out string)
- **_userName_** (in string)
- **_password_** (in string)
- **_application_** (in kerio::web::ApiApplication) - application discriminator, note that with session to admin you cannot log in webmail
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_contacts_8idl_source.html

Creates new contacts. The 'folderId' field must be set for each contact.

```APIDOC
## create

### Description
Creates new contacts. The 'folderId' field must be set for each contact.

### Method
void

### Parameters
#### In Parameters
- **contacts** (ContactList) - new contacts; Field 'folderId' must be set.

#### Out Parameters
- **errors** (kerio::web::ErrorList)
- **result** (CreateResultList)
```

--------------------------------

### Get Event Updates by IDs

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1events_1_1_events-members.html

Retrieves updates for a specific list of events.

```APIDOC
## GET /events/updates/{ids}

### Description
Retrieves updates for a specified list of event IDs.

### Method
GET

### Endpoint
/events/updates/{ids}

### Parameters
#### Path Parameters
- **ids** (KIdList) - Required - A list of event IDs for which to retrieve updates.
```

--------------------------------

### Get Inbound Delegation List

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1delegation_1_1_delegation.html

Retrieves the list of accounts that have been delegated to the user.

```APIDOC
## getInbound

### Description
Get list of accounts whom is the user delegate.

### Method
void

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **list** (InboundDelegationList) - delegates
```

--------------------------------

### Get Occurrence from Attachment

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_occurrences_8idl_source.html

Retrieves an occurrence associated with a specific attachment ID.

```APIDOC
## getFromAttachment

### Description
Get an occurrence.

### Method
void

### Parameters
#### Input Parameters
- **attachmentId** (kerio::web::KId) - global identifier of attachment

#### Output Parameters
- **result** (Occurrence) - out - found occurrence
```

--------------------------------

### kerio::jsonapi::webmail::CallManager::login

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/group___server.html

Logs the user into the Kerio Connect system.

```APIDOC
## kerio::jsonapi::webmail::CallManager::login

### Description
Logs the user into the Kerio Connect system.

### Method
void

### Parameters
#### Path Parameters
* **userName** (string) - in - The username for login.
* **password** (string) - in - The password for login.
```

--------------------------------

### getMessages

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1im_1_1im-members.html

Retrieves a list of messages for a given conversation, starting from a specific message.

```APIDOC
## getMessages

### Description
Retrieves a list of messages for a specified conversation.

### Method
GET

### Endpoint
/im/getMessages

### Parameters
#### Query Parameters
- **conversationId** (ConversationId) - Required - The ID of the conversation.
- **currentMessageId** (MessageId) - Optional - The ID of the last message retrieved, to fetch messages after this one.
- **count** (long) - Optional - The maximum number of messages to retrieve.

### Response
#### Success Response (200)
- **list** (MessageList) - A list of messages.

### Response Example
```json
{
  "list": [
    {
      "id": "msg_456",
      "conversationId": "conv_123",
      "senderId": "contact_abc",
      "text": "Hello!",
      "timestamp": "2023-10-27T10:00:00Z"
    }
  ]
}
```
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1events_1_1_events.html

Creates new events.

```APIDOC
## create

### Description
Creates new events.

### Parameters
- **errors** (kerio::web::ErrorList) - Output parameter for events that failed creation.
- **result** (CreateResultList) - Output parameter for particular results for all created items.
- **events** (EventList) - Input parameter: list of events to be created.
```

--------------------------------

### set

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1folders_1_1_folders-members.html

Updates existing folders with new information.

```APIDOC
## set

### Description
Updates existing folders with new information. The operation returns a list of errors encountered.

### Method
Not specified (likely a method call within the SDK)

### Parameters
#### Path Parameters
- **errors** (kerio::web::ErrorList) - Output - A list of errors encountered during the update.
- **folders** (FolderList) - Required - A list of folder objects with updated information.

### Response
#### Success Response (200)
- No specific success response details provided.
```

--------------------------------

### Integration Interface Methods

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_integration_8idl_source.html

This section details the methods available within the Integration interface for managing synchronized folders.

```APIDOC
## getASyncFolderList

### Description
Obtain a list of folders for the currently logged-in user.

### Method
void

### Parameters
#### Out Parameters
- **list** (SyncFolderList) - A list of SyncFolder objects representing the user's folders.

## setASyncFolderList

### Description
Set folder properties for synchronization.

### Method
void

### Parameters
#### Out Parameters
- **errors** (kerio::web::ErrorList) - A list of error messages encountered during the operation.
- **folders** (SyncFolderList) - A list of SyncFolder objects with properties to be saved.

## getIPhoneSyncFolderList

### Description
Obtain a list of folders specifically for tasks and calendars, optimized for iPhone synchronization.

### Method
void

### Parameters
#### Out Parameters
- **list** (SyncFolderList) - A list of SyncFolder objects representing the task and calendar folders.

## setIPhoneSyncFolderList

### Description
Set folder properties for tasks and calendars, optimized for iPhone synchronization.

### Method
void

### Parameters
#### Out Parameters
- **errors** (kerio::web::ErrorList) - A list of error messages encountered during the operation.
- **folders** (SyncFolderList) - A list of SyncFolder objects with properties to be saved for tasks and calendars.
```

--------------------------------

### kerio::web::ApiApplication

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/structkerio_1_1web_1_1_api_application.html

Represents a client (third-party) application or script that utilizes the Administration API. It includes details about the application's name, vendor, and version.

```APIDOC
## kerio::web::ApiApplication

### Description
Describes client (third-party) application or script which uses the Administration API.

### Member Data Documentation

string kerio::web::ApiApplication::name
---
E.g. "Simple server monitor".

string kerio::web::ApiApplication::vendor
---
E.g. "MyScript Ltd.".

string kerio::web::ApiApplication::version
---
E.g. "1.0.0 beta 1".
```

--------------------------------

### getSpamSettings

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1session_1_1_session-members.html

Retrieves the spam settings for the user.

```APIDOC
## getSpamSettings

### Description
Retrieves the spam settings for the user.

### Parameters
#### Path Parameters
- **settings** (out SpamSettings) - The spam settings.
```

--------------------------------

### Get Events

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1events_1_1_events.html

Retrieves a list of events based on provided IDs and search criteria.

```APIDOC
## get

### Description
Retrieves a list of events based on provided IDs and search criteria.

### Method
void

### Parameters
#### Path Parameters
- **list** (out EventList) - Output parameter for the list of events.
- **totalItems** (out long) - Output parameter for the total number of items matching the query.
- **ids** (in kerio::web::KIdList) - Input parameter for a list of event IDs.
- **query** (in kerio::web::SearchQuery) - Input parameter for search query criteria.
```

--------------------------------

### create

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1mails_1_1_mails-members.html

Creates new mail items.

```APIDOC
## create

### Description
Creates new mail items.

### Method
Not specified (likely a JSON-RPC or similar method call)

### Parameters
- **errors** (out kerio::web::ErrorList) - Output parameter for error information.
- **result** (out CreateResultList) - Output parameter for the result of the creation operation.
- **mails** (in MailList) - A list of mail items to create.
```

--------------------------------

### Get Events

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1events_1_1_events-members.html

Retrieves a list of events based on provided IDs or search criteria.

```APIDOC
## GET /events

### Description
Retrieves a list of events, optionally filtered by IDs or search queries.

### Method
GET

### Endpoint
/events

### Parameters
#### Query Parameters
- **ids** (KIdList) - Optional - A list of event IDs to retrieve.
- **query** (SearchQuery) - Optional - Search criteria to filter events.
```

--------------------------------

### set

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1folders_1_1_folders.html

Updates existing folders.

```APIDOC
## set

### Description
Updates existing folders.

### Method
void

### Parameters
#### Path Parameters
- **folders** (FolderList) - Required - A list of folders to update.

#### Return Values
- **errors** (kerio::web::ErrorList) - A list of errors encountered during the update.
```

--------------------------------

### getExtensions

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1_call_manager.html

Retrieves a list of available operator extensions.

```APIDOC
## getExtensions

### Description
Retrieves a list of available operator extensions.

### Method
void

### Parameters
#### Path Parameters
- **extensions** (out OperatorExtensionList) - Output parameter to store the list of operator extensions.
```

--------------------------------

### Get Outbound Delegation List

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1delegation_1_1_delegation.html

Retrieves the list of accounts to which the user has delegated their email.

```APIDOC
## get

### Description
Get list of accounts which the user set for delegation.

### Method
void

### Endpoint
Not applicable (SDK method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response
- **list** (OutboundDelagationList) - delegates
```

--------------------------------

### Get Folder Sync Key

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1changes_1_1_changes-members.html

Retrieves the watermark synchronization key for a specific folder.

```APIDOC
## getFolderSyncKey

### Description
Retrieves the watermark synchronization key for a specific folder.

### Method Signature
`getFolderSyncKey(out Watermark syncKey, in kerio::web::KId folderId)`

### Parameters
#### Output Parameters
- **syncKey** (Watermark) - The watermark synchronization key for the folder.

#### Input Parameters
- **folderId** (kerio::web::KId) - The ID of the folder.
```

--------------------------------

### Create Tasks

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1tasks_1_1_tasks.html

Creates new tasks based on the provided task data. Returns results of the creation and any errors.

```APIDOC
## Create Tasks

### Description
Creates new tasks. This method takes a list of tasks to be created and returns specific results for each task, along with a list of any tasks that failed during creation.

### Method
POST (assumed, based on 'create' operation)

### Endpoint
/tasks (assumed, based on context)

### Parameters
#### Request Body
- **tasks** (TaskList) - Required - List of tasks to be created.

### Response
#### Success Response (200)
- **result** (CreateResultList) - Particular results for all items.
#### Error Response
- **errors** (kerio::web::ErrorList) - List of tasks that failed on creation.
```

--------------------------------

### Get Account Sync Key

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1changes_1_1_changes-members.html

Retrieves the account synchronization key for a specific mailbox.

```APIDOC
## getAccountSyncKey

### Description
Retrieves the account synchronization key for a specific mailbox.

### Method Signature
`getAccountSyncKey(out AccountSyncKey asyncKey, in kerio::web::KId mailboxId)`

### Parameters
#### Output Parameters
- **asyncKey** (AccountSyncKey) - The account synchronization key for the mailbox.

#### Input Parameters
- **mailboxId** (kerio::web::KId) - The ID of the mailbox.
```

--------------------------------

### kerio::jsonapi::webmail::CallManager::dial

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/group___server.html

Initiates a call to a specified extension or phone number.

```APIDOC
## kerio::jsonapi::webmail::CallManager::dial

### Description
Initiates a call to a specified extension or phone number.

### Method
void

### Parameters
#### Path Parameters
* **callId** (kerio::web::KId) - out - Identifier for the new call.
* **extensionId** (kerio::web::KId) - in - The ID of the extension to call.
* **phoneNumber** (string) - in - The phone number to dial.
```

--------------------------------

### Get Outbound Delegations

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_delegation_8idl_source.html

Retrieves the list of accounts to which the current user has delegated access.

```APIDOC
## get

### Description
Get list of accounts which the user set for delegation.

### Method
void

### Parameters
#### Out Parameters
- **list** (OutboundDelagationList) - delegates
```

--------------------------------

### setSettings

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/_session_8idl_source.html

Sets the settings for the currently logged-in user.

```APIDOC
## setSettings

### Description
Sets the settings for the currently logged-in user.

### Method
void setSettings(in jsonstring settings)

### Parameters
* **settings** (in jsonstring) - The settings to apply, in JSON format.
```

--------------------------------

### getMessages

Source: https://manuals.gfi.com/en/kerio/api/connect/client/reference/interfacekerio_1_1jsonapi_1_1webmail_1_1im_1_1im.html

Retrieves a list of messages for a given conversation, starting from a specific message ID.

```APIDOC
## getMessages

### Description
Retrieves a list of messages for a given conversation, starting from a specific message ID.

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Method Signature
`void getMessages(out MessageList list, in ConversationId conversationId, in MessageId currentMessageId, in long count)`

### Response
#### Success Response
- **list** (MessageList) - A list of messages.

### Request Example
None provided in source.

### Response Example
None provided in source.
```
Tokens:
Raw