{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/contacts/","auth":"required","results":{"codes":[{"status":200,"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\" : \"[email protected]\",\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\": \"[email protected]\",\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\" : \"[email protected]\",\n \"phone\" : \"123 45 67 ext 25\",\n \"mobile\" : \"(333) 333 33 33\",\n \"sendNotifications\" : \"no\"\n \n }\n ],\n \"priceList\" : null\n }\n ]","language":"json","name":"Ejemplo consulta exitosa"},{"name":"Bad Request - Límite sobrepasa máximo permitido","status":400,"language":"text","code":"{ \n\t\"error\": \"El límite de contactos para retornar debe ser menor o igual a 30\",\n\t\"code\" : 903\n}"},{"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\": \"[email protected]\",\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\" : \"[email protected]\",\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\": \"[email protected]\",\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\" : \"[email protected]\",\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}","language":"json","status":200,"name":"Consulta exitosa con metadatos"},{"name":"Ejemplo consulta exitosa México","status":200,"language":"json","code":"[\t\n {\n \"id\": 1,\n \"name\": \"Coorporación Alegrate\",\n \"identification\": \"159.549.847\",\n \"email\": \"[email protected]\",\n \"phonePrimary\": \"999-99-99\",\n \"phoneSecondary\": \"\",\n \"fax\": \"\",\n \"mobile\": \"(333) 555-55-55\",\n \"observations\": \"\",\n \"type\" : [\"client\", \"provider\"],\n \"cfdiUse\": \"D03\",\n \"paymentType\": \"PUE\",\n \"paymentMethod\": \"credit-card\",\n \"address\" : {\n \"address\" : \"Calle principal #45\",\n \"city\" : \"Barcelona\"\n },\n \"seller\": {\n \"id\" : \"12\",\n \"name\" : \"Diana Giraldo\",\n \"identification\" : 560,\n \"observations\" : 320\n },\n \"term\" : {\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\" : \"[email protected]\",\n \"phone\" : \"999-99-99 ext 105\",\n \"mobile\" : \"\",\n \"sendNotifications\" : true\n }\n ]\n },\n {\n \"id\": 2,\n \"name\": \"Acrecer\",\n \"identification\": \"963.654.988\",\n \"email\": \"[email protected]\",\n \"phonePrimary\": \"111 11 11\",\n \"phoneSecondary\" : \"\",\n \"fax\": \"\",\n \"mobile\": \"(333) 555-55-55\",\n \"observations\": \"\",\n \"type\" : [\"client\"],\n \"cfdiUse\": \"D03\",\n \"paymentType\": \"PPD\",\n \"paymentMethod\": \"other\",\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\" : \"[email protected]\",\n \"phone\" : \"123 45 67 ext 25\",\n \"mobile\" : \"(333) 333 33 33\",\n \"sendNotifications\" : \"no\"\n\n }\n ],\n \"priceList\" : null\n }\n]"},{"code":"[\n {\n \"id\": \"19\",\n \"name\": \"Camilo Perez\",\n \"identification\": \"40012947\",\n \"email\": \"[email protected]\",\n \"phonePrimary\": null,\n \"phoneSecondary\": null,\n \"fax\": null,\n \"mobile\": null,\n \"observations\": null,\n \"ivaCondition\": \"IVA_RESPONSABLE\",\n \"address\": {\n \"province\": \"Ciudad Autónoma de Buenos Aires\",\n \"city\": \"Ciudad autónoma de buenos aires\",\n \"address\": \"Diagonal 38\",\n \"postalCode\": \"12111313\"\n },\n \"type\": [],\n \"seller\": null,\n \"term\": null,\n \"priceList\": null,\n \"internalContacts\": []\n },\n {\n \"id\": \"21\",\n \"name\": \"Carlos Martinez\",\n \"identification\": \"21123113\",\n \"email\": \"[email protected]\",\n \"phonePrimary\": null,\n \"phoneSecondary\": null,\n \"fax\": null,\n \"mobile\": null,\n \"observations\": null,\n \"ivaCondition\": \"IVA_RESPONSABLE\",\n \"address\": {\n \"province\": \"Ciudad Autónoma de Buenos Aires\",\n \"city\": \"Ciudad autónoma de buenos aires\",\n \"address\": \"Calle 5a\",\n \"postalCode\": \"12111313\"\n },\n \"type\": [],\n \"seller\": null,\n \"term\": null,\n \"priceList\": null,\n \"internalContacts\": []\n },\n {\n \"id\": \"22\",\n \"name\": \"Pedro Camargo\",\n \"identification\": \"32114114\",\n \"email\": \"[email protected]\",\n \"phonePrimary\": null,\n \"phoneSecondary\": null,\n \"fax\": null,\n \"mobile\": null,\n \"observations\": null,\n \"ivaCondition\": \"IVA_RESPONSABLE\",\n \"address\": {\n \"province\": \"Ciudad Autónoma de Buenos Aires\",\n \"city\": \"Ciudad autónoma de buenos aires\",\n \"address\": \"Carrera 13 # 18-40\",\n \"postalCode\": \"12111313\"\n },\n \"type\": [],\n \"seller\": null,\n \"term\": null,\n \"priceList\": null,\n \"internalContacts\": []\n }\n]","language":"json","status":200,"name":"Ejemplo Argentina"}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET https://api.alegra.com/api/v1/contacts/ -u '[email protected]:mitoken'"}]},"method":"get","params":[{"name":"start","type":"int","default":"0","desc":"Desde cual contacto se quiere consultar. Por ejemplo para consultar desde el contacto 20, se envía start=20.","required":false,"in":"query","ref":"","_id":"56afd9393c70b01700facf25"},{"name":"limit","type":"int","default":"30","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.","required":false,"in":"query","ref":"","_id":"56b0b7da36d2580d002477d7"},{"name":"order_direction","type":"string","default":"ASC","desc":"Orden ascendente o descendente en el cual se quieren retornar los contactos. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).","required":false,"in":"query","ref":"","_id":"56b0b7da36d2580d002477d6"},{"name":"order_field","type":"string","default":"name","desc":"Campo por el cual se desea ordenar, las opciones posibles son id, name, identification, email.","required":false,"in":"query","ref":"","_id":"56b0b7da36d2580d002477d5"},{"name":"query","type":"string","default":"","desc":"Cadena de texto que se quiere utilizar para buscar los contactos que en el nombre o en la identificación contienen dicho texto.","required":false,"in":"query","ref":"","_id":"56b0b7da36d2580d002477d4"},{"name":"type","type":"string","default":"","desc":"Filtrar por clientes o proveedores, para filtrar por clientes se debe enviar 'client', para filtrar por proveedores 'provider'.","required":false,"in":"query","ref":"","_id":"56b10e196d004b1700806670"},{"name":"metadata","type":"boolean","default":"","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.","required":false,"in":"query","ref":"","_id":"56fae6fe19b2b80e004999a4"},{"name":"name","type":"string","default":"","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.","required":false,"in":"query","ref":"","_id":"5a01e357486b6a002823a1eb"},{"name":"identification","type":"string","default":"","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.","required":false,"in":"query","ref":"","_id":"5a01e357486b6a002823a1ea"}]},"next":{"description":"","pages":[]},"title":"Lista de contactos","type":"endpoint","slug":"lista-de-contactos","excerpt":"Endpoint que permite consultar los contactos registrados en la aplicación","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]","updates":[],"order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56b10e196d004b170080666f","user":"56abd213d4432d1900eed227","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"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","5d76e2018e0ce7006c82dbe1","5d9ca92eac34370012872d08","5d9f8149103b9f006c1421e0","5e3098aba5919200612d0c33","5e8ca028538a310018ccd2df"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":32,"createdAt":"2016-01-29T20:57:39.712Z"},"__v":12,"githubsync":"","parentDoc":null,"createdAt":"2016-02-02T20:14:17.774Z","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Contactos","slug":"contactos","order":2,"from_sync":false,"reference":true,"_id":"56b4b2faeed075230097d688","__v":0,"project":"56abd2434e4b730d009eb10a","version":"56abd2434e4b730d009eb10d","createdAt":"2016-02-05T14:34:34.496Z"},"editedParams":true,"editedParams2":true,"project":"56abd2434e4b730d009eb10a"}getLista de contactos
Endpoint que permite consultar los contactos registrados en la aplicación
Definition
{{ api_url }}{{ page_api_url }}
Parameters
Query Params
start:
integer0
Desde cual contacto se quiere consultar. Por ejemplo para consultar desde el contacto 20, se envía start=20.
limit:
integer30
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.
order_direction:
stringASC
Orden ascendente o descendente en el cual se quieren retornar los contactos. Opciones disponibles son DESC o ASC. Por defecto es ASC (ascendente).
order_field:
stringname
Campo por el cual se desea ordenar, las opciones posibles son id, name, identification, email.
query:
string
Cadena de texto que se quiere utilizar para buscar los contactos que en el nombre o en la identificación contienen dicho texto.
type:
string
Filtrar por clientes o proveedores, para filtrar por clientes se debe enviar 'client', para filtrar por proveedores 'provider'.
metadata:
boolean
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.
name:
string
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.
identification:
string
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.