/contactgroups/:id/contacts [deprecated]

Lists the contacts in a contact group you can access, including contacts owned by other users. Results are paged and newest first unless you set sort.

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

_id of the contact group.

Query Params
integer
≤ 2000
Defaults to 50

Results per page, up to 2000.

string

The next value from the previous page.

string

The previous value from a later page.

string
Defaults to _id

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

boolean
Defaults to false

true to sort ascending. The default is descending.

string

Comma-separated. firstName and lastName fill meta["First Name"] and meta["Last Name"] from the contact's name when they are empty.

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.

string
enum
Defaults to last30days

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

int32
Defaults to 0

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

int64

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

int64

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

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

404

Nothing matches, or you do not have the access the operation needs. The response has no body.

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json
Psst... like working with APIs? Come join us!