List assignees

.md

The colleagues a conversation in this mailbox can be handed to.

Scopesmail:read
GET/v1/me/mail/assignees

Who may take a conversation depends on which mailbox it is in. Somebody who cannot open support@ cannot answer what is in it, so they are not on this list for it. Pass mailbox and you get the people for that one; leave it out and you get everyone the caller could hand anything to, listed once each.

Being named on a mailbox is not enough on its own. Anybody without access to the mail section is left out, because a conversation handed to them leaves everyone else's list and never appears on theirs.

Feed the ids, such as usr_t7q3m8k2x9n4w6pb, straight to assign a conversation.

Request

curl "https://api.proppertrading.com/v1/me/mail/assignees?mailbox=mbx_w6sy3skvgydh5e3b&q=han" \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f"
ParameterTypeDescription
mailboxstringOnly the people who may take a conversation in this mailbox, by id from the mailbox list. An id the caller cannot read, a number included, is ignored rather than refused, and you get the unnarrowed list
qstringMatches anywhere in the name or the email address, either case. Leave it out for everybody

Response

{
    "data": [
        {
            "id": "usr_t7q3m8k2x9n4w6pb",
            "object": "mail_assignee",
            "name": "Han Aarts",
            "email": "[email protected]"
        }
    ],
    "meta": {
        "has_more": false,
        "next_cursor": null,
        "request_id": "req_01kz4bkr1aj1gv63d8fv3133ey"
    }
}

Sorted by name. At most 50 come back and there is no cursor: has_more true means narrow it with q rather than ask for a second page.

An account with no mailboxes at all gets an empty list, not an error.

Errors

StatusCodeMeaning
403insufficient_scopeThis device does not hold mail:read
403mailbox_not_permittedThis account may not open a mailbox