{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/:site_id/snippets","auth":"required","method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n    \"snippets\": [\n    \t{\n        \"id\": 12345,\n        \"type\": \"html\",\n        \"name\": \"My Awesome Snippet 1\",\n        \"html\": \"<html><head></head><body><h1> My Awesome Snippet 1</h1></body></html>\",\n        \"created_at\": \"2019-11-12T09:02:37.000Z\",\n        \"updated_at\": \"2019-11-12T09:02:37.000Z\",\n        \"created_by\": \"ashankar:::at:::zetaglobal.com\",\n        \"updated_by\": \"[email protected]\"\n\t\t\t},\n      {\n        \"id\": 12346,\n        \"type\": \"html\",\n        \"name\": \"My Awesome Snippet 2\",\n        \"html\": \"<html><head></head><body><h1> My Awesome Snippet 2</h1></body></html>\",\n        \"created_at\": \"2019-11-12T09:02:37.000Z\",\n        \"updated_at\": \"2019-11-12T09:02:37.000Z\",\n        \"created_by\": \"[email protected]\",\n        \"updated_by\": \"[email protected]\"\n\t\t\t}\n      \n   ],\n  \"item_count\": 2\n}","name":""}]},"settings":"56ea050204dc470e002870f1","params":[{"name":"page_index","type":"string","default":"","desc":"Index of the page","required":false,"in":"query","ref":"","_id":"5dd66973117846003a5ab3c0"},{"name":"page_size","type":"int","default":"10","desc":"The number of records to return in a paginated call. maximum:20","required":false,"in":"query","ref":"","_id":"5dd66973117846003a5ab3bf"},{"name":"fields","type":"array_string","default":"","desc":"List of fields to return in the response(e.g. name, created_at)","required":false,"in":"query","ref":"","_id":"5dd66973117846003a5ab3be"},{"name":"exclude_fields","type":"array_string","default":"","desc":"List of fields to exclude in the response","required":false,"in":"query","ref":"","_id":"5dd66973117846003a5ab3bd"},{"name":"sort_field","type":"string","default":"updated_at","desc":"Returns snippets sorted by the specified field in ascending order (e.g. date_created, name). Default is updated_at in descending order","required":false,"in":"query","ref":"","_id":"5dd66973117846003a5ab3bc"},{"name":"created_by","type":"string","default":"","desc":"User who created the template","required":false,"in":"query","ref":"","_id":"5dd66973117846003a5ab3bb"},{"name":"created_since","type":"datetime","default":"","desc":"Restrict the response to snippets created after the set date in ISO 8601 format","required":false,"in":"query","ref":"","_id":"5dd66973117846003a5ab3ba"},{"name":"created_before","type":"datetime","default":"","desc":"Restrict the response to snippets created before the set date in ISO 8601 format","required":false,"in":"query","ref":"","_id":"5dd66973117846003a5ab3b9"},{"name":"type","type":"string","default":"","desc":"Limit results based on the content type (visual / html)","required":false,"in":"query","ref":"","_id":"5dd66973117846003a5ab3b8"},{"name":"site_id","type":"string","default":"","desc":"ZMP Site ID","required":false,"in":"path","ref":"","_id":"6059f5b62388320051893b6a"}]},"next":{"description":"","pages":[]},"title":"Get a List of Snippets","type":"endpoint","slug":"get-all-snippets","excerpt":"Returns the HTML content for all snippets in an account as an array. This request supports pagination with default page size of 10 and sorted by last updated date, from most to least recently. Total item count is available with each response, and additional query params can be defined to filter and fine-tune the desired response.","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Required Headers\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"Content-Type\",\n    \"0-1\": \"application/json\",\n    \"1-0\": \"Accept\",\n    \"1-1\": \"application/json\",\n    \"2-0\": \"Authorization\",\n    \"2-1\": \"Basic <Auth Key>\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","updates":[],"order":26,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5dca70860a703402b5ed55ed","project":"56aff08c3a5b810d00745d99","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56aff08d3a5b810d00745d9d","56aff24f3a5b810d00745da0","56aff25dbc304a0d00ace207","56aff287e0b1e40d00c53798","56aff2b260a37a0d00ed8883","56aff2b8e0b1e40d00c53799","56aff2bd5b1f01170014dc7b","56aff2c9d21e9c0d00b62993","56aff493aef9a21700da0e67","56aff4ce1486990d009c0f64","56aff4da5b1f01170014dc7d","56aff4dfe0b1e40d00c537a2","56aff4e59d32e30d0006d3e9","56aff4e91486990d009c0f65","56aff4f93a5b810d00745da2","56aff4fe9d32e30d0006d3ea","56b91c7ab1e03e0d001057c5","56c4f51aba4a540d0091b9a2","56cd09488c4a331d002c1e44","56d4ec4773dcd20b00fb8769","56e79bc515f96b2200878e54","56ec25c538ff1d2200d56cc2","56ec3a6f36bc8e0e00f190c8","56ec3e308ea7ce0e00a3d8b0","5724d8fe4255580e005938b2","5724dc842ad0bc1700122803","5776ef2a04f7500e0095dc37","57ab9f70b5e8742000e17eb9","57d7117646dcc30e007dd21f","58e6abd5b1eece19008b7d31","59288c65e2653627003e1221","5a8f4797a44f8600128e75ee","5bbf8833eb416300039a2c14","5ea811617bf4b5007328a0af"],"_id":"56aff08c3a5b810d00745d9c","project":"56aff08c3a5b810d00745d99","releaseDate":"2016-02-01T23:55:56.544Z","__v":34,"createdAt":"2016-02-01T23:55:56.544Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["56ec26de1b16a3290030cf58"],"title":"Zeta REST API","slug":"bme-rest-api","order":2,"from_sync":false,"reference":true,"_id":"56ec25c538ff1d2200d56cc2","version":"56aff08c3a5b810d00745d9c","__v":1,"createdAt":"2016-03-18T15:59:01.460Z","project":"56aff08c3a5b810d00745d99"},"user":"5baa64ec1828a9000363fada","createdAt":"2019-11-12T08:42:46.461Z","__v":9,"parentDoc":null}

getGet a List of Snippets

Returns the HTML content for all snippets in an account as an array. This request supports pagination with default page size of 10 and sorted by last updated date, from most to least recently. Total item count is available with each response, and additional query params can be defined to filter and fine-tune the desired response.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

site_id:
string
ZMP Site ID

Query Params

page_index:
string
Index of the page
page_size:
integer10
The number of records to return in a paginated call. maximum:20
fields:
array of strings
List of fields to return in the response(e.g. name, created_at)
exclude_fields:
array of strings
List of fields to exclude in the response
sort_field:
stringupdated_at
Returns snippets sorted by the specified field in ascending order (e.g. date_created, name). Default is updated_at in descending order
created_by:
string
User who created the template
created_since:
datetime
Restrict the response to snippets created after the set date in ISO 8601 format
created_before:
datetime
Restrict the response to snippets created before the set date in ISO 8601 format
type:
string
Limit results based on the content type (visual / html)

Result Format


Documentation

[block:parameters] { "data": { "h-0": "Required Headers", "h-1": "Value", "0-0": "Content-Type", "0-1": "application/json", "1-0": "Accept", "1-1": "application/json", "2-0": "Authorization", "2-1": "Basic <Auth Key>" }, "cols": 2, "rows": 3 } [/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 }}