{"_id":"55df0149af76b70d0060a519","__v":1,"editedParams2":true,"project":"55dd9f2e0efd5821000d54d9","user":"55dd9841cafe7221002a4c62","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":39,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"category":{"_id":"55e047b258c5460d0076a9a7","__v":24,"project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","pages":["55ed71142bdb6a2d0064f216","55ed71e1a872a80d00acff1a","55ed72a8df21af2b009e215f","55ef03aae7f5490d000c0dfd","55f1872e5fe76419007dc703","55f2af86d1c4c7170033df2b","55f2d812525cb12300c6c517","55f2db08c93a2d230062f971","55f2deaacb01c71900c8e218","55f2e024fb7aad2300bf1823","55f2e1f6525cb12300c6c554","55f2e47ffb7aad2300bf182b","55f2ea90525cb12300c6c56c","55f2ed9ecb01c71900c8e24a","55f2f26f71c6462100e0fdf1","55f2f2e3c93a2d230062f9af","55f2f3bdc93a2d230062f9b1","55fc1d6ae013770d008fcbf3","55fc249ff4dbbf0d008f43ef","55fc2bd3e013770d008fcc0b","55ffda3d8c0c9d0d00dcacb4","55ffdf828c0c9d0d00dcacba","55ffe1a56932a00d00ba7abc","560d322c3616cf0d00a8cc97"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-28T11:36:18.041Z","from_sync":false,"order":5,"slug":"contacts","title":"Contacts"},"editedParams":true,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-08-27T12:23:37.358Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"name":"","code":"[\n  {\n    \"id\": 5,\n    \"email\": \"darryl.netherland:::at:::example.com\",\n    \"optInType\": \"Single\",\n    \"emailType\": \"PlainText\",\n    \"dataFields\": null,\n    \"status\": \"Subscribed\"\n  },\n  {\n    \"id\": 17,\n    \"email\": \"dora.judge@example.com\",\n    \"optInType\": \"Single\",\n    \"emailType\": \"PlainText\",\n    \"dataFields\": null,\n    \"status\": \"Subscribed\"\n  },\n  {\n    \"id\": 21,\n    \"email\": \"deonna.medine@example.com\",\n    \"optInType\": \"Single\",\n    \"emailType\": \"PlainText\",\n    \"dataFields\": null,\n    \"status\": \"Subscribed\"\n  }\n]","language":"json","status":200}]},"settings":"","examples":{"codes":[{"code":"var url = \"/v2/address-books/1/contacts\";\n\nusing (var httpClient = new HttpClient())\n{\n\thttpClient.BaseAddress = new Uri(\"https://api.dotmailer.com\");\n\tvar credentials = Encoding.ASCII.GetBytes(\"username:password\");\n\thttpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(\"Basic\", Convert.ToBase64String(credentials));\n\tvar result = httpClient.GetAsync(url).Result;\n}","language":"csharp","name":""},{"code":"","language":"json"},{"language":"php","code":"$url = $baseUrl . \"/v2/address-books/1/contacts“;\n$ch = curl_init();\ncurl_setopt($ch, CURLOPT_URL, $url);\ncurl_setopt($ch, CURLOPT_RETURNTRANSFER, true);\ncurl_setopt(\n\t$ch, CURLOPT_HTTPHEADER, array('Accept: application/json',\n    \t'Content-Type: application/json')\n);\ncurl_setopt($ch, CURLAUTH_BASIC, CURLAUTH_DIGEST);\ncurl_setopt(\n\t$ch, CURLOPT_USERPWD,\n    $apiUsername . ':' . $apiPassword\n);\n\t\t\t\n$response = json_decode(curl_exec($ch));"}]},"auth":"required","params":[{"_id":"55def82cddfb40170061ced5","ref":"","in":"path","required":true,"desc":"The ID of the address book or segment, which needs to be included within the URL","default":"","type":"int","name":"ID"},{"_id":"55df0149af76b70d0060a51a","ref":"","in":"query","required":false,"desc":"The withFullData parameter can be set to 'true' to retrieve the contacts along with their full contact data fields. This parameter goes within the URL.","default":"","type":"boolean","name":"WithFullData"},{"_id":"55df006286ae7f0d00db4bef","ref":"","in":"query","required":false,"desc":"The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request.","default":"","type":"int","name":"Select"},{"_id":"55df006286ae7f0d00db4bee","ref":"","in":"query","required":false,"desc":"The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set.","default":"","type":"int","name":"Skip"}],"url":"/v:version/address-books/[ID]/contacts?withFullData=[WithFullData]&select=[Select]&skip=[Skip]"},"isReference":false,"order":17,"body":"This operation returns a list of all contacts within a specified address book or segment.","excerpt":"Gets a list of contacts in a given address book or segment by ID","slug":"get-contacts-from-address-book","type":"endpoint","title":"Get contacts from address book"}

getGet contacts from address book

Gets a list of contacts in a given address book or segment by ID

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

ID:
required
integer
The ID of the address book or segment, which needs to be included within the URL

Query Params

WithFullData:
boolean
The withFullData parameter can be set to 'true' to retrieve the contacts along with their full contact data fields. This parameter goes within the URL.
Select:
integer
The select parameter requires a number between 1 and 1000 (0 is not a valid number). You may only select a maximum of 1000 results in a single request.
Skip:
integer
The skip parameter should be used in tandem with the select parameter when wanting to iterate through a whole data set. If you want to select the next 1000 records you should set the select parameter to 1000 and the skip parameter to 1000, which will return records 1001 to 2000. You should continue to do this until 0 records are returned to retrieve the whole data set.

Examples


Result Format


Documentation

This operation returns a list of all contacts within a specified address book or segment.