OX HTTP API

Query

columns
required

A comma-separated list of columns to return, like "1,800". Each column is specified by a numeric column identifier, see Mail account data.

string

Query

session
required

A session ID previously obtained from the login module.

string

200

A JSON object containing an array with data for all mail accounts. Each array element describes one account and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

MailAccountsResponse

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON array with the ID of the mail account that shall be deleted.

< integer > array

200

A JSON object containing an array with identifiers of deleted accounts. In case of errors the responsible fields in the response are filled (see Error handling).

MailAccountDeletionResponse

Query

id
required

Account ID of the requested account.

integer

Query

session
required

A session ID previously obtained from the login module.

string

200

An object containing all data of the requested account. In case of errors the responsible fields in the response are filled (see Error handling).

MailAccountResponse

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object describing the new account to create.

MailAccountData

200

A JSON object containing the data of the inserted mail account. In case of errors the responsible fields in the response are filled (see Error handling).

MailAccountUpdateResponse

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object identifying (by field id) and describing the account to update. Only modified fields are present.

MailAccountData

200

A JSON object containing the data of the updated mail account. In case of errors the responsible fields in the response are filled (see Error handling).

MailAccountUpdateResponse

Query

session
required

A session ID previously obtained from the login module.

string

Query

tree
optional

Indicates whether on successful validation the folder tree shall be returned (or null`on failure) or if set to `false or missing only a boolean is returned which indicates validation result.

boolean

Body

body
required

A JSON object describing the account to validate.

MailAccountData

200

A JSON object that contains a value representing the validation result (may be a boolean or a folder tree object). If the validation fails then the error fields are filled and an additional warnings field might be added.

MailAccountValidationResponse

Query

attached
required

The ID of the object to which the attachment belongs.

integer

Query

columns
required

A comma-separated list of columns to return, like "1,800". Each column is specified by a numeric column identifier, see Common object data and Attachment data.

string

Query

folder
required

The folder ID of the object.

integer

Query

module
required

The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).

integer

Query

order
optional

"asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

sort
optional

The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.

string

200

A JSON object containing an array with data for all attachments. Each array element describes one attachment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

AttachmentsResponse

Query

session
required

A session ID previously obtained from the login module.

string

FormData

file_0
required

The attachment file as per <input type="file" />.

file

FormData

json_0
required

A JSON string representing an attachment object as described in AttachmentData model with at least the fields folder, attached and module.

string

200

A HTML page as described in File uploads containing a JSON array of object IDs of the newly created attachments or errors if some occurred.

string

Query

attached
required

The ID of the object to which the attachment belongs.

integer

Query

folder
required

The folder ID of the object.

integer

Query

module
required

The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).

integer

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON array with the identifiers of the attachments that shall be deleted.

< string > array

200

In case of errors the responsible fields in the response are filled (see Error handling).

CommonResponse

Query

attached
required

The ID of the object to which the attachment belongs.

integer

Query

content_type
optional

If present the response declares the given content_type in the Content-Type header and not the attachments file MIME type.

string

Query

folder
required

The folder ID of the object.

integer

Query

id
required

Object ID of the requested attachment.

string

Query

module
required

The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).

integer

Query

session
required

A session ID previously obtained from the login module.

string

200

The raw byte data of the document. The response type for the HTTP request is set accordingly to the defined MIME type for this attachment or the content_type given.

string(binary)

Query

attached
required

The ID of the object to which the attachment belongs.

integer

Query

folder
required

The folder ID of the object.

integer

Query

id
required

Object ID of the requested infoitem.

string

Query

module
required

The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).

integer

Query

session
required

A session ID previously obtained from the login module.

string

200

A JSON object containing all data of the requested attachment. In case of errors the responsible fields in the response are filled (see Error handling).

AttachmentResponse

Query

attached
required

The ID of the object to which the attachment belongs.

integer

Query

columns
required

A comma-separated list of columns to return, like "1,800". Each column is specified by a numeric column identifier, see Common object data and Attachment data.

string

Query

folder
required

The folder ID of the object.

integer

Query

module
required

The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).

integer

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON array with the identifiers of the requested attachments.

< integer > array

200

A JSON object containing an array with data for the requested infoitems. Each array element describes one infoitem and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

