{"_id":"58266844f31aba3900a676b0","parentDoc":null,"project":"5588b8a2f6c18d0d005bba03","__v":9,"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"},"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"},"user":"5588b847f6c18d0d005bba01","updates":["582df73db6d4840f00deb92f","5895171241581f0f0088467d","5939254f0073e80027c8aa29","593925e7819ce5002f423ff2"],"next":{"pages":[],"description":""},"createdAt":"2016-11-12T00:54:28.646Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"{\n \"results\": [{\n \"_id\": \"5826650415c6894ec86130d0\",\n \"userId\": \"Emm7G4xCgCpha93qa\",\n \"name\": \"sales leads #1\"\n }, {\n \"_id\": \"582664ee15c6894ec86130cf\",\n \"userId\": \"Emm7G4xCgCpha93qa\",\n \"name\": \"recruiting prospects\"\n }, {\n \"_id\": \"58264cd8263fb749b67d3f1b\",\n \"userId\": \"BGb7nYTSKfPtnPsgj\",\n \"name\": \"holiday party invites\"\n }]\n}\n","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/contactgroups","language":"curl"}]},"auth":"required","params":[{"_id":"588930557fe18319006855d7","ref":"","in":"query","required":false,"desc":"See notes below","default":"","type":"string","name":"expand"},{"_id":"58a3d8019859df0f008839d1","ref":"","in":"query","required":false,"desc":"Partial, case-insensitive search on the group name","default":"","type":"string","name":"search"},{"_id":"58a602642cb5710f0070d053","ref":"","in":"query","required":false,"desc":"Field to sort by. One of: `name`, `_id`","default":"_id (created date)","type":"string","name":"sort"},{"_id":"58a602642cb5710f0070d052","ref":"","in":"query","required":false,"desc":"True to sort ascending (A-Z)","default":"false","type":"boolean","name":"sortAscending"}],"url":"/v1/contactgroups"},"isReference":true,"order":19,"body":"[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Parameter\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"_id\",\n \"0-1\": \"*String*\",\n \"0-2\": \"Unique ID\",\n \"1-0\": \"userId\",\n \"1-1\": \"*String*\",\n \"1-2\": \"User id. Will be yours unless this is a shared list, then it will be the user id of the creator. Pass `expand=userId` on the querystring to expand this to include the `name` and `email` of the owner.\",\n \"3-0\": \"name\",\n \"3-1\": \"*String*\",\n \"3-2\": \"Name of the contact group\",\n \"5-0\": \"shared\",\n \"5-1\": \"*Object*\",\n \"5-2\": \"See [format](/docs/shared).\",\n \"4-0\": \"count (*meta-field*)\",\n \"4-1\": \"*Number*\",\n \"4-2\": \"Number of contacts in this group. **This is a meta-field** that is only returned if you pass `expand=count` on the request querystring.\",\n \"2-0\": \"groupId\",\n \"2-1\": \"*String*\",\n \"2-2\": \"If this group is associated with a google group, this will be the google id.\"\n },\n \"cols\": 3,\n \"rows\": 6\n}\n[/block]","excerpt":"Contact groups that you have access to (either that you have created, or that have been shared with you)","slug":"contactgroups","type":"endpoint","title":"/contactgroups"}get/contactgroups
Contact groups that you have access to (either that you have created, or that have been shared with you)
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Query Params
expand:
string
See notes below
search:
string
Partial, case-insensitive search on the group name
sort:
string_id (created date)
Field to sort by. One of: `name`, `_id`
sortAscending:
booleanfalse
True to sort ascending (A-Z)