{"__v":1,"_id":"587c6b464fc9690f000d6a72","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":"2017-01-16T06:42:14.981Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[{"_id":"587c6b464fc9690f000d6a73","ref":"","in":"path","required":true,"desc":"_id of the contact to pull the notes for","default":"","type":"string","name":"id"},{"_id":"5889301aa8d88c0f009ec81c","ref":"","in":"query","required":false,"desc":"See notes below","default":"","type":"string","name":"expand"}],"url":"/v1/contacts/:id/notes"},"isReference":true,"order":12,"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\": \"createdAt\",\n    \"1-1\": \"*Date*\",\n    \"1-2\": \"The date this note was created\",\n    \"3-0\": \"userId\",\n    \"3-1\": \"*String*\",\n    \"3-2\": \"The _id of the user who created this note. Will be yours unless the contact is provided from a shared list, then it will be the user id of the creator. Pass `expand=userId` on the querystring to expand this to include the `name` and `email` of the owner.\",\n    \"5-0\": \"text\",\n    \"5-1\": \"*String*\",\n    \"5-2\": \"The text of the note\",\n    \"4-0\": \"contactId\",\n    \"4-1\": \"*String*\",\n    \"4-2\": \"The _id of the contact that this note is associated with.\",\n    \"2-0\": \"modifiedAt\",\n    \"2-1\": \"*Date*\",\n    \"2-2\": \"The date this note was modified. Will be the same as `createdAt` if it hasn't been modified.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]","excerpt":"Lists notes for a contact. These can be seen in the Mixmax Dashboard under 'Contacts'.","slug":"contactsidnotes","type":"get","title":"/contacts/:id/notes"}

get/contacts/:id/notes

Lists notes for a contact. These can be seen in the Mixmax Dashboard under 'Contacts'.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
_id of the contact to pull the notes for

Query Params

expand:
string
See notes below

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": "createdAt", "1-1": "*Date*", "1-2": "The date this note was created", "3-0": "userId", "3-1": "*String*", "3-2": "The _id of the user who created this note. Will be yours unless the contact is provided from a shared list, then it will be the user id of the creator. Pass `expand=userId` on the querystring to expand this to include the `name` and `email` of the owner.", "5-0": "text", "5-1": "*String*", "5-2": "The text of the note", "4-0": "contactId", "4-1": "*String*", "4-2": "The _id of the contact that this note is associated with.", "2-0": "modifiedAt", "2-1": "*Date*", "2-2": "The date this note was modified. Will be the same as `createdAt` if it hasn't been modified." }, "cols": 3, "rows": 6 } [/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 }}