InfoItemsResponse

Query

attached
required

The ID of the object to which the attachment belongs.

integer

Query

columns
required

A comma-separated list of columns to return, like "1,800". Each column is specified by a numeric column identifier, see Common object data and Attachment data.

string

Query

folder
required

The folder ID of the object.

integer

Query

ignore
optional

Which kinds of updates should be ignored. Currently, the only valid value – "deleted" – causes deleted object IDs not to be returned.

enum (deleted)

Query

module
required

The module type of the object: 1 (appointment), 4 (task), 7 (contact), 137 (infostore).

integer

Query

order
optional

"asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

sort
optional

The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.

string

Query

timestamp
optional

Timestamp of the last update of the requested infoitems.

integer(int64)

200

An array with new and deleted attachments. New attachments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted attachments would be identified by their object IDs as integer, without being part of a nested array. In case of errors the responsible fields in the response are filled (see Error handling).

AttachmentUpdatesResponse

Query

session
required

A session ID previously obtained from the login module.

string

FormData

email
required

The email address for which a mail configuration will be discovered.

string

FormData

force_secure
optional

Enforces a secure connection for configured mail account, default is true (available since v7.8.2).

boolean

FormData

password
required

The corresponding password for the mail account.

string

200

A JSON object containing the best available settings for an appropriate mail server for the given email address. The data may be incomplete or empty. In case of errors the responsible fields in the response are filled (see Error handling).

AutoConfigResponse

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.

string

Query

end
required

Upper exclusive limit of the queried range as a Date. Only appointments which end before this date are returned.

integer(int64)

Query

folder
optional

Object ID of the folder, whose contents are queried. If not specified, defaults to all calendar folders.

string

Query

recurrence_master
optional

Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.

boolean

Query

session
required

A session ID previously obtained from the login module.

string

Query

showPrivate
optional

Only works in shared folders: When enabled, shows private appointments of the folder owner. Such appointments are anonymized by stripping away all information except start date, end date and recurrence information (since 6.18)

boolean

Query

start
required

Lower inclusive limit of the queried range as a Date. Only appointments which start on or after this date are returned.

integer(int64)

200

A JSON object containing an array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Appointment sequencies are broken up into individual appointments and each occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentsResponse

Query

folder
required

Object ID of the folder who contains the appointments.

string

Query

id
required

Object ID of the appointment that shall be confirmed.

string

Query

occurrence
optional

The numeric identifier of the occurrence to which the confirmation applies (in case "id" denotes a series appointment). Available since v7.6.0.

integer

Query

session
required

A session ID previously obtained from the login module.

string

Query

timestamp
required

Timestamp of the last update of the appointment.

integer(int64)

Body

body
required

A JSON object with the fields confirmation, confirmmessage and optionally id.

AppointmentConfirmationBody

200

Nothing, except the standard response object with empty data, the timestamp of the confirmed and thereby updated appointment, and maybe errors. In case of errors the responsible fields in the response are filled (see Error handling).

CommonResponse

Query

session
required

A session ID previously obtained from the login module.

string

Query

timestamp
required

Timestamp of the last update of the deleted appointments.

integer(int64)

Body

body
required

A JSON array of JSON objects with the id, folder and optionally the recurrence position (if present in an appointment to fully identify it) of the appointments.

< AppointmentDeletionsElement > array

200

A JSON array of objects identifying the appointments which were modified after the specified timestamp and were therefore not deleted. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentDeletionsResponse

Query

end
required

Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.

integer(int64)

Query

id
required

Internal user id. Must be obtained from the contact module.

integer

Query

session
required

A session ID previously obtained from the login module.

string

Query

start
required

Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.

integer(int64)

Query

type
required

Constant for user or resource (1 for users, 3 for resources).

enum (, )

200

An array of objects identifying the appointments which lie between start and end as described. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentFreeBusyResponse

Query

folder
required

Object ID of the folder who contains the appointments.

string

Query

id
required

Object ID of the requested appointment.

string

Query

recurrence_position
optional

Recurrence position of requested appointment.

integer

Query

session
required

A session ID previously obtained from the login module.

string

200

An object containing all data of the requested appointment. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentResponse

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.

string

Query

folder
required

