Skip to content
Optiwork API Docs

Find addresses to write to

GET
/mail/mailboxes/{mailbox}/search/mailables
curl --request GET \
  --url 'https://mail.work.optidata.cloud/api/mail/mailboxes/78/search/mailables?search=jane&shouldExcludeGroups=false&isCompanyOnly=false' \
  --header 'Authorization: Bearer <token>'

Autocomplete for a recipient field: matches the search term against the user’s own contacts and the tenant directory, best match first. An empty search returns an empty list rather than everything.

Distribution lists come back with isGroup: true. Set shouldExcludeGroups to drop them, and isCompanyOnly to keep only addresses on the company’s own domains.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
mailbox
required
integer

Id of the mailbox. Every mailbox the caller may use is listed in their account.

Query Parameters

Section titled “Query Parameters”
search
string

What the user has typed so far.

shouldExcludeGroups
boolean

Drop distribution lists from the result.

isCompanyOnly
boolean

Keep only addresses on the company’s own domains.

Responses

Section titled “ Responses ”

200

Section titled “200”

The matching addresses.

Media typeapplication/json
object
mailables
required
Array<object>

An address a message can be sent to.

object
name
string | null
email
string format: email
isGroup

Whether the address is a distribution list.

boolean
type

Where the match came from, e.g. contact.

string | null
ranking

How often the user writes to this address. Higher sorts first.

integer | null
Examples
Examplematches
{
  "mailables": [
    {
      "name": "Jane Doe",
      "email": "jane.doe@acme.example",
      "isGroup": false,
      "type": "contact",
      "ranking": 535
    },
    {
      "name": "Everyone",
      "email": "everyone@acme.example",
      "isGroup": true,
      "type": "group",
      "ranking": 12
    }
  ]
}

401

Section titled “401”

Missing, malformed or expired authentication key.

Media typeapplication/json

Authentication failures use an error key rather than message.

object
error
required
string
Examples
Examplemissing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The caller may not act on this mailbox, user or resource.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Exampledenied
{
  "message": "This action is unauthorized."
}

429

Section titled “429”

Rate limit exceeded. Retry after the window resets.

Media typeapplication/json

Generic error envelope used by policy, binding and framework failures.

object
message
required

Human-readable description of the failure.

string
Examples
Examplethrottled
{
  "message": "Too Many Attempts."
}

502

Section titled “502”

The mail platform did not answer as expected — a folder or message that does not exist, or a transient failure. reference is the code to quote to support and fault_code names the underlying condition. A 503 with the same envelope means the platform is in maintenance; retry shortly.

Media typeapplication/json

Failure raised by the mail platform behind the API rather than by the request itself.

object
error
required

What went wrong, phrased for the end user.

string
status
required

Repeats the HTTP status code.

integer
help
required

Suggested next step.

string
reference
required

Support reference, e.g. MZ-502.

string
fault_code

Names the underlying condition, e.g. mail.NO_SUCH_FOLDER.

string | null
Examples

Unknown folder

{
  "error": "The mail server did not answer as expected, so this action could not be completed.",
  "status": 502,
  "help": "If the problem persists, contact support and inform the error code above.",
  "reference": "MZ-502",
  "fault_code": "mail.NO_SUCH_FOLDER"
}