{"_id":"5826691a3c689e25000139e4","version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":15,"createdAt":"2015-06-23T01:38:42.696Z","releaseDate":"2015-06-23T01:38:42.696Z","categories":["5588b8a3f6c18d0d005bba07","5588e9689cfea70d00371df3","5588f5921163180d00b64704","561598b121e9110d0078025a","5616f1c9d170d00d00189306","5616f5c3a410c90d00c6121e","561803dcf8c9632100ac7592","563667280441020d0000e9eb","5642570d9417b40d00c0fcd3","57bf5f02efe0050e00d50bd5","57f53fb368a53b2000e03f0f","57f55187440418170086325a","582e3afa72fd270f0006926d","5841faa973967b0f004b4a2b","58db348aa32c8419002433bb"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"__v":6,"category":{"_id":"57f53fb368a53b2000e03f0f","version":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-10-05T18:00:19.547Z","from_sync":false,"order":0,"slug":"api","title":"REST API"},"parentDoc":null,"project":"5588b8a2f6c18d0d005bba03","user":"5588b847f6c18d0d005bba01","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-11-12T00:58:02.948Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/contactgroups/5810142fd61495a1799bba05/contacts","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"results\": [{\n    \"_id\": \"582664fa0a32944e509281f3\",\n    \"email\": \"hello:::at:::mixmax.com\",\n    \"userId\": \"Emm7G4xCgCpha93qa\",\n    \"groups\": [\n      \"582664ee15c6894ec86130cf\",\n      \"5826650415c6894ec86130d0\"\n    ]\n  }]\n}","name":""},{"code":"","language":"text","status":404}]},"settings":"","auth":"required","params":[{"_id":"5826691a3c689e25000139e5","ref":"","in":"path","required":false,"desc":"The _id of the contactgroup object to fetch membership for","default":"","type":"string","name":"id"},{"_id":"586efb32fc24a70f00a886e9","ref":"","in":"query","required":false,"desc":"Field to sort by. One of: `name`, `email`, `timestamp`, or `usedCount`","default":"(created date)","type":"string","name":"sort"},{"_id":"586efb32fc24a70f00a886e8","ref":"","in":"query","required":false,"desc":"True to sort ascending (A-Z)","default":"false","type":"boolean","name":"sortAscending"},{"_id":"58ddf85bbf5e810f0062c82b","ref":"","in":"query","required":false,"desc":"Include analytics in the response","default":"false","type":"boolean","name":"withAnalytics"},{"_id":"58e44e4c3814e80f00196bfa","ref":"","in":"query","required":false,"desc":"A string describing the analytics date range. One of 'today', 'yesterday', 'last7', 'thisWeek', 'lastWeek', 'last30', 'thisMonth', 'lastMonth', 'last12Months', 'thisYear', 'lastYear', 'allTime' or 'specific'.","default":"last30","type":"string","name":"dates"},{"_id":"58e44e4c3814e80f00196bf9","ref":"","in":"query","required":false,"desc":"The client's timezone offset, in minutes. Used to determine date ranges.","default":"","type":"int","name":"timezoneOffset"},{"_id":"58e44e4c3814e80f00196bf8","ref":"","in":"query","required":false,"desc":"When `dates` is 'specific', the lower bound (in ms).","default":"","type":"timestamp","name":"since"},{"_id":"58e44e4c3814e80f00196bf7","ref":"","in":"query","required":false,"desc":"When `dates` is 'specific', the upper bound (in ms).","default":"","type":"timestamp","name":"until"},{"_id":"590bb65dc410a2250062474c","ref":"","in":"query","required":false,"desc":"Fields to expand in comma separated form. Currently supporting 'firstName' and 'lastName' and 'groups'.","default":"","type":"string","name":"expand"}],"url":"/v1/contactgroups/:id/contacts"},"isReference":true,"order":24,"body":"For response format, see [/contacts API](http://developer.mixmax.com/docs/contacts).","excerpt":"Returns membership for a contact group","slug":"contactgroupsidcontacts","type":"endpoint","title":"/contactgroups/:id/contacts"}

get/contactgroups/:id/contacts

Returns membership for a contact group

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
string
The _id of the contactgroup object to fetch membership for

Query Params

sort:
string(created date)
Field to sort by. One of: `name`, `email`, `timestamp`, or `usedCount`
sortAscending:
booleanfalse
True to sort ascending (A-Z)
withAnalytics:
booleanfalse
Include analytics in the response
dates:
stringlast30
A string describing the analytics date range. One of 'today', 'yesterday', 'last7', 'thisWeek', 'lastWeek', 'last30', 'thisMonth', 'lastMonth', 'last12Months', 'thisYear', 'lastYear', 'allTime' or 'specific'.
timezoneOffset:
integer
The client's timezone offset, in minutes. Used to determine date ranges.
since:
timestamp
When `dates` is 'specific', the lower bound (in ms).
until:
timestamp
When `dates` is 'specific', the upper bound (in ms).
expand:
string
Fields to expand in comma separated form. Currently supporting 'firstName' and 'lastName' and 'groups'.

Examples


Result Format


Documentation

For response format, see [/contacts API](http://developer.mixmax.com/docs/contacts).

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}