Object ID of the folder who contains the appointments.

string

Query

id
required

Object ID of the appointment series.

string

Query

session
required

A session ID previously obtained from the login module.

string

200

A JSON object containing an array with appointment data. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentsResponse

Query

end
required

Upper exclusive limit of the queried range as a Date. Only appointments which end before this date are returned.

integer(int64)

Query

session
required

A session ID previously obtained from the login module.

string

Query

start
required

Lower inclusive limit of the queried range as a Date. Only appointments which start on or after this date are returned.

integer(int64)

200

A JSON object containing an array with the length of the number of days between start and end. Meaning, each element corresponds with one day in the range that was queried, explaining whether there is an appointment on this day (true) or not (false). In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentInfoResponse

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.

string

Query

recurrence_master
optional

Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.

boolean

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON array of JSON objects with the id, folder and optionally either recurrence_position or recurrence_date_position of the requested appointments.

< AppointmentListElement > array

200

A JSON object containing an array with data for the requested appointments. Each array element describes one appointment and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentsResponse

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object containing the appointment’s data.

AppointmentData

200

A JSON object containing the id of the newly created appointment if it was created successfully. If the appointment could not be created due to conflicts, the response body is an object with the field conflicts, which is an array of appointment objects which caused the conflict. Each appointment object which represents a resource conflict contains an additional field hard_conflict with the Boolean value true. If the user does not have read access to a conflicting appointment, only the fields id, start_date, end_date, shown_as and participants are present and the field participants contains only the participants which caused the conflict. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentCreationResponse

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.

string

Query

end
required

Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned.

integer(int64)

Query

limit
required

Limits the number of returned objects to the given value.

string

Query

order
optional

"asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

sort
optional

The identifier of a column which determines the sort order of the response. If this parameter is specified and holds a column number, then the parameter order must be also specified.

string

Query

start
required

Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned.

integer(int64)

200

A JSON object containing an array with appointment data. Appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentsResponse

Query

session
required

A session ID previously obtained from the login module.

string

Query

uid
required

The UID that shall be resolved.

string

200

A JSON object containing the related object ID in the field id. If no object exists with the specified UID or in case of errors the responsible fields in the response are filled (see Error handling).

AppointmentUpdateResponse

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.

string

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object containing search parameters.

AppointmentSearchBody

200

A JSON object containing an array with matching appointments. Appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentsResponse

Query

folder
required

Object ID of the folder who contains the appointments.

string

Query

id
required

Object ID of the requested appointment.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

timestamp
required

Timestamp of the updated appointment. If the appointment was modified after the specified timestamp, then the update must fail.

integer(int64)

Body

body
required

A JSON object containing the appointment’s data. The field recurrence_id is always present if it is present in the original appointment. The field recurrence_position is present if it is present in the original appointment and only this single appointment should be modified. The field id is not present because it is already included as a parameter. Other fields are present only if modified.

AppointmentData

200

A JSON object containing the id of the updated appointment. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentUpdateResponse

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data, Detailed task and appointment data and Detailed appointment data.

string

Query

end
optional

Upper exclusive limit of the queried range as a Date. Only appointments which start before this date are returned. This parameter is optional in case a certain folder is queried, but mandatory if all accessible calendar folders are supposed to be considered (folder not specified).

integer(int64)

Query

folder
optional

Object ID of the folder, whose contents are queried. That parameter may be absent in case ignore is set to "deleted", which means all accessible calendar folders are considered. If ignore is not set to "deleted", that parameter is mandatory.

string

Query

ignore
optional

Which kinds of updates should be ignored. Currently, the only valid value – "deleted" – causes deleted object IDs not to be returned.

enum (deleted)

Query

recurrence_master
optional

Extract the recurrence to several appointments. The default value is false so every appointment of the recurrence will be calculated.

boolean

Query

session
required

A session ID previously obtained from the login module.

string

Query

showPrivate
optional

Only works in shared folders: When enabled, shows private appointments of the folder owner. Such appointments are anonymized by stripping away all information except start date, end date and recurrence information (since 6.18)

boolean

Query

start
optional

Lower inclusive limit of the queried range as a Date. Only appointments which end on or after this date are returned. This parameter is optional in case a certain folder is queried, but mandatory if all accessible calendar folders are supposed to be considered (folder not specified).

