{"__v":1,"_id":"581014ff670a2f0f00b164b0","category":{"__v":0,"_id":"57f53fb368a53b2000e03f0f","project":"5588b8a2f6c18d0d005bba03","version":"5588b8a2f6c18d0d005bba06","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","version":{"__v":14,"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","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"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-10-26T02:29:19.779Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"curl -v --header \"X-API-Token: <your token>\" \"https://api.mixmax.com/v1/polls\"","language":"curl"}]},"results":{"codes":[{"name":"","code":"{\n  \"results\": [\n    {\n      \"_id\": \"5810142fd61495a1799bba05\",\n      \"createdAt\": 1477448751882,\n      \"userId\": \"kZYPwDDiGPTfQDj5n\",\n      \"question\": \"What's your favorite color?\",\n      \"livePoll\": true,\n      \"options\": [\n        {\n          \"text\": \"red\"\n        },\n        {\n          \"text\": \"blue\"\n        },\n        {\n          \"text\": \"green\",\n          \"respondents\": [\n            {\n              \"name\": \"Mixmax\",\n              \"email\": \"hello:::at:::mixmx.com\",\n              \"respondedAt\": 1477448759785\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}\n","language":"json","status":200}]},"settings":"","auth":"required","params":[],"url":"/v1/polls"},"isReference":true,"order":37,"body":"This API returns a list of polls you've created in Mixmax, along with who has voted in them.\n[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\": \"createdAt\",\n    \"1-1\": \"*Timestamp*\",\n    \"1-2\": \"Unix timestamp when it was created\",\n    \"2-0\": \"userId\",\n    \"2-1\": \"*String*\",\n    \"2-2\": \"Your user id\",\n    \"3-0\": \"question\",\n    \"3-1\": \"*String*\",\n    \"3-2\": \"The poll question, entered when it was created\",\n    \"4-0\": \"livePoll\",\n    \"4-1\": \"*Boolean*\",\n    \"4-2\": \"Value of the \\\"Recipients can view results of poll\\\" checkbox when it was created\",\n    \"5-0\": \"options\",\n    \"5-1\": \"*Array*\",\n    \"5-2\": \"Array of answers to the poll\",\n    \"6-0\": \"options.text\",\n    \"6-1\": \"*String*\",\n    \"6-2\": \"Text of the poll answer\",\n    \"7-0\": \"options.respondents\",\n    \"7-1\": \"*Array*\",\n    \"7-2\": \"Array of respondents\",\n    \"9-0\": \"options.respondents.name\",\n    \"9-1\": \"*String*\",\n    \"9-2\": \"Name of respondent, if available (from the email the poll was sent in)\",\n    \"8-0\": \"options.respondents.email\",\n    \"8-1\": \"*String*\",\n    \"8-2\": \"Email of respondent\",\n    \"10-0\": \"options.respondents.respondedAt\",\n    \"10-1\": \"*Timestamp*\",\n    \"10-2\": \"When they responded\"\n  },\n  \"cols\": 3,\n  \"rows\": 11\n}\n[/block]","excerpt":"Returns a list of polls that you've sent out","slug":"polls","type":"get","title":"/polls"}

get/polls

Returns a list of polls that you've sent out

Definition

{{ api_url }}{{ page_api_url }}

Examples


Result Format


Documentation

This API returns a list of polls you've created in Mixmax, along with who has voted in them. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "_id", "0-1": "*String* ", "0-2": "Unique ID", "1-0": "createdAt", "1-1": "*Timestamp*", "1-2": "Unix timestamp when it was created", "2-0": "userId", "2-1": "*String*", "2-2": "Your user id", "3-0": "question", "3-1": "*String*", "3-2": "The poll question, entered when it was created", "4-0": "livePoll", "4-1": "*Boolean*", "4-2": "Value of the \"Recipients can view results of poll\" checkbox when it was created", "5-0": "options", "5-1": "*Array*", "5-2": "Array of answers to the poll", "6-0": "options.text", "6-1": "*String*", "6-2": "Text of the poll answer", "7-0": "options.respondents", "7-1": "*Array*", "7-2": "Array of respondents", "9-0": "options.respondents.name", "9-1": "*String*", "9-2": "Name of respondent, if available (from the email the poll was sent in)", "8-0": "options.respondents.email", "8-1": "*String*", "8-2": "Email of respondent", "10-0": "options.respondents.respondedAt", "10-1": "*Timestamp*", "10-2": "When they responded" }, "cols": 3, "rows": 11 } [/block]

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 }}