List archived contacts

The archived contacts of the account: contacts that were deleted and are kept for 360 days before they are purged. GET /contacts never returns them, whatever its status value; they are read here, or one at a time with GET /contactArchives/{id}. Only contacts archived within the last 360 days are listed, and only to API users in the Admin group: any other user gets 404. Each row is the contact as it was when archived, with the contact's fields plus deleted_at, when it was archived, and is_restorable, true when the contact is old enough to restore (archived at least 30 days ago by default; support can change an account's threshold) and not yet past the 360-day window. To restore archived contacts, use POST /contactArchives/restoreRequest (by id) or POST /contactArchives/restoreAll (by date range or search). Search with search: a full email address matches exactly; any other single word is matched anywhere in email, first name, last name or phone; words separated by spaces are matched together against the full name, or as a whole against the phone. Known defect: when search is a single word that is not an email address, start, end and the 360-day limit are not applied to the rows it matches by email or name, so such a search can return contacts archived more than 360 days ago and ignores the date window; combine dates with filters[...] or an exact email instead. Narrow the archive date with start and end, both Unix timestamps in milliseconds (a value in seconds is read as a date far in the past and raised to the 360-day limit). Exact-match filters use the column spellings: filters[email], filters[first_name], filters[last_name], filters[cdate], filters[udate], filters[userid], filters[deleted_at]. The API spellings firstName and lastName, and the keys name, account_name and orgname, are not valid filter keys and return 500 (name is accepted only as orders[name]). Other unknown filter keys are ignored. Order with orders[email], orders[first_name], orders[last_name], orders[cdate], orders[udate], orders[userid], orders[deleted_at] or orders[name] (first then last name), each asc or desc; the default is email ascending. 20 rows per request by default and at most 100; page with offset. meta.total is the number of matching archived contacts, as a string; send meta=omit to leave the metadata out.

Query Params

Text to search for. A full email address matches the archived contact's email exactly. Any other single word is matched anywhere in email, first name, last name or phone. Several words are matched together against the full name, or as a whole against the phone. A single word that is not an email address is not combined with start, end or the 360-day limit (known defect); a two-word search or an exact email address is.

int64

Only contacts archived on or after this moment, as a Unix timestamp in milliseconds. Rounded down to the start of that day. A value earlier than 360 days ago is raised to 360 days ago, the oldest archive the API serves.

int64

Only contacts archived on or before this moment, as a Unix timestamp in milliseconds. Rounded up to the end of that day; a value in the future is capped at now.

string

Exact email address.

string

Exact first name. filters[firstName] returns 500.

string

Exact last name. filters[lastName] returns 500.

date-time

Exact creation date and time of the contact, YYYY-MM-DD HH:MM:SS.

date-time

Exact last-modified date and time of the contact, YYYY-MM-DD HH:MM:SS.

int32

Id of the account user who owned the contact.

date-time

Exact archive date and time, YYYY-MM-DD HH:MM:SS. For a range use start and end.

string
enum

Order by email address (the default, ascending).

Allowed:
string
enum

Order by first name.

Allowed:
string
enum

Order by last name.

Allowed:
string
enum

Order by first name then last name.

Allowed:
string
enum

Order by when the contact was created.

Allowed:
string
enum

Order by when the contact record was last changed.

Allowed:
string
enum

Order by when the contact was archived; desc lists the most recently archived first.

Allowed:
integer
≤ 100
Defaults to 20

Number of archived contacts to return per request. Defaults to 20; the maximum is 100, and asking for more is capped at 100.

integer
Defaults to 0

Number of archived contacts to skip before returning results. Use with limit to page.

string
enum

Set to omit to leave the metadata (total) out of the response.

Allowed:
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json