integer(int64)

Query

timestamp
required

Timestamp of the last update of the requested appointments.

integer(int64)

200

An array with new, modified and deleted appointments. New and modified appointments are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted appointments (should the ignore parameter be ever implemented) would be identified by their object IDs as integers, without being part of a nested array. Appointment sequencies are broken up into individual appointments and each modified occurrence of a sequence in the requested range is returned separately. The appointments are sorted in ascending order by the field start_date. In case of errors the responsible fields in the response are filled (see Error handling).

AppointmentUpdatesResponse

Query

session
required

A session ID previously obtained from the login module.

string

200

A JSON object containing an array with data for all capabilities. In case of errors the responsible fields in the response are filled (see Error handling).

CapabilitiesResponse

Query

id
required

The identifier of the capability

string

Query

session
required

A session ID previously obtained from the login module.

string

200

A JSON object containing the data of the capability or an empty result, if capability not available. In case of errors the responsible fields in the response are filled (see Error handling).

CapabilityResponse

Path

path
required

The path to the node.

enum (gui, fastgui, context_id, cookielifetime, identifier, contact_id, language, timezone, availableTimeZones, calendarnotification, tasknotification, reloadTimes, serverVersion, currentTime, maxUploadIdleTimeout, search, folder, folder/tasks, folder/calendar, folder/contacts, folder/infostore, folder/eas, mail, mail/addresses, mail/defaultaddress, mail/sendaddress, mail/folder, mail/folder/inbox, mail/folder/drafts, mail/folder/trash, mail/folder/spam, mail/folder/sent, mail/htmlinline, mail/colorquote, mail/emoticons, mail/harddelete, mail/inlineforward, mail/vcard, mail/notifyonreadack, mail/msgpreview, mail/ignorereplytext, mail/nocopytosent, mail/spambutton, participants, participants/autoSearch, participants/maximumNumberParticipants, participants/showWithoutEmail, participants/showDialog, availableModules, minimumSearchCharacters, modules, modules/portal, modules/portal/gui, modules/portal/module, modules/mail, modules/mail/addresses, modules/mail/appendmailtext, modules/mail/allowhtmlimages, modules/mailcolorquoted, modules/mail/contactCollectFolder, modules/mail/contactCollectEnabled, modules/mail/contactCollectOnMailAccess, modules/mail/contactCollectOnMailTransport, modules/mail/defaultaddress, modules/mail/deletemail, modules/mail/emoticons, modules/mail/defaultFolder, modules/mail/defaultFolder/drafts, modules/mail/defaultFolder/inbox, modules/mail/defaultFolder/sent, modules/mail/defaultFolder/spam, modules/mail/defaultFolder/trash, modules/mail/forwardmessage, modules/mail/gui, modules/mail/inlineattachments, modules/mail/linewrap, modules/mail/module, modules/mail/phishingheaders, modules/mail/replyallcc, modules/mail/sendaddress, modules/mail/spambutton, modules/mail/vcard, modules/calendar, modules/calendar/calendar_conflict, modules/calendar/calendar_freebusy, modules/calendar/calendar_teamview, modules/calendar/gui, modules/calendar/module, modules/calendar/notifyNewModifiedDeleted, modules/calendar/notifyAcceptedDeclinedAsCreator, modules/calendar/notifyAcceptedDeclinedAsParticipant, modules/calendar/defaultStatusPrivate, modules/calendar/defaultStatusPublic, modules/contacts, modules/contacts/gui, modules/contacts/mailAddressAutoSearch, modules/contacts/module, modules/contacts/singleFolderSearch, modules/contacts/characterSearch, modules/contacts/allFoldersForAutoComplete, modules/tasks, modules/tasks/gui, modules/tasks/module, modules/tasks/delegate_tasks, modules/tasks/notifyNewModifiedDeleted, modules/tasks/notifyAcceptedDeclinedAsCreator, modules/tasks/notifyAcceptedDeclinedAsParticipant, modules/infostore, modules/infostore/gui, modules/infostore/folder, modules/infostore/folder/trash, modules/infostore/folder/pictures, modules/infostore/folder/documents, modules/infostore/folder/music, modules/infostore/folder/videos, modules/infostore/folder/templates, modules/infostore/module, modules/interfaces, modules/interfaces/ical, modules/interfaces/vcard, modules/interfaces/syncml, modules/folder, modules/folder/gui, modules/folder/public_folders, modules/folder/read_create_shared_folders, modules/folder/tree, modules/com.openexchange.extras, modules/com.openexchange.extras/module, modules/com.openexchange.user.passwordchange, modules/com.openexchange.user.passwordchange/module, modules/com.openexchange.user.personaldata, modules/com.openexchange.user.personaldata/module, modules/com.openexchange.group, modules/com.openexchange.group/enabled, modules/com.openexchange.resource, modules/com.openexchange.resource/enabled, modules/com.openexchange.publish, modules/com.openexchange.publish/enabled, modules/com.openexchange.subscribe, modules/com.openexchange.subscribe/enabled, modules/olox20, modules/olox20/active, modules/olox20/module, modules/com.openexchange.oxupdater, modules/com.openexchange.oxupdater/module, modules/com.openexchange.oxupdater/active, modules/com.openexchange.passwordchange, modules/com.openexchange.passwordchange/showStrength, modules/com.openexchange.passwordchange/minLength, modules/com.openexchange.passwordchange/maxLength, modules/com.openexchange.passwordchange/regexp, modules/com.openexchange.passwordchange/special)

