{"__v":2,"_id":"58155c8b9b707d0f003d1ce6","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-30T02:35:55.720Z","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/sequences","language":"curl"}]},"results":{"codes":[{"name":"","code":"{\n  \"results\": [{\n    \"_id\": \"5815495f8447b9058a310430\",\n    \"userId\": \"kZYPwDDiGPTfQDj5n\",\n    \"createdAt\": \"2016-10-30T01:14:07.790Z\",\n    \"updatedAt\": \"2016-10-30T01:14:10.688Z\",\n    \"name\": \"Sales leads - second batch\",\n    \"sendStagesAsReplies\": true,\n    \"linkTrackingEnabled\": true,\n    \"notificationsEnabled\": true,\n    \"stages\": [\n      \"5815495f8447b9058a31042f\"\n    ],\n    \"variables\" : [\n        \"Email\", \n        \"First name\", \n        \"job title\"\n    ],\n    \"crmsConnected\" : [\n        {\n            \"name\" : \"salesforce\", \n            \"logTo\" : false\n        }\n    ],\n    \"cc\" : [\n        {\n            \"name\" : \"Hello Mixmax\", \n            \"email\" : \"hello:::at:::mixmax.com\"\n        }\n    ],\n    \"teamIds\" : [\n        \"roWxvJ4CTtgJoP5gz\"\n    ],\n  }]\n}\n","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"58155c8b9b707d0f003d1ce7","ref":"","in":"query","required":false,"desc":"(optional) Performs a partial match on the name of the sequence (search string must be a prefix of the word).","default":"none","type":"string","name":"name"}],"url":"/v1/sequences"},"isReference":true,"order":54,"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\": \"Your user id\",\n    \"2-0\": \"createdAt\",\n    \"2-1\": \"*Date*\",\n    \"2-2\": \"When the sequence was created\",\n    \"3-0\": \"name\",\n    \"3-1\": \"*String*\",\n    \"3-2\": \"User-configured name of the sequences\",\n    \"4-0\": \"sendStagesAsReplies\",\n    \"4-1\": \"*Boolean*\",\n    \"4-2\": \"Value of the \\\"Send each stage as a reply to the previous message\\\" checkbox\",\n    \"5-0\": \"stages\",\n    \"5-1\": \"*Array*\",\n    \"5-2\": \"Array of sequence stage ids. use the /sequences/stages/:id API to fetch these. **Supports expansion** (pass `expand=stages` on the URL for full stages).\",\n    \"6-0\": \"cc\",\n    \"6-1\": \"*Array*\",\n    \"6-2\": \"Array of CC recipients (configured when creating the sequence)\",\n    \"9-0\": \"bcc\",\n    \"9-1\": \"*Array*\",\n    \"9-2\": \"Array of BCC recipients\",\n    \"12-0\": \"linkTrackingEnabled\",\n    \"12-1\": \"*Boolean*\",\n    \"13-0\": \"notificationsEnabled\",\n    \"13-1\": \"*Boolean*\",\n    \"12-2\": \"True if the \\\"Link tracking\\\" checkbox was checked when creating the sequence\",\n    \"13-2\": \"True if the \\\"Desktop notifications\\\" checkbox was checked when creating the sequence\",\n    \"14-0\": \"teamIds\",\n    \"14-1\": \"*Array*\",\n    \"14-2\": \"Array of team ids that messages will be synced to (so they can see in their Team Live Feed)\",\n    \"15-0\": \"variables\",\n    \"15-1\": \"*Array*\",\n    \"15-2\": \"Array of variables that are used in this sequence\",\n    \"16-0\": \"crmsConnected\",\n    \"16-1\": \"*Array*\",\n    \"16-2\": \"List of CRMs connected (if logTo) is true.\",\n    \"19-0\": \"updatedAt\",\n    \"19-1\": \"*Date*\",\n    \"19-2\": \"When a recipient was last added to the sequence.\",\n    \"7-0\": \"cc.email\",\n    \"7-1\": \"*String*\",\n    \"8-0\": \"cc.name\",\n    \"8-1\": \"*String*\",\n    \"7-2\": \"Email of CC recipient\",\n    \"8-2\": \"Name of CC recipient (if provided)\",\n    \"10-0\": \"bcc.email\",\n    \"11-0\": \"bcc.name\",\n    \"10-1\": \"*String*\",\n    \"11-1\": \"*String*\",\n    \"10-2\": \"Email of BCC recipient\",\n    \"11-2\": \"Name of BCC recipient (if provided)\",\n    \"17-0\": \"crmsConnected.name\",\n    \"17-1\": \"*String*\",\n    \"17-2\": \"Name of CRM\",\n    \"18-0\": \"crmsConnected.logTo\",\n    \"18-1\": \"*Boolean*\",\n    \"18-2\": \"True if logging to to this CRM\",\n    \"20-0\": \"timezone\",\n    \"20-1\": \"*String*\",\n    \"20-2\": \"The time zone in which the sequence was created. Used to populate smart variables, such as {{time of day}}. Time zone is a valid IANA time zone\"\n  },\n  \"cols\": 3,\n  \"rows\": 21\n}\n[/block]","excerpt":"Returns a list of sequences","slug":"sequences","type":"get","title":"/sequences"}

get/sequences

Returns a list of sequences

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

name:
stringnone
(optional) Performs a partial match on the name of the sequence (search string must be a prefix of the word).

Examples


Result Format


Documentation

[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": "Your user id", "2-0": "createdAt", "2-1": "*Date*", "2-2": "When the sequence was created", "3-0": "name", "3-1": "*String*", "3-2": "User-configured name of the sequences", "4-0": "sendStagesAsReplies", "4-1": "*Boolean*", "4-2": "Value of the \"Send each stage as a reply to the previous message\" checkbox", "5-0": "stages", "5-1": "*Array*", "5-2": "Array of sequence stage ids. use the /sequences/stages/:id API to fetch these. **Supports expansion** (pass `expand=stages` on the URL for full stages).", "6-0": "cc", "6-1": "*Array*", "6-2": "Array of CC recipients (configured when creating the sequence)", "9-0": "bcc", "9-1": "*Array*", "9-2": "Array of BCC recipients", "12-0": "linkTrackingEnabled", "12-1": "*Boolean*", "13-0": "notificationsEnabled", "13-1": "*Boolean*", "12-2": "True if the \"Link tracking\" checkbox was checked when creating the sequence", "13-2": "True if the \"Desktop notifications\" checkbox was checked when creating the sequence", "14-0": "teamIds", "14-1": "*Array*", "14-2": "Array of team ids that messages will be synced to (so they can see in their Team Live Feed)", "15-0": "variables", "15-1": "*Array*", "15-2": "Array of variables that are used in this sequence", "16-0": "crmsConnected", "16-1": "*Array*", "16-2": "List of CRMs connected (if logTo) is true.", "19-0": "updatedAt", "19-1": "*Date*", "19-2": "When a recipient was last added to the sequence.", "7-0": "cc.email", "7-1": "*String*", "8-0": "cc.name", "8-1": "*String*", "7-2": "Email of CC recipient", "8-2": "Name of CC recipient (if provided)", "10-0": "bcc.email", "11-0": "bcc.name", "10-1": "*String*", "11-1": "*String*", "10-2": "Email of BCC recipient", "11-2": "Name of BCC recipient (if provided)", "17-0": "crmsConnected.name", "17-1": "*String*", "17-2": "Name of CRM", "18-0": "crmsConnected.logTo", "18-1": "*Boolean*", "18-2": "True if logging to to this CRM", "20-0": "timezone", "20-1": "*String*", "20-2": "The time zone in which the sequence was created. Used to populate smart variables, such as {{time of day}}. Time zone is a valid IANA time zone" }, "cols": 3, "rows": 21 } [/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 }}