{"_id":"5876c403b98f400f000b4591","__v":2,"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"},"parentDoc":null,"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"},"user":"5588b847f6c18d0d005bba01","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-01-11T23:47:15.753Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"{\n  \"results\": [\n    {\n      \"_id\": \"580aa34686e6e2194b25d79e\",\n      \"trigger\": \"noReply\",\n      \"userId\": \"kZYPwDDiGPTfQDj5n\",\n      \"threadSubject\": \"This is a test reminder\",\n\t\t\t\"description\": \"This is a note on the reminder\",\n      \"date\": 1484178784,\n\t\t\t\"service\": \"gmail\",\n      \"serviceMessageId\": \"15331436f51a94ce\",\n\t\t\t\"serviceThreadId\": \"150f0aede186c987\",\n      \"mixmaxMessageId\": \"wQrk0XjdU06phFNOo\",\n      \"dismissed\": false,\n      \"createdAt\": 1484165108\n    }\n  ],\n  \"hasNext\": false,\n  \"next\": \"eyIkb2lkIjoiNTgwYWEzNDY4NmU2ZTIxOTRiMjVkNzllIn0\",\n\t\"hasPrev\": false,\n  \"prev\": \"skja876jSJA8saKASjd89ds7asSakj8963AS7dSA7djAas9\"\n}","language":"json","status":200}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/reminders"}]},"auth":"required","params":[{"_id":"5876c7851a6b5b3900a5b340","ref":"","in":"query","required":false,"desc":"Only return reminders from this service (e.g. 'gmail'). Case-insensitive.","default":"","type":"string","name":"service"},{"_id":"5876c7851a6b5b3900a5b33f","ref":"","in":"query","required":false,"desc":"Only return reminders for messages with this id on the service (e.g. if the message is in Gmail, the Gmail message id)","default":"","type":"string","name":"serviceMessageId"},{"_id":"5876c7851a6b5b3900a5b33e","ref":"","in":"query","required":false,"desc":"Only return reminders for threads with this id on the service (e.g. if the thread is in Gmail, the Gmail thread id)","default":"","type":"string","name":"serviceThreadId"},{"_id":"5876c7851a6b5b3900a5b33d","ref":"","in":"query","required":false,"desc":"Only return reminders for this Mixmax message","default":"","type":"string","name":"mixmaxMessageId"},{"_id":"587c4f956045ce0f00470899","ref":"","in":"query","required":false,"desc":"Only return reminders where `dismissed` is this","default":"","type":"boolean","name":"dismissed"},{"_id":"5876c7851a6b5b3900a5b33c","ref":"","in":"query","required":false,"desc":"Maximum number of results to return","default":"","type":"int","name":"limit"}],"url":"/v1/reminders"},"isReference":true,"order":67,"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\": \"The id of the reminder\",\n    \"1-0\": \"trigger\",\n    \"1-1\": \"*String*\",\n    \"1-2\": \"The trigger type of the reminder. One of 'noReply', 'notRead' or 'regardless'.\",\n    \"2-0\": \"userId\",\n    \"2-1\": \"*String*\",\n    \"2-2\": \"The id of the user who owns the reminder\",\n    \"3-0\": \"threadSubject\",\n    \"3-1\": \"*String*\",\n    \"3-2\": \"The subject of the thread the reminder is attached to\",\n    \"4-0\": \"description\",\n    \"4-1\": \"*String*\",\n    \"4-2\": \"An optional note on the reminder\",\n    \"5-0\": \"date\",\n    \"5-1\": \"*Timestamp*\",\n    \"5-2\": \"Unix timestamp (in ms) for when the reminder is scheduled to trigger\",\n    \"6-0\": \"service\",\n    \"6-1\": \"*String*\",\n    \"6-2\": \"The name of the message service e.g. 'gmail'\",\n    \"7-0\": \"serviceMessageId\",\n    \"7-1\": \"*String*\",\n    \"7-2\": \"The id of the message on its service\",\n    \"8-0\": \"serviceThreadId\",\n    \"8-1\": \"*String*\",\n    \"8-2\": \"The id of the thread on its service\",\n    \"9-0\": \"mixmaxMessageId\",\n    \"9-1\": \"*String*\",\n    \"9-2\": \"The id of the Mixmax message the reminder is attached to. Note, not all reminders are attached to a Mixmax message.\",\n    \"11-0\": \"createdAt\",\n    \"11-1\": \"*Timestamp*\",\n    \"11-2\": \"Unix timestamp (in ms) for when the reminder was created\",\n    \"10-0\": \"dismissed\",\n    \"10-1\": \"*Boolean*\",\n    \"10-2\": \"Whether the reminder has been dismissed\"\n  },\n  \"cols\": 3,\n  \"rows\": 12\n}\n[/block]","excerpt":"Returns a list of reminders","slug":"reminders","type":"endpoint","title":"/reminders"}

get/reminders

Returns a list of reminders

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

service:
string
Only return reminders from this service (e.g. 'gmail'). Case-insensitive.
serviceMessageId:
string
Only return reminders for messages with this id on the service (e.g. if the message is in Gmail, the Gmail message id)
serviceThreadId:
string
Only return reminders for threads with this id on the service (e.g. if the thread is in Gmail, the Gmail thread id)
mixmaxMessageId:
string
Only return reminders for this Mixmax message
dismissed:
boolean
Only return reminders where `dismissed` is this
limit:
integer
Maximum number of results to return

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "_id", "0-1": "*String*", "0-2": "The id of the reminder", "1-0": "trigger", "1-1": "*String*", "1-2": "The trigger type of the reminder. One of 'noReply', 'notRead' or 'regardless'.", "2-0": "userId", "2-1": "*String*", "2-2": "The id of the user who owns the reminder", "3-0": "threadSubject", "3-1": "*String*", "3-2": "The subject of the thread the reminder is attached to", "4-0": "description", "4-1": "*String*", "4-2": "An optional note on the reminder", "5-0": "date", "5-1": "*Timestamp*", "5-2": "Unix timestamp (in ms) for when the reminder is scheduled to trigger", "6-0": "service", "6-1": "*String*", "6-2": "The name of the message service e.g. 'gmail'", "7-0": "serviceMessageId", "7-1": "*String*", "7-2": "The id of the message on its service", "8-0": "serviceThreadId", "8-1": "*String*", "8-2": "The id of the thread on its service", "9-0": "mixmaxMessageId", "9-1": "*String*", "9-2": "The id of the Mixmax message the reminder is attached to. Note, not all reminders are attached to a Mixmax message.", "11-0": "createdAt", "11-1": "*Timestamp*", "11-2": "Unix timestamp (in ms) for when the reminder was created", "10-0": "dismissed", "10-1": "*Boolean*", "10-2": "Whether the reminder has been dismissed" }, "cols": 3, "rows": 12 } [/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 }}