Query

session
required

A session ID previously obtained from the login module.

string

200

Value of the node specified by path. In case of errors the responsible fields in the response are filled (see Error handling).

ConfigResponse

Path

path
required

The path to the node.

enum (gui, fastgui, context_id, cookielifetime, identifier, contact_id, language, timezone, availableTimeZones, calendarnotification, tasknotification, reloadTimes, serverVersion, currentTime, maxUploadIdleTimeout, search, folder, folder/tasks, folder/calendar, folder/contacts, folder/infostore, folder/eas, mail, mail/addresses, mail/defaultaddress, mail/sendaddress, mail/folder, mail/folder/inbox, mail/folder/drafts, mail/folder/trash, mail/folder/spam, mail/folder/sent, mail/htmlinline, mail/colorquote, mail/emoticons, mail/harddelete, mail/inlineforward, mail/vcard, mail/notifyonreadack, mail/msgpreview, mail/ignorereplytext, mail/nocopytosent, mail/spambutton, participants, participants/autoSearch, participants/maximumNumberParticipants, participants/showWithoutEmail, participants/showDialog, availableModules, minimumSearchCharacters, modules, modules/portal, modules/portal/gui, modules/portal/module, modules/mail, modules/mail/addresses, modules/mail/appendmailtext, modules/mail/allowhtmlimages, modules/mailcolorquoted, modules/mail/contactCollectFolder, modules/mail/contactCollectEnabled, modules/mail/contactCollectOnMailAccess, modules/mail/contactCollectOnMailTransport, modules/mail/defaultaddress, modules/mail/deletemail, modules/mail/emoticons, modules/mail/defaultFolder, modules/mail/defaultFolder/drafts, modules/mail/defaultFolder/inbox, modules/mail/defaultFolder/sent, modules/mail/defaultFolder/spam, modules/mail/defaultFolder/trash, modules/mail/forwardmessage, modules/mail/gui, modules/mail/inlineattachments, modules/mail/linewrap, modules/mail/module, modules/mail/phishingheaders, modules/mail/replyallcc, modules/mail/sendaddress, modules/mail/spambutton, modules/mail/vcard, modules/calendar, modules/calendar/calendar_conflict, modules/calendar/calendar_freebusy, modules/calendar/calendar_teamview, modules/calendar/gui, modules/calendar/module, modules/calendar/notifyNewModifiedDeleted, modules/calendar/notifyAcceptedDeclinedAsCreator, modules/calendar/notifyAcceptedDeclinedAsParticipant, modules/calendar/defaultStatusPrivate, modules/calendar/defaultStatusPublic, modules/contacts, modules/contacts/gui, modules/contacts/mailAddressAutoSearch, modules/contacts/module, modules/contacts/singleFolderSearch, modules/contacts/characterSearch, modules/contacts/allFoldersForAutoComplete, modules/tasks, modules/tasks/gui, modules/tasks/module, modules/tasks/delegate_tasks, modules/tasks/notifyNewModifiedDeleted, modules/tasks/notifyAcceptedDeclinedAsCreator, modules/tasks/notifyAcceptedDeclinedAsParticipant, modules/infostore, modules/infostore/gui, modules/infostore/folder, modules/infostore/folder/trash, modules/infostore/folder/pictures, modules/infostore/folder/documents, modules/infostore/folder/music, modules/infostore/folder/videos, modules/infostore/folder/templates, modules/infostore/module, modules/interfaces, modules/interfaces/ical, modules/interfaces/vcard, modules/interfaces/syncml, modules/folder, modules/folder/gui, modules/folder/public_folders, modules/folder/read_create_shared_folders, modules/folder/tree, modules/com.openexchange.extras, modules/com.openexchange.extras/module, modules/com.openexchange.user.passwordchange, modules/com.openexchange.user.passwordchange/module, modules/com.openexchange.user.personaldata, modules/com.openexchange.user.personaldata/module, modules/com.openexchange.group, modules/com.openexchange.group/enabled, modules/com.openexchange.resource, modules/com.openexchange.resource/enabled, modules/com.openexchange.publish, modules/com.openexchange.publish/enabled, modules/com.openexchange.subscribe, modules/com.openexchange.subscribe/enabled, modules/olox20, modules/olox20/active, modules/olox20/module, modules/com.openexchange.oxupdater, modules/com.openexchange.oxupdater/module, modules/com.openexchange.oxupdater/active, modules/com.openexchange.passwordchange, modules/com.openexchange.passwordchange/showStrength, modules/com.openexchange.passwordchange/minLength, modules/com.openexchange.passwordchange/maxLength, modules/com.openexchange.passwordchange/regexp, modules/com.openexchange.passwordchange/special)

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object containing the value of the config node.

