WoyraDocs
Get an API key

Pictures, names and company logos for the addresses a client shows

GET/v1/mail/avatars

Mailboxes · Requires an API key

For the addresses a client is showing, which are mailboxes on this platform, with their display name and a signed link to their picture when they have one.

An address with no picture whose domain belongs to a company -- not a personal mail provider such as gmail.com, not an IP literal, a single label or a reserved name -- also gets logoUrl, a signed link to the company's logo (see GET /v1/mail/logos/{domain}). The link is handed out without looking anything up, so it may lead to a 404 when the company has no usable logo. The apps show a logo only beside a message that passed DMARC for its From domain, so a spoofed message keeps its initials, and never for a person (a recipient, an account).

Addresses with neither are left out, so the client shows initials for them.

Parameters

NameInDescription
addressesrequiredqueryUp to 200 addresses, comma separated.

Example

curl https://api.woyra.io/v1/mail/avatars \
  -H "Authorization: Bearer $WOYRA_KEY"

Response

200 The avatars found.

FieldTypeDescription
objectstring
One of list.
dataarray of object
data.addressrequiredstring
data.namestring
data.pictureUrlstring
data.logoUrlstringThe sender's company logo, by signed link. Absent when there is a picture.

Errors

StatusCodes
400invalid_request, unsupported_version
401authentication_required, invalid_api_key

Also in Mailboxes