{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/distributionlists/:listId","auth":"required","method":"get","params":[{"name":"listId","type":"string","default":"","desc":"Optional list ID to retrieve a specific list","required":false,"in":"path","ref":"","_id":"54b5445da806f40c0050d558"}],"results":{"codes":[{"language":"json","code":"{\n  \"id\": \"53ad8d3fe4b008e4d4426fec\",\n  \"ownerId\": \"B16E557C-A918-F507-152C40EE820197A9\",\n  \"name\": \"Boston Office\",\n  \"description\": \"Our Boston Team\",\n  \"recipients\": [\n    {\n      \"firstName\": \"Ken\",\n      \"lastName\": \"Jones\",\n      \"email\": \"ken:::at:::mediamakers.com\",\n      \"userId\": \"bf33b7fc-53f1-4517-bd36-afe5ce45add5\"\n    },\n    {\n      \"firstName\": \"Janet\",\n      \"lastName\": \"Grouch\",\n      \"email\": \"[email protected]\",\n      \"userId\": \"c84560b3-cccd-4da5-a9e4-2fd98937f681\"\n    },\n    {\n      \"email\": \"[email protected]\"\n    }\n  ]\n}","name":"","status":200}]}},"next":{"description":"","pages":[]},"title":"Get List(s)","type":"endpoint","slug":"get-lists","excerpt":"Retrieves a specific or all distribution lists","body":"When a listId is passed along, this endpoint returns a specific distribution list.","updates":["54c7c5f256f4ff0d00aaac00"],"order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54b543a296fe3c0b00d38d06","editedParams2":true,"user":"54343147fa5527080064f43f","githubsync":"","project":"54343170fa5527080064f449","createdAt":"2015-01-13T16:11:14.325Z","editedParams":true,"parentDoc":null,"version":{"version":"3.0","version_clean":"3.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["54343531bfaa3d0800c4d4b0","543435b1edce040800409240","543435b9edce040800409241","543435bcedce040800409243","543435bfedce040800409244","543435c2edce040800409245","54370cc426469424002a6dfa","54370cf026469424002a6dfd","5437129d26469424002a6e2f","543712d226469424002a6e30","5480c8fd74904f1a00053c86","54aafc6eefb39016009e4d71","54ac1d36de18cc1400226e01","54ad59369219922100751732","54b41bcf4f25cb1600518d2c","54b533a3a806f40c0050d53c","54b54bbf96fe3c0b00d38d2a","54b688a27379a90c00f53a8a","54b699efbc1a46160005edfa","54b8191691011f0b00068804","54bfb002d03bfc0d0000e814","54bfb33ed03bfc0d0000e816","55a3e94e912a6e2300882cdb","55a56c370f354f0d00fd02a8","55e85ad034516037002e9325","5638ecb62fc5520d001a4cf9","572cba2fc310640e008f63d5","596e6e42c5b53b00509791b1"],"_id":"54343531bfaa3d0800c4d4af","project":"54343170fa5527080064f449","releaseDate":"2014-10-07T18:47:13.086Z","__v":28,"createdAt":"2014-10-07T18:47:13.086Z","forked_from":"54343170fa5527080064f44c"},"__v":2,"category":{"sync":{"isSync":false,"url":""},"pages":["54b5429c3157eb2a0053c6dc","54b543a296fe3c0b00d38d06","54b5470296fe3c0b00d38d1a","54b54f903157eb2a0053c6f4","54b550833157eb2a0053c6f6","54b5835396fe3c0b00d38d9b"],"title":"Distribution Lists","slug":"distribution-lists","order":12,"from_sync":false,"reference":false,"_id":"54b533a3a806f40c0050d53c","project":"54343170fa5527080064f449","__v":6,"version":"54343531bfaa3d0800c4d4af","createdAt":"2015-01-13T15:02:59.616Z"}}

getGet List(s)

Retrieves a specific or all distribution lists

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

listId:
string
Optional list ID to retrieve a specific list

Result Format


Documentation

When a listId is passed along, this endpoint returns a specific distribution list.

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