ConfigBody

200

In case of errors the responsible fields in the response are filled (see Error handling).

CommonResponse

Query

name
required

The name of the property to return.

string

Query

session
required

A session ID previously obtained from the login module.

string

200

A JSON response providing the property’s name and its value. In case of errors the responsible fields in the response are filled (see Error handling).

ConfigPropertyResponse

Query

name
required

The name of the property to return.

string

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object providing the value to set (Example: {"value":"test123"}).

ConfigPropertyBody

200

A JSON response providing the property’s name and its value. In case of errors the responsible fields in the response are filled (see Error handling).

ConfigPropertyResponse

Query

admin
optional

Specifies whether to include the contact representing the admin in the result or not. Defaults to true. (preliminary, since 7.4.2)

boolean

Query

collation
optional

Allows you to specify a collation to sort the contacts by. As of 6.20, only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work. (preliminary, since 6.20)

enum (gbk, gb2312)

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.

string

Query

order
optional

"asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

sort
optional

The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.

string

Body

body
required

A JSON object describing the search term as introducted in Advanced search. Example: {"filter":["and",["=", {"field":"last_name"},"Mustermann"],["=",{"field":"first_name"},"Max"]]} which represents 'last_name = "Mustermann" AND first_name = "Max"'. Valid fields are the ones specified in Contact data model.

string

200

A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

ContactsResponse

Query

collation
optional

Allows you to specify a collation to sort the contacts by. As of 6.20, only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work. (preliminary, since 6.20)

enum (gbk, gb2312)

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.

string

Query

folder
required

Object ID of the folder who contains the contacts.

string

Query

order
optional

"asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

sort
optional

The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.

string

200

A JSON object containing an array with data for all contacts. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

ContactsResponse

Query

collation
optional

Allows you to specify a collation to sort the contacts by. As of 6.20, only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work. (preliminary, since 6.20)

enum (gbk, gb2312)

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.

string

Query

end
required

The upper (exclusive) limit of the requested time range.

integer(int64)

Query

folder
optional

Object ID of the parent folder that is searched. If not set, all visible folders are used.

string

Query

order
optional

"asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

sort
optional

The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.

string

Query

start
required

The lower (inclusive) limit of the requested time range.

integer(int64)

200

A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

ContactsResponse

Query

collation
optional

Allows you to specify a collation to sort the contacts by. As of 6.20, only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work. (preliminary, since 6.20)

