{"_id":"56b10e196d004b170080666f","user":"56abd213d4432d1900eed227","version":{"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","__v":27,"createdAt":"2016-01-29T20:57:39.712Z","releaseDate":"2016-01-29T20:57:39.712Z","categories":["56abd2444e4b730d009eb10e","56abd4c8f25f160d00e17f81","56abd72ff25f160d00e17f84","56b3b8ea9f97020d0012d936","56b3b91ac25dea2b00b0cac9","56b4b2faeed075230097d688","56b4b32deed075230097d689","56b4b37327d9c00d005d6bc4","56b4b3bf3d5f130d00dad120","56b4b3d9eed075230097d68a","56b4b3eb7bccae0d00e9a12e","56b4b4085997532100bc6b61","56fbce6e2885e80e006c855f","5739ed9aad40e23200f674b6","573dd672b3f88f0e00dcae1c","58ad0922e570c62500512a82","58ad092b55018f1900218fda","58e412a5aa544d1b0005f7da","59e62c2a3ccab100263e800a","59e63126b4f8b0002edbe92c","5b5bbc98eaf71700031c2fda","5bedb529a56934002ee522b9","5c3e39454d3006001420f73e","5c4f5c0e1555130014796daa","5c6ac741acb04f003f927fa7","5c7e9c7c412d4c003f750162","5d055915910ab30020e5bc06"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"__v":3,"githubsync":"","parentDoc":null,"category":{"_id":"56b4b2faeed075230097d688","__v":0,"project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","pages":[],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-05T14:34:34.496Z","from_sync":false,"order":2,"slug":"contactos","title":"Contactos"},"editedParams":true,"editedParams2":true,"project":"56abd2434e4b730d009eb10a","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-02T20:14:17.774Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"Ejemplo consulta exitosa","language":"json","code":"[\n             {\n                \"id\": 1,\n                \"name\": \"Coorporación Alegrate\",\n                \"identification\": \"159.549.847\",\n                \"email\": \"prueba:::at:::alegra.com\",\n                \"phonePrimary\": \"999-99-99\",\n                \"phoneSecondary\": \"\",\n                \"fax\": \"\",\n                \"mobile\": \"(333) 555-55-55\",\n                \"observations\": \"\",\n                \"type\" : [\"client\", \"provider\"],\n                \"address\" : {\n                        \"address\" : \"Calle principal #45\",\n                        \"city\" : \"Barcelona\"\n                },\n                \"seller\": {\n                        \"id\" : \"12\",\n                        \"name\" : \"Diana Giraldo\",\n                        \"identification\" : \"520.526.21\",\n                        \"observations\" : \"Líder de Ventas\"\n                        },\n                \"term\" : \n                        {\n                            \"id\" : 1,\n                            \"name\" : \"8 días\",\n                            \"days\" : 8\n                        },\n                \"priceList\" : {\n                        \"id\" : 5,\n                        \"name\" : \"Distribuidor\"\n                        },\n                \"internalContacts\" : [\n                    {\n                    \"id\" : 1,\n                    \"name\" : \"Andrea\",\n                    \"lastName\" : \"Restrepo\",\n                    \"email\" : \"prueba3@alegra.com\",\n                    \"phone\" : \"999-99-99 ext 105\",\n                    \"mobile\" : \"\",\n                    \"sendNotifications\" : \"yes\"\n                \n                    }\n                ]\n            },\n              {\n                \"id\": 2,\n                \"name\": \"Acrecer\",\n                \"identification\": \"963.654.988\",\n                \"email\": \"prueba2@alegra.com\",\n                \"phonePrimary\": \"111 11 11\",\n                \"phoneSecondary\" : \"\",\n                \"fax\": \"\",\n                \"mobile\": \"(333) 555-55-55\",\n                \"observations\": \"\",\n                \"type\" : [\"client\"],\n                \"seller\": {\n                        \"id\" : \"52\",\n                        \"name\" : \"Carmen López\",\n                        \"identification\" : \"\",\n                        \"observations\" : \"\"\n                        },\n                \"term\" : {\n                            \"id\" : 1,\n                            \"name\" : \"30 días\",\n                            \"days\" : 30\n                        },\n                \"address\" : {\n                    \"address\" : \"Avenida Madison\",\n                    \"city\" : \"New York, USA\"\n                    },\n                \"internalContacts\" : [\n                            {\n                                \"id\" : 9,\n                                \"name\" : \"Lina\",\n                                \"lastName\" : \"Montoya\",\n                                \"email\" : \"prueba4@alegra.com\",\n                                \"phone\" : \"123 45 67 ext 25\",\n                                \"mobile\" : \"(333) 333 33 33\",\n                                \"sendNotifications\" : \"no\"\n                            \n                            }\n                    ],\n                \"priceList\" : null\n                }\n            ]","status":200},{"code":"{ \n\t\"error\": \"El límite de contactos para retornar debe ser menor o igual a 30\",\n\t\"code\" : 903\n}","language":"text","status":400,"name":"Bad Request - Límite sobrepasa máximo permitido"},{"name":"Consulta exitosa con metadatos","status":200,"language":"json","code":"{\n  \"metadata\": {\n  \t\"total\": 45\n  },\n  \"data\": [\n             {\n                \"id\": 1,\n                \"name\": \"Coorporación Alegrate\",\n                \"identification\": \"159.549.847\",\n                \"email\": \"prueba@alegra.com\",\n                \"phonePrimary\": \"999-99-99\",\n                \"phoneSecondary\": \"\",\n                \"fax\": \"\",\n                \"mobile\": \"(333) 555-55-55\",\n                \"observations\": \"\",\n                \"type\" : [\"client\", \"provider\"],\n                \"address\" : {\n                        \"address\" : \"Calle principal #45\",\n                        \"city\" : \"Barcelona\"\n                },\n                \"seller\": {\n                        \"id\" : \"12\",\n                        \"name\" : \"Diana Giraldo\",\n                        \"identification\" : \"520.526.21\",\n                        \"observations\" : \"Líder de Ventas\"\n                        },\n                \"term\" : \n                        {\n                            \"id\" : 1,\n                            \"name\" : \"8 días\",\n                            \"days\" : 8\n                        },\n                \"priceList\" : {\n                        \"id\" : 5,\n                        \"name\" : \"Distribuidor\"\n                        },\n                \"internalContacts\" : [\n                    {\n                    \"id\" : 1,\n                    \"name\" : \"Andrea\",\n                    \"lastName\" : \"Restrepo\",\n                    \"email\" : \"prueba3@alegra.com\",\n                    \"phone\" : \"999-99-99 ext 105\",\n                    \"mobile\" : \"\",\n                    \"sendNotifications\" : \"yes\"\n                \n                    }\n                ]\n            },\n              {\n                \"id\": 2,\n                \"name\": \"Acrecer\",\n                \"identification\": \"963.654.988\",\n                \"email\": \"prueba2@alegra.com\",\n                \"phonePrimary\": \"111 11 11\",\n                \"phoneSecondary\" : \"\",\n                \"fax\": \"\",\n                \"mobile\": \"(333) 555-55-55\",\n                \"observations\": \"\",\n                \"type\" : [\"client\"],\n                \"seller\": {\n                        \"id\" : \"52\",\n                        \"name\" : \"Carmen López\",\n                        \"identification\" : \"\",\n                        \"observations\" : \"\"\n                        },\n                \"term\" : {\n                            \"id\" : 1,\n                            \"name\" : \"30 días\",\n                            \"days\" : 30\n                        },\n                \"address\" : {\n                    \"address\" : \"Avenida Madison\",\n                    \"city\" : \"New York, USA\"\n                    },\n                \"internalContacts\" : [\n                            {\n                                \"id\" : 9,\n                                \"name\" : \"Lina\",\n                                \"lastName\" : \"Montoya\",\n                                \"email\" : \"prueba4@alegra.com\",\n                                \"phone\" : \"123 45 67 ext 25\",\n                                \"mobile\" : \"(333) 333 33 33\",\n                                \"sendNotifications\" : \"no\"\n                            \n                            }\n                    ],\n                \"priceList\" : null\n                }\n            ]\n}"}]},"settings":"","examples":{"codes":[{"code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET  https://app.alegra.com/api/v1/contacts/ -u 'usuario@alegra.co:mitoken'","language":"curl"}]},"method":"get","auth":"required","params":[{"_id":"56afd9393c70b01700facf25","ref":"","in":"query","required":false,"desc":"Desde cual contacto se quiere consultar. Por ejemplo para consultar desde el contacto 20, se envía start=20.","default":"0","type":"int","name":"start"},{"_id":"56b0b7da36d2580d002477d7","ref":"","in":"query","required":false,"desc":"Cantidad de contactos a partir del inicio que se desea retornar.  Por defecto retorna 30 contactos. Si este valor es mayor que 30, la aplicación retorna error.","default":"30","type":"int","name":"limit"},{"_id":"56b0b7da36d2580d002477d6","ref":"","in":"query","required":false,"desc":"Orden ascendente o descendente en el cual se quieren retornar los contactos.  Opciones disponibles son DESC o ASC.  Por defecto es ASC (ascendente).","default":"ASC","type":"string","name":"order_direction"},{"_id":"56b0b7da36d2580d002477d5","ref":"","in":"query","required":false,"desc":"Campo por el cual se desea ordenar, las opciones posibles son id, name, identification, email.","default":"name","type":"string","name":"order_field"},{"_id":"56b0b7da36d2580d002477d4","ref":"","in":"query","required":false,"desc":"Cadena de texto que se quiere utilizar para buscar los contactos que en el nombre o en la identificación contienen dicho texto.","default":"","type":"string","name":"query"},{"_id":"56b10e196d004b1700806670","ref":"","in":"query","required":false,"desc":"Filtrar por clientes o proveedores, para filtrar por clientes se debe enviar  'client', para filtrar por proveedores 'provider'.","default":"","type":"string","name":"type"},{"_id":"56fae6fe19b2b80e004999a4","ref":"","in":"query","required":false,"desc":"Incluir en los resultados metadatos. Se debe tener en cuenta que si se envía este parámetro el objeto que retorna la aplicación incluye un atributo \"metadata\" y otro otro atributo \"data\" en donde se envían los contactos. Actualmente la información que se envía en metadata incluye el total de contactos que tiene registrada la empresa.","default":"","type":"boolean","name":"metadata"},{"_id":"5a01e357486b6a002823a1eb","ref":"","in":"query","required":false,"desc":"Filtrar resultados según el nombre del contacto. Se retornarán todos los contactos que en su nombre contenga el valor enviado en este parámetro.","default":"","type":"string","name":"name"},{"_id":"5a01e357486b6a002823a1ea","ref":"","in":"query","required":false,"desc":"Filtrar resultados según la identificación del contacto. Se retornarán todos los contactos que en su identificación contenga el valor enviado en este parámetro.","default":"","type":"string","name":"identification"}],"url":"/contacts/"},"isReference":true,"order":2,"body":"Endpoint que retorna los contactos registrados en la cuenta de Alegra.  Si no se envía límite de contactos, por defecto se envían 30 contactos.  \n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Atención\",\n  \"body\": \"Se debe tener en cuenta que el valor máximo para el atributo limit es 30, si se supera ese valor la aplicación retorna el código de error:\\n```\\n{\\n  \\\"code\\\": 903,\\n  \\\"message\\\" : \\\"El límite debe ser menor o igual a 30\\\"\\n}\\n```\"\n}\n[/block]","excerpt":"Endpoint que permite consultar los contactos registrados en la aplicación","slug":"lista-de-contactos","type":"endpoint","title":"Lista de contactos"}