{"_id":"58640bbe2e42bc0f00fbdcf1","__v":5,"githubsync":"","parentDoc":null,"version":{"_id":"5588b8a2f6c18d0d005bba06","project":"5588b8a2f6c18d0d005bba03","__v":16,"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","5a31c9409a6f2000125c079f"],"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: Access your Mixmax data"},"user":"5588b847f6c18d0d005bba01","project":"5588b8a2f6c18d0d005bba03","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-28T19:00:14.283Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","code":"curl --header \"X-API-Token: <your token>\" https://api.mixmax.com/v1/snippettags"}]},"method":"get","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  results: [{\n    _id: \"586346d00000000000000000\",\n    userId: \"586346d00000000000000000\",\n    createdAt: 1478122191866,\n    savedAt: 1478122199067,\n    name: \"My test snippet tag\",\n    shared: [{\n      userEmail: \"email:::at:::domain.com\",\n      confirmed: true\n    }],\n    isInline: false\n  }, {\n    _id: \"586346d00000000000000001\",\n    userId: \"586346d00000000000000000\",\n    createdAt: 1478122191867,\n    savedAt: 1478122199068,\n    name: \"My other snippet tag\",\n    shared: [{\n      userEmail: \"email@domain.com\",\n      confirmed: true\n    }],\n    isInline: true\n  }]\n}"}]},"settings":"","auth":"required","params":[{"_id":"58a4fe2d9b78df19004ab1c7","ref":"","in":"query","required":false,"desc":"(Optional) field to sort results by","default":"no sort","type":"string","name":"sort"},{"_id":"58a4fe2d9b78df19004ab1c6","ref":"","in":"query","required":false,"desc":"(Optional) true to sort ascending","default":"false","type":"string","name":"sortAscending"},{"_id":"58a6067d5d720d0f009f8ad3","ref":"","in":"query","required":false,"desc":"(Optional) Separate multiple expand queries using comma (ex: expand=count,userId). Pass `expand=count` to return count of snippets in this tag. Pass `expand=userId` on the querystring to expand this to include the email of the owner.","default":"","type":"string","name":"expand"},{"_id":"58aa9c24e896790f00c9065b","ref":"","in":"query","required":false,"desc":"Returns snippet tags that match this search string","default":"none","type":"string","name":"search"},{"_id":"5ab07e7b665556001e5b46f1","ref":"","in":"query","required":false,"desc":"(Optional) False to only return template folders and true to only return snippet folders (they don't include subject lines and can't be sent individually).","default":"","type":"boolean","name":"isInline"}],"url":"/v1/snippettags"},"isReference":true,"order":133,"body":"Note: Supports the `expand` query parameter for `snippetIds`.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"_id\",\n    \"1-0\": \"userId\",\n    \"4-0\": \"name\",\n    \"6-0\": \"shared\",\n    \"0-1\": \"*String*\",\n    \"1-1\": \"*String*\",\n    \"4-1\": \"*String*\",\n    \"6-1\": \"*Object*\",\n    \"0-2\": \"Unique id.\",\n    \"1-2\": \"User id of owner.\",\n    \"4-2\": \"Name of the snippet tag.\",\n    \"6-2\": \"See [docs](/docs/shared).\",\n    \"2-0\": \"createdAt\",\n    \"2-1\": \"*Date*\",\n    \"2-2\": \"Date when it was created.\",\n    \"3-0\": \"savedAt\",\n    \"3-1\": \"*Date*\",\n    \"3-2\": \"Date when it was last modified. This field is updated when an attribute on the snippettag is changed, snippets are added to the tag, or when snippets in the tag are deleted/moved.\",\n    \"5-0\": \"count (*meta-field*)\",\n    \"5-1\": \"*Number*\",\n    \"5-2\": \"Number of snippets in this tag. **This is a meta-field** that is only returned if you pass `expand=count` on the request querystring.\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","excerpt":"Lists template and/or snippet folders (known as \"snippet tags\" in the backend)","slug":"snippettags","type":"endpoint","title":"/snippettags"}

get/snippettags

Lists template and/or snippet folders (known as "snippet tags" in the backend)

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

sort:
stringno sort
(Optional) field to sort results by
sortAscending:
stringfalse
(Optional) true to sort ascending
expand:
string
(Optional) Separate multiple expand queries using comma (ex: expand=count,userId). Pass `expand=count` to return count of snippets in this tag. Pass `expand=userId` on the querystring to expand this to include the email of the owner.
search:
stringnone
Returns snippet tags that match this search string
isInline:
boolean
(Optional) False to only return template folders and true to only return snippet folders (they don't include subject lines and can't be sent individually).

Examples


Result Format


Documentation

Note: Supports the `expand` query parameter for `snippetIds`. [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Type", "h-2": "Description", "0-0": "_id", "1-0": "userId", "4-0": "name", "6-0": "shared", "0-1": "*String*", "1-1": "*String*", "4-1": "*String*", "6-1": "*Object*", "0-2": "Unique id.", "1-2": "User id of owner.", "4-2": "Name of the snippet tag.", "6-2": "See [docs](/docs/shared).", "2-0": "createdAt", "2-1": "*Date*", "2-2": "Date when it was created.", "3-0": "savedAt", "3-1": "*Date*", "3-2": "Date when it was last modified. This field is updated when an attribute on the snippettag is changed, snippets are added to the tag, or when snippets in the tag are deleted/moved.", "5-0": "count (*meta-field*)", "5-1": "*Number*", "5-2": "Number of snippets in this tag. **This is a meta-field** that is only returned if you pass `expand=count` on the request querystring." }, "cols": 3, "rows": 7 } [/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 }}