enum (gbk, gb2312)

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.

string

Query

email
optional

Whether to only include contacts with at least one e-mail address. Defaults to true.

boolean

"true"

Query

folder
optional

Object ID of the parent folder that is searched. If not set, all visible folders are used.

string

Query

left_hand_limit
optional

A positive integer number to specify the "left-hand" limit of the range to return.

integer

Query

order
optional

"asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.

string

Query

query
required

The query to search for.

string

Query

right_hand_limit
optional

A positive integer number to specify the "right-hand" limit of the range to return.

integer

Query

session
required

A session ID previously obtained from the login module.

string

Query

sort
optional

The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified. Since 7.8.1: If this parameter is missing, response is sorted by a user-specific use count of contacts, ID of contacts' parent folder and display name.

string

200

A JSON object containing the contact data. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

ContactsResponse

Query

collation
optional

Allows you to specify a collation to sort the contacts by. As of 6.20, only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work. (preliminary, since 6.20)

enum (gbk, gb2312)

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.

string

Query

end
required

The upper (exclusive) limit of the requested time range.

integer(int64)

Query

folder
optional

Object ID of the parent folder that is searched. If not set, all visible folders are used.

string

Query

order
optional

"asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

sort
optional

The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.

string

Query

start
required

The lower (inclusive) limit of the requested time range.

integer(int64)

200

A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

ContactsResponse

Query

session
required

A session ID previously obtained from the login module.

string

Query

timestamp
required

Timestamp of the last update of the deleted contacts.

integer(int64)

Body

body
required

A JSON array of JSON objects with the id and folder of the contacts.

< ContactListElement > array

200

A JSON array with object IDs of contacts which were modified after the specified timestamp and were therefore not deleted. In case of errors the responsible fields in the response are filled (see Error handling).

ContactDeletionsResponse

Query

folder
required

Object ID of the folder who contains the contacts.

string

Query

id
required

Object ID of the requested contact.

string

Query

session
required

A session ID previously obtained from the login module.

string

200

An object containing all data of the requested contact. In case of errors the responsible fields in the response are filled (see Error handling).

ContactResponse

Query

id
required

User ID (not Object ID) of the requested user.

integer

Query

session
required

A session ID previously obtained from the login module.

string

200

An object containing all data of the requested contact. In case of errors the responsible fields in the response are filled (see Error handling).

ContactResponse

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.

string

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON array of JSON objects with the id and folder of the contacts.

< ContactListElement > array

200

A JSON object containing an array with data for the requested contacts. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

ContactsResponse

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.

string

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON array with user IDs.

< integer > array

200

A JSON object containing an array with contact data. Each array element describes one contact and is itself an array. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

ContactsResponse

Query

session
required

A session ID previously obtained from the login module.

string

FormData

file
required

The image file.

file

FormData

json
required

Represents the normal request body as JSON string containing the contact data as described in the ContactData model.

string

200

A HTML page as described in File uploads containing the object ID of the contact or errors if some occurred.

string

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object containing the contact’s data. The field id is not included.

ContactData

200

A JSON object containing the ID of the newly created contact. In case of errors the responsible fields in the response are filled (see Error handling).

ContactUpdateResponse

Query

collation
optional

Allows you to specify a collation to sort the contacts by. As of 6.20, only supports "gbk" and "gb2312", not needed for other languages. Parameter sort should be set for this to work. (preliminary, since 6.20)

enum (gbk, gb2312)

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.

string

Query

order
optional

"asc" if the response entires should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

sort
optional

The identifier of a column which determines the sort order of the response. If this parameter is specified , then the parameter order must be also specified.

string

Body

body
required

A JSON object containing search parameters.

ContactSearchBody

200

A JSON object containing an array with matching contacts. Contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. In case of errors the responsible fields in the response are filled (see Error handling).

ContactsResponse

Query

folder
required

Object ID of the folder who contains the contacts.

string

Query

id
required

Object ID of the contact that shall be updated.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

timestamp
required

Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.

integer(int64)

FormData

file
required

The image file.

file

FormData

json
required

Represents the normal request body as JSON string containing the contact data as described in ContactData model. Only modified fields must be specified but at least "{}".

string

"{}"

200

