/contacts [deprecated]

get deprecated

https://api.mixmax.com/v1/contacts

Lists the contacts you own, newest first. Contacts are created for people you email with Mixmax and synced from Google Contacts. Contacts that reach you only through a shared contact group are left out unless you pass both search and includeShared=true.

Results are paged: pass the next (or previous) value from one response to get the following page.

The search value matches the start of words in the contact's name or email. It also accepts these operators, which you can combine. Quote values that contain spaces, for example name:"ada king".

email:[email protected] or email:[email protected],[email protected] matches exact emails, ignoring case.

name:king matches the start of any word in the name, ignoring case. Only one name: operator is allowed.

group:"Conference leads" matches contacts in the group with exactly that name (case-sensitive). Several group: operators must all match. An unknown group name returns 400.

salesforceAccount:"Example Inc" matches contacts whose email belongs to a Salesforce contact on that account. Needs a connected Salesforce account.

This operation is deprecated. It has no replacement in the public API, and no removal date has been announced.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

≤ 2000

Defaults to 100

Results per page, up to 2000.

string

The next value from the previous page.

string

The previous value from a later page.

sort

string

Defaults to _id

Field to sort by: name, email, timestamp or usedCount. Anything else sorts by _id, which follows creation time.

sortAscending

boolean

Defaults to false

true to sort ascending. The default is descending.

string

Search string. See the operation description for the format. Without it, only contacts you own are listed.

includeShared

boolean

Defaults to false

true to also return contacts in groups shared with you, or that you can access as a workspace admin. Only works together with search; without it the response is 500 with Must also use "search=" if using "includeShared=true".

expand

string

Comma-separated. firstName and lastName fill meta["First Name"] and meta["Last Name"] from the contact's name when they are empty. groups returns the groups the contact is in, as objects. notes adds the contact's notes. salesforce and pipedrive merge in fields from a matching Salesforce or Pipedrive record and list them in locked.

withAnalytics

boolean

Adds analytics to each contact. Any non-empty value turns it on, including false. Users without the contact analytics feature get an empty analytics object.

dates

string

enum

Defaults to last30days

Date range for analytics. With specific, set since and until.

timezoneOffset

int32

Defaults to 0

Your timezone offset in minutes, used to place day, week, month and year boundaries.

since

int64

Start of the range when dates is specific, in Unix milliseconds.

until

int64

End of the range when dates is specific, in Unix milliseconds.

fields

string

Comma-separated contact fields to return, for example email,name. Fields outside the contact object are ignored. meta and expanded fields are still added.

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

200A page of contacts.

400The search string is invalid, for example Only one name search operator supported or Group "Conference leads" not found.

403The request used an admin-managed API key. This endpoint accepts only personal API tokens. A key limited to specific scopes is refused with This API does not support scoped credentials, and a key with the * scope with This API does not support managed API credentials yet.

500includeShared=true was passed without search.