Mailbox API — Contacts

APIs & Tools

The Mailbox API is available starting with Axigen X4 (10.4).

List

Query parameters

Name

Type

Required

Values

Description

folderId

String

The folder ID

When missing, all contacts from all contact folders are returned.

sort

String

"name", “email”

The sorting field

Default value: last provided value or "name" if not yet set

dir

String

"ASC", "DESC"

The sorting direction

Default value: last provided value or "DESC" if not yet set

start

Number

The starting position

Default value: 0

limit

Number

The maximum number of retrieved items

Default value: the WebMailData pageSize

Response

Autocomplete

Query parameters

Name

Type

Required

Values

Description

query

String

*

The search query string

limit

Number

1-50

Number of results.

Default value: 10.

Response

Avatars

Returns avatar images for contacts that match query parameters.

It can be called with one of the following query parameters: contactEmailAddresses (for avatar listing based on email addresses) or contactsIds (for avatar listing based on contact IDs).

List

Request body (JSON)

Name

Type

Required

Values

Description

contactEmailAddresses

Array

*

Example:

The contact email addresses.

The avatar is retrieved from the first contact matching the query parameter (there may be multiple contacts with that email address).

Matching is done by searching the provided contact email address as case insensitive substring in the main email address of the contacts (there is no match against “home”, “work”, or other secondary email address types).

contactIds

Array

*

Example:

The contact IDs.

See the id field of the Contact instance schema definition.

One of contactEmailAddresses or contactIds is required.

Response