{"_id":"598a494b482843000faaf438","project":"5588b8a2f6c18d0d005bba03","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","__v":2,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-08-08T23:29:15.146Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","examples":{"codes":[]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{  \n   \"total\": 1,\n   \"results\":[  \n      {  \n         \"userId\":\"someUserId\",\n         \"sequenceId\":\"someSequenceId\",\n         \"completedReason\":null,\n         \"email\":\"someRecipient:::at:::mixmax.com\",\n         \"name\":\"Some Recipient\",\n         \"createdAt\":1502071661,\n         \"state\":\"active\",\n         \"isActive\":1,\n         \"isCompleted\":0,\n         \"lastStageProcessedAt\":1502071707,\n         \"lastStageSentAt\":1502071711,\n         \"lastStageSentOrdinal\":1,\n         \"nextStageScheduledAt\":1502071679,\n         \"wasSent\":1,\n         \"wasDelivered\":1,\n         \"wasDeliveredWithTrackedOpens\":1,\n         \"wasDeliveredWithTrackedLinks\":0,\n         \"wasDeliveredWithTrackedFiles\":0,\n         \"wasDeliveredWithTrackedInvites\":1,\n         \"wasOpened\":1,\n         \"wasClicked\":0,\n         \"wasDownloaded\":0,\n         \"wasReplied\":0,\n         \"wasSenderReplied\":0,\n         \"wasAccepted\":0,\n         \"wasDeclined\":0,\n         \"wasTentative\":0,\n         \"wasBounced\":0,\n         \"numOpens\":1,\n         \"numClicks\":0,\n         \"numDownloads\":0,\n         \"numDelivered\":1,\n         \"stages\":[  \n            {  \n               \"id\":\"someStageId\",\n               \"ordinal\":0,\n               \"numOpens\":1,\n               \"numClicks\":0,\n               \"numDownloads\":0,\n               \"type\":\"message\",\n               \"scheduledAt\":1502071679,\n               \"processedAt\":1502071707,\n               \"sentAt\":1502071711,\n               \"messageId\":\"someMessageId\",\n               \"failedError\":null,\n               \"sendingError\":null,\n               \"salesforceTaskId\":null,\n               \"salesforceTaskCreatedAt\":null,\n               \"salesforceTaskStatus\":null,\n               \"salesforceTaskAssignee\":null,\n               \"trigger\":\"noReply\",\n               \"fromEmail\":\"someUser@mixmax.com\",\n               \"fromName\":\"Some User\",\n               \"state\":\"sent\",\n               \"isScheduled\":0,\n               \"wasProcessed\":1,\n               \"wasProcessedOrIsScheduled\":1,\n               \"didExitFrom\":0,\n               \"wasSent\":1,\n               \"wasDelivered\":1,\n               \"wasDeliveredWithTrackedOpens\":1,\n               \"wasDeliveredWithTrackedLinks\":0,\n               \"wasDeliveredWithTrackedFiles\":0,\n               \"wasDeliveredWithTrackedInvites\":1,\n               \"wasOpened\":1,\n               \"wasClicked\":0,\n               \"wasDownloaded\":0,\n               \"wasReplied\":0,\n               \"wasSenderReplied\":0,\n               \"wasAccepted\":0,\n               \"wasDeclined\":0,\n               \"wasTentative\":0,\n               \"wasBounced\":0,\n               \"wasTaskCreated\":0\n            },\n            {  \n               \"id\":\"someOtherStageId\",\n               \"ordinal\":1,\n               \"numOpens\":0,\n               \"numClicks\":0,\n               \"numDownloads\":0,\n               \"type\":\"message\",\n               \"scheduledAt\":1502330907,\n               \"processedAt\":null,\n               \"sentAt\":null,\n               \"messageId\":null,\n               \"failedError\":null,\n               \"sendingError\":null,\n               \"salesforceTaskId\":null,\n               \"salesforceTaskCreatedAt\":null,\n               \"salesforceTaskStatus\":null,\n               \"salesforceTaskAssignee\":null,\n               \"trigger\":\"noReply\",\n               \"fromEmail\":null,\n               \"fromName\":null,\n               \"state\":\"scheduled\",\n               \"isScheduled\":1,\n               \"wasProcessed\":0,\n               \"wasProcessedOrIsScheduled\":1,\n               \"didExitFrom\":0,\n               \"wasSent\":0,\n               \"wasDelivered\":0,\n               \"wasDeliveredWithTrackedOpens\":0,\n               \"wasDeliveredWithTrackedLinks\":0,\n               \"wasDeliveredWithTrackedFiles\":0,\n               \"wasDeliveredWithTrackedInvites\":0,\n               \"wasOpened\":0,\n               \"wasClicked\":0,\n               \"wasDownloaded\":0,\n               \"wasReplied\":0,\n               \"wasSenderReplied\":0,\n               \"wasAccepted\":0,\n               \"wasDeclined\":0,\n               \"wasTentative\":0,\n               \"wasBounced\":0,\n               \"wasTaskCreated\":0\n            }\n         ],\n         \"_id\":\"someRecipientId\",\n         \"to\":{  \n            \"email\":\"someRecipient@mixmax.com\",\n            \"name\":\"Some recipient\"\n         },\n         \"lastStageSent\":{  \n            \"ordinal\":0,\n            \"processedAt\":1502071707\n         },\n         \"sequence\":{  \n            \"name\":\"Some Sequence\"\n         }\n      }\n   ]\n}","name":""}]},"auth":"required","params":[{"_id":"598a4aaadcfc97000fb43e7b","ref":"","in":"query","required":false,"desc":"A search string. For now, only matches against recipient email address, but will be expanded soon to match against recipient name. Case insensitive. Either `text` or `recipients` must be supplied.","default":"","type":"string","name":"text"},{"_id":"598a4aaadcfc97000fb43e7a","ref":"","in":"query","required":false,"desc":"An array of recipient email addresses. Case insensitive. Either `text` or `recipients` must be supplied.","default":"","type":"array_string","name":"recipients"},{"_id":"598a4aaadcfc97000fb43e79","ref":"","in":"query","required":false,"desc":"The id of the sequence to filter by. If omitted, returns one result per sequence for each matching recipient.","default":"","type":"string","name":"sequenceId"}],"url":"/v1/sequences/search"},"isReference":true,"order":111,"body":"","excerpt":"Search sequence recipients by email and sequenceId, returning their status.","slug":"sequencessearch","type":"endpoint","title":"/sequences/search"}

get/sequences/search

Search sequence recipients by email and sequenceId, returning their status.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

text:
string
A search string. For now, only matches against recipient email address, but will be expanded soon to match against recipient name. Case insensitive. Either `text` or `recipients` must be supplied.
recipients:
array of strings
An array of recipient email addresses. Case insensitive. Either `text` or `recipients` must be supplied.
sequenceId:
string
The id of the sequence to filter by. If omitted, returns one result per sequence for each matching recipient.

Result Format


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