{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/contacts/:id","auth":"required","examples":{"codes":[{"code":"curl -v -H \"Accept: application/json\" -H \"Content-type: application/json\" -X GET  https://api.alegra.com/api/v1/contacts/74 -u 'usuario:::at:::alegra.com:mitoken' ","language":"curl"}]},"method":"get","params":[{"name":"id","type":"int","default":"","desc":"Id del contacto que se desea consultar.","required":true,"in":"path","ref":"","_id":"56afd9393c70b01700facf25"},{"name":"url","type":"string","default":"","desc":"Para obtener la url de los archivos adjuntos del contacto se debe enviar el valor `url` en el parámetro `fields`. Ejemplo: `/contacts/1?fields=url`.","required":false,"in":"query","ref":"","_id":"5f2046fa44dbc9037b6ccfd9"},{"name":"statementLink","type":"string","default":"","desc":"Al enviar `statementLink` en el parámetro `fields` se retorna el link para consultar el estado de cuenta del cliente. Ejemplo: `/contacts/1?fields=statementLink`.","required":false,"in":"query","ref":"","_id":"5f6e5023fb52f40047e2e2a9"}],"results":{"codes":[{"name":"Ejemplo consulta exitosa","language":"json","code":"{\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\" : 560,\n                        \"observations\" : 320\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\" : true\n                \n                    }\n                ]\n            }","status":200},{"code":"{ \n\t\"error\": \"No se encontró en la aplicación el contacto que se está buscando\" ,\n  \"code\" : 404\n}","language":"json","status":404},{"code":"{\n  \t\t\t\t\t\t\t\"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\t\t\t\t\t\t\t\t\"cfdiUse\": \"D03\",\n\t\t\t\t\t\t\t  \"paymentType\": \"PUE\",\n\t\t\t\t\t\t    \"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                        {\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}","language":"json","name":"Ejemplo consulta exitosa México","status":200},{"name":"Ejemplo Argentina","status":200,"language":"json","code":"{\n    \"id\": \"1\",\n    \"name\": \"Carlos Perez\",\n    \"identification\": \"2211231\",\n    \"email\": \"[email protected]\",\n    \"phonePrimary\": \"3134213411\",\n    \"phoneSecondary\": \"\",\n    \"fax\": \"\",\n    \"mobile\": \"\",\n    \"observations\": \"\",\n    \"ivaCondition\": \"IVA_RESPONSABLE_NO_INSCRIPT\",\n    \"address\": {\n        \"province\": \"Ciudad Autónoma de Buenos Aires\",\n        \"city\": \"Ciudad autónoma de buenos aires\",\n        \"address\": \"Avenida 38 # 76-32\",\n        \"postalCode\": \"122211\"\n    },\n    \"type\": [\n        \"client\"\n    ],\n    \"seller\": null,\n    \"term\": {\n        \"id\": \"1\",\n        \"name\": \"De contado\",\n        \"days\": \"0\"\n    },\n    \"priceList\": null,\n    \"internalContacts\": []\n}"}]},"settings":""},"next":{"description":"","pages":[]},"title":"Consultar un contacto","type":"endpoint","slug":"consultar-un-contacto","excerpt":"Endpoint que permite consultar un contacto registrado en la aplicación","body":"Endpoint que retorna el contacto registrado en la cuenta de Alegra que está identificado con el id que se envía como parámetro.","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"56b10d3f6d004b170080666c","__v":17,"editedParams":true,"createdAt":"2016-02-02T20:10:39.841Z","project":"56abd2434e4b730d009eb10a","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"},"githubsync":"","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","5e9f0d4c720ad8006c6c7dc1","5ea9c2f382fcd2003df9f412","5ec7defc6aa2be001e7504f5","5ed8f716a8308c0412b5473a","5ed9274fe5a9b8041fd1df43","5ed92afa0d09d60253220b3f","5efcff9cd7e1be00118e8272","5f172282d7522c03be08713f","5f3c4814ac3e6209c38b7615","5f4fbe7281626c006887f104","5f5242887d2f8701ff580d22"],"_id":"56abd2434e4b730d009eb10d","project":"56abd2434e4b730d009eb10a","releaseDate":"2016-01-29T20:57:39.712Z","__v":43,"createdAt":"2016-01-29T20:57:39.712Z"},"user":"56abd213d4432d1900eed227","editedParams2":true,"parentDoc":null}

getConsultar un contacto

Endpoint que permite consultar un contacto registrado en la aplicación

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Id del contacto que se desea consultar.

Query Params

url:
string
Para obtener la url de los archivos adjuntos del contacto se debe enviar el valor `url` en el parámetro `fields`. Ejemplo: `/contacts/1?fields=url`.
statementLink:
string
Al enviar `statementLink` en el parámetro `fields` se retorna el link para consultar el estado de cuenta del cliente. Ejemplo: `/contacts/1?fields=statementLink`.

Examples


Result Format


Documentation

Endpoint que retorna el contacto registrado en la cuenta de Alegra que está identificado con el id que se envía como parámetro.

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