{"__v":1,"_id":"585b20f9da34e5230097c7fe","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-12-22T00:40:25.330Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"cURL","language":"curl","code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/sequences/5852e82574db4c05b6fe771f/recipients"},{"name":"cURL (keep in draft)","language":"curl","code":"curl -XPOST \\\n    --header 'Content-Type: application/json' \\\n    --header \"X-API-Token: <your token>\" \\\n    https://api.mixmax.com/v1/sequences/593HF9J3IJ4JF30IF/recipients/ \\\n    -d '{\n        \"recipients\": [{\n              \"email\": \"hello:::at:::mixmax.com\",\n              \"variables\": {\n                  \"name\": \"Hugo Brockman\",\n                  \"email\": \"hello@mixmax.com\"\n              }\n          }],\n          \"scheduledAt\": false\n      }'"},{"code":"curl -XPOST \\\n    --header 'Content-Type: application/json' \\\n    --header \"X-API-Token: <your token>\" \\\n    https://api.mixmax.com/v1/sequences/593HF9J3IJ4JF30IF/recipients/ \\\n    -d '{\n        \"recipients\": [{\n              \"email\": \"hello@mixmax.com\",\n              \"variables\": {\n                  \"name\": \"Hugo Brockman\",\n                  \"email\": \"hello@mixmax.com\"\n              },\n              \"scheduledAt\": false\n          },\n          {\n              \"email\": \"careers@mixmax.com\",\n              \"variables\": {\n                  \"name\": \"Mixmax hello\",\n                  \"email\": \"careers@mixmax.com\"\n              }\n          }],\n          \"scheduledAt\": 1478110013\n      }'","language":"curl","name":"cURL (override scheduledAt)"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"results\": [{\n    \"_id\": \"585b1fecc9ad0023c52c5907\",\n    \"createdAt\": \"2016-12-22T00:35:56.166Z\",\n    \"email\": \"hello@mixmax.com\",\n    \"sequenceId\": \"5852e82574db4c05b6fe771f\",\n    \"state\": \"active\",\n    \"updatedAt\": \"2016-12-22T00:37:07.581Z\",\n    \"userId\": \"SYAKA5wMyDhsuDi5e\",\n    \"variables\": {\n      \"Email\": \"hello@mixmax.com\",\n      \"First Name\": \"Hello\",\n      \"Last Name\": \"Mixmax\"\n    }\n  }]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"57f65dec8d22352b00353a06","ref":"","in":"path","required":true,"desc":"The ID of the Sequence you'd like to add the user to.","default":"","type":"string","name":"id"}],"url":"/v1/sequences/:id/recipients/"},"isReference":true,"order":55,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Recipient structure\"\n}\n[/block]\n\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\": \"userId\",\n    \"1-1\": \"*String*\",\n    \"1-2\": \"User ID that created this recipient\",\n    \"4-0\": \"sequenceId\",\n    \"4-1\": \"*String*\",\n    \"4-2\": \"ID of the sequence this recipient is associated with\",\n    \"2-0\": \"createdAt\",\n    \"2-1\": \"*Date*\",\n    \"3-0\": \"updatedAt\",\n    \"3-1\": \"*Date*\",\n    \"2-2\": \"When it was created\",\n    \"3-2\": \"When it was last updated\",\n    \"5-0\": \"email\",\n    \"5-1\": \"*String*\",\n    \"5-2\": \"The email address of the recipient\",\n    \"6-0\": \"state\",\n    \"6-1\": \"*String*\",\n    \"6-2\": \"One of the following: `active`, `failed`, `completed`\",\n    \"7-0\": \"variables\",\n    \"7-1\": \"*Object*\",\n    \"7-2\": \"Arbitrary key/value pairs for this recipient. If the content `{{<key name>}}` exists in the sequence body, it will be substituted for the corresponding value (from this object) when the sequence is sent.\"\n  },\n  \"cols\": 3,\n  \"rows\": 8\n}\n[/block]","excerpt":"Retrieves the recipients belonging to the specified sequence. The list of recipients only includes recipients that were activated, it does not include recipients currently in the draft area.","slug":"sequencesidrecipients","type":"get","title":"/sequences/:id/recipients"}

get/sequences/:id/recipients

Retrieves the recipients belonging to the specified sequence. The list of recipients only includes recipients that were activated, it does not include recipients currently in the draft area.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of the Sequence you'd like to add the user to.

Examples


Result Format


Documentation

[block:api-header] { "type": "basic", "title": "Recipient structure" } [/block] [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "_id", "0-1": "*String*", "0-2": "Unique ID", "1-0": "userId", "1-1": "*String*", "1-2": "User ID that created this recipient", "4-0": "sequenceId", "4-1": "*String*", "4-2": "ID of the sequence this recipient is associated with", "2-0": "createdAt", "2-1": "*Date*", "3-0": "updatedAt", "3-1": "*Date*", "2-2": "When it was created", "3-2": "When it was last updated", "5-0": "email", "5-1": "*String*", "5-2": "The email address of the recipient", "6-0": "state", "6-1": "*String*", "6-2": "One of the following: `active`, `failed`, `completed`", "7-0": "variables", "7-1": "*Object*", "7-2": "Arbitrary key/value pairs for this recipient. If the content `{{<key name>}}` exists in the sequence body, it will be substituted for the corresponding value (from this object) when the sequence is sent." }, "cols": 3, "rows": 8 } [/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 }}