A HTML page as described in File uploads containing the object ID of the contact or errors if some occurred.

string

Query

folder
required

Object ID of the folder who contains the contacts.

string

Query

id
required

Object ID of the contact that shall be updated.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

timestamp
required

Timestamp of the updated contact. If the contact was modified after the specified timestamp, then the update must fail.

integer(int64)

Body

body
required

A JSON object containing the contact’s data. Only modified fields must be specified. To remove some contact image send the image attribute set to null.

ContactData

200

A JSON object with a timestamp. In case of errors the responsible fields in the response are filled (see Error handling).

ContactUpdateResponse

Query

columns
required

A comma-separated list of columns to return, like "1,500". Each column is specified by a numeric column identifier, see Common object data and Detailed contact data.

string

Query

folder
required

Object ID of the folder who contains the contacts.

string

Query

ignore
optional

Which kinds of updates should be ignored. Omit this parameter or set it to "deleted" to not have deleted tasks identifier in the response. Set this parameter to false and the response contains deleted tasks identifier.

enum (deleted)

Query

order
optional

"asc" if the response entities should be sorted in the ascending order, "desc" if the response entries should be sorted in the descending order. If this parameter is specified, then the parameter sort must be also specified.

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

sort
optional

The identifier of a column which determines the sort order of the response. If this parameter is specified, then the parameter order must be also specified.

string

Query

timestamp
required

Timestamp of the last update of the requested contacts.

integer(int64)

200

An array with new, modified and deleted contacts. New and modified contacts are represented by arrays. The elements of each array contain the information specified by the corresponding identifiers in the columns parameter. Deleted contacts (should the ignore parameter be ever implemented) would be identified by their object IDs as integers, without being part of a nested array. In case of errors the responsible fields in the response are filled (see Error handling).

ContactUpdatesResponse

Query

session
required

A session ID previously obtained from the login module.

string

Body

body
required

A JSON object the data source object and the data handler object.

ConversionBody

200

The conversion result. In case of errors the responsible fields in the response are filled (see Error handling).

ConversionResponse

Query

columns
optional

A comma-separated list of columns to export, like "501,502". A column is specified by a numeric column identifier, see Detailed contact data.

string

Query

export_dlists
optional

Toggles whether distribution lists shall be exported too (default is false). (since 7.4.1)

string

Query

folder
required

Object ID of the folder whose content shall be exported. This must be a contact folder.

string

Query

session
required

A session ID previously obtained from the login module.

string

200

An input stream containing the content of the CSV file with the MIME type text/csv.

string

Query

folder
required

Object ID of the folder whose content shall be exported. This must be a calendar folder.

string

Query

session
required

A session ID previously obtained from the login module.

string

200

An input stream containing the content of the iCal file with the MIME type text/calendar.

string

Query

folder
required

Object ID of the folder whose content shall be exported. This must be a contact folder.

string

Query

session
required

A session ID previously obtained from the login module.

string

200

An input stream containing the content of the vCard file with the MIME type text/x-vcard.

string

Query

id
required

The ID of the uploaded file.

string

Query

session
required

A session ID previously obtained from the login module.

string

200

The content of the requested file is directly written into output stream.

string(binary)

404

Not found.

No Content

Query

id
required

The ID of the uploaded file whose timestamp should be updated.

string

Query

session
required

A session ID previously obtained from the login module.

string

200

In case of errors the responsible fields in the response are filled (see Error handling).

CommonResponse

Query

module
required

The module for which the file is uploaded to determine proper upload quota constraints (e.g. "mail", "infostore", etc.).

string

Query

session
required

A session ID previously obtained from the login module.

string

Query

type
required

The file type filter to define which file types are allowed during upload. Currently supported filters are: file (for all), text (for text/), media (for image, audio or video), image (for image/), audio (for audio/), video (for video/) and application (for application/*).

enum (file, text, media, image, audio, video, application)

FormData

file
required

The file to upload.

file

200

A HTML page as described in File uploads containing a JSON array with the IDs of the uploaded files or errors if some occurred. The files are accessible through the returned IDs for future use.

string

Query

filestorageService
optional

The identifier of a file storage service to list only those accounts that belong to that file storage service.

string

Query

session
required

A session ID previously obtained from the login module.