List correspondents
GET
/correspondentsLooks up addresses for a recipient field: colleagues first, then people your organisation has exchanged mail with.
Needs the permissioncontacts:list
Until October 2026 this was GET /contacts. It moved here unchanged, with the same permission, when that address became List contacts.
Colleagues match on their name or address, other people on their address, the most recent first. A query shorter than two characters returns an empty list.
Query parameters
qstringrequired- Part of a name or address, at least two characters.
limitnumberoptional- 1 to 50, or 8 if you leave it out. No more than 20 come back.
Returns
A list of people, each with:
emailstring- The address.
namestring or null- Their name, when it’s known.
kindstringcolleagueorcorrespondent.lastSeenstring or null- When your organisation last exchanged mail with them. Null for colleagues.
Errors
400bad_limitlimitisn’t a whole number from 1 to 50.401invalid_key- The key is wrong, expired or revoked. With no Authorization header at all, the code is
missing_credentials. 403missing_scope- The key doesn’t have
contacts:list. TheX-Required-Scopeheader names what’s missing. 429rate_limited- More than 120 requests a minute from this key. Wait for
Retry-Afterseconds.