{"_id":"56b4f4e2b1a8690d00a59369","category":{"_id":"56b25826147e900d00d6497a","project":"569f9cf6650e1d1900f96b5b","version":"569f9cf6650e1d1900f96b5e","pages":["56b2583a9621f20d00efb31c","56b25a3965ddf50d0076baa2","56b2738894ab060d0006743c","56b4d1cf5f1cf00d00cc46d7","56b4f4e2b1a8690d00a59369","56b4f6925f1cf00d00cc4704","56b4fa3d5997532100bc6bcc","56b50ba8eed075230097d71e","56b5123585a6922300d1c506","56b51e475997532100bc6c08","56b5220b7719bb1900143055","56b524cc3d5f130d00dad1b8","56b5265b168b5c1700c15996","56b774438fb4420d006a618b","56b78012eb783a0d007894f3","56b78292a6c10c0d00a2d65d","56b7863aeb783a0d007894f8","56b78f68a6c10c0d00a2d66b","56b794566c2a240d0094ae8a","56b7a85dd22adc0d0053f4c2","56b7ac118fb4420d006a61b7"],"__v":21,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-03T19:42:30.051Z","from_sync":false,"order":7,"slug":"user-methods","title":"User methods"},"project":"569f9cf6650e1d1900f96b5b","__v":10,"version":{"_id":"569f9cf6650e1d1900f96b5e","project":"569f9cf6650e1d1900f96b5b","__v":12,"createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","56abdd81d4432d1900eed235","56abe0558beeff0d003b8118","56ad2f8b1c09150d00a183a8","56ad4e1cd21f1b0d00fd2f97","56b00ad88f7a4f0d0029dc92","56b2432e9621f20d00efb2bd","56b25826147e900d00d6497a","56b7af2a4b372d2100722c48","56b8c4d938b1070d0028920f","56b8cdab14feef0d0082415d","58599813cf9e112d0032cdab"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"user":"5582e90181672a3900bb4fc7","githubsync":"","parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-05T19:15:46.685Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":5,"body":"## Syntax \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n <credentials object>, \\n \\\"user\\\": <mailbox_name>\\n}\",\n \"language\": \"perl\",\n \"name\": \" \"\n }\n ]\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Request fields for get_deleted_contacts\"\n}\n[/block]\nThe following fields can be used in the **get_deleted_contacts** method:\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field name\",\n \"h-1\": \"Obligation\",\n \"h-2\": \"Definition/Value\",\n \"0-0\": \"user\",\n \"0-1\": \"Required\",\n \"0-2\": \"The user's mailbox name.\"\n },\n \"cols\": 3,\n \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Response fields for get_deleted_contacts\"\n}\n[/block]\nThe following fields may be returned in response to the **get_deleted_contacts** method:\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Field name\",\n \"h-1\": \"Obligation\",\n \"h-2\": \"Description/Value\",\n \"0-0\": \"contacts\",\n \"0-1\": \"Returned if **success = true**\",\n \"0-2\": \"A list of the contacts that can be recovered. For each contact listed, the following information is returned: **company, email, firstname, home_addr, home_phone, id, lastname, mobile_phone, nickname, notes, title, work_address, work_phone**\",\n \"1-0\": \"count\",\n \"1-1\": \"Returned if **success = true**\",\n \"1-2\": \"The number of contacts returned.\",\n \"2-0\": \"error\",\n \"2-1\": \"Returned if **success = false**\",\n \"2-2\": \"A text string that explains the error.\",\n \"3-0\": \"error_number\",\n \"3-1\": \"Returned if **success = false**\",\n \"3-2\": \"A number that represents the error.\",\n \"4-0\": \"success\",\n \"4-1\": \"Always returned\",\n \"4-2\": \"Indicates whether the request was successful or not. Allowed values are **true** and **false**.\"\n },\n \"cols\": 3,\n \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Examples for get_deleted_contacts\"\n}\n[/block]\n**Request** \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"credentials\\\": {\\n \\\"user\\\": \\\"domain_admin:::at:::example.com\\\",\\n \\\"password\\\": \\\"pencil75\\\"\\n },\\n \\\"user\\\": \\\"joe_user@example.com\\\"\\n}\",\n \"language\": \"perl\",\n \"name\": \" \"\n }\n ]\n}\n[/block]\n**Response** \n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"{\\n \\\"success\\\": true,\\n \\\"count\\\": 3,\\n \\\"contacts\\\": [\\n {\\n \\\"home_phone\\\": \\\"(555) 555-5555\\\",\\n \\\"firstname\\\": \\\"Bob\\\",\\n \\\"nickname\\\": \\\"Bobby\\\",\\n \\\"work_address\\\": \\\"\\\",\\n \\\"lastname\\\": \\\"Bobson\\\",\\n \\\"email\\\": \\\"bbobson@bigmail.com\\\",\\n \\\"notes\\\": null,\\n \\\"id\\\": \\\"1321909823__1321909700169\\\",\\n \\\"title\\\": \\\"Dr.\\\",\\n \\\"mobile_phone\\\": \\\"\\\",\\n \\\"company\\\": \\\"Bob Co.\\\",\\n \\\"work_phone\\\": \\\"(923) 456-7890 \\\",\\n \\\"home_addr\\\": \\\"\\\"\\n\\t\\t}, \\n\\t\\t{\\n\\t\\t\\t\\\"home_phone\\\": \\\"\\\",\\n\\t\\t\\t\\\"firstname\\\": \\\"Betty\\\",\\n\\t\\t\\t\\\"nickname\\\": \\\"Bets\\\",\\n\\t\\t\\t\\\"work_address\\\": \\\"\\\",\\n \\\"lastname\\\": \\\"Bobson\\\",\\n\\t\\t\\t\\\"email\\\": \\\"betty@smallmail.com\\\",\\n\\t\\t\\t\\\"notes\\\": null,\\n\\t\\t\\t\\\"id\\\": \\\"1321909823__1321909823568\\\",\\n\\t\\t\\t\\\"title\\\": \\\"Ms.\\\",\\n\\t\\t\\t\\\"mobile_phone\\\": \\\"\\\",\\n\\t\\t\\t\\\"company\\\": \\\"\\\",\\n\\t\\t\\t\\\"work_phone\\\": \\\"\\\",\\n\\t\\t\\t\\\"home_addr\\\": \\\"123 Oak St.\\\\nSpringfield IL\\\\n56453\\\\n\\\"\\n }, \\n {\\n \\t\\\"home_phone\\\": \\\"\\\",\\n\\t\\t\\t\\\"firstname\\\": \\\"William\\\",\\n\\t\\t\\t\\\"nickname\\\": \\\"Billy\\\", \\\"work_address\\\": \\\"\\\",\\n\\t\\t\\t\\\"lastname\\\": \\\"Bobson\\\",\\n\\t\\t\\t\\\"email\\\": \\\"will.bobson@bobco.co.uk\\\", \\n \\\"notes\\\": null,\\n\\t\\t\\t\\\"id\\\": \\\"1321909823__1321909754264\\\",\\n\\t\\t\\t\\\"title\\\": \\\"Mr.\\\",\\n\\t\\t\\t\\\"mobile_phone\\\": \\\"(753) 867-5309\\\",\\n\\t\\t\\t\\\"company\\\": \\\"\\\",\\n\\t\\t\\t\\\"work_phone\\\": \\\"\\\",\\n \\\"home_addr\\\": \\\"\\\"\\n }\\n\\t] \\n}\",\n \"language\": \"perl\",\n \"name\": \" \"\n }\n ]\n}\n[/block]","excerpt":"The **get_deleted_contacts method** retrieves a list of deleted restorable contacts from a user's Webmail address book.","slug":"get_deleted_contacts","type":"basic","title":"get_deleted_contacts"}
get_deleted_contacts
The **get_deleted_contacts method** retrieves a list of deleted restorable contacts from a user's Webmail address book.