{"_id":"55aa86cc3be8f60d00041d58","editedParams":true,"githubsync":"","__v":25,"category":{"_id":"55aacfca3be8f60d00041d8a","version":"55aa7d983be8f60d00041d45","__v":17,"pages":["55b78741568be2230092ba73","55b79032568be2230092ba91","55b79144568be2230092ba94","55b79738aea7c8190058b972","55b7aa36aea7c8190058b9bf","55b7e64b568be2230092bbe9","55b7e66a31bccb190081c0fa","55b8f2a7146ef121002157c7","55b8f3b28fd1a02b00f4958c","55b8f4378fd1a02b00f4959f","55b91058146ef1210021583f","55b928c3146ef1210021589c","55b9290f8fd1a02b00f49694","55bbe8b7b72bad0d00c0d5dd","56548c8e9c4c6d0d00aeda0f","5654a2a9892a0d2b00cedc0c","5654a46e0af52835008e77a2"],"project":"55aa7d973be8f60d00041d42","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-07-18T22:14:34.596Z","from_sync":false,"order":7,"slug":"contacts","title":"Contacts"},"user":"55aa7d625d3abb0d0012f3da","editedParams2":true,"parentDoc":null,"project":"55aa7d973be8f60d00041d42","version":{"_id":"55aa7d983be8f60d00041d45","__v":20,"project":"55aa7d973be8f60d00041d42","createdAt":"2015-07-18T16:23:52.273Z","releaseDate":"2015-07-18T16:23:52.273Z","categories":["55aa7d983be8f60d00041d46","55aacf4e3be8f60d00041d89","55aacfaae2bdcb0d00c7466e","55aacfb3e2bdcb0d00c7466f","55aacfca3be8f60d00041d8a","55b67da3f8105a2f00c351ab","55b7cae4aea7c8190058ba5b","55b9218afeef5135009b7db3","55c182616d7d2921006da013","5631407afa40240d007c8c60","56548b9c9c4c6d0d00aeda0c","572b9137ff3ba10e00b4abb4","572b9150ff3ba10e00b4abb5","581b83288ca41f0f007e4fb6","585065fa70cbe00f00835bb8","58641eba0355f31900380492","58861760b4816e19005c9941","58a316cb254c401b00a049ce","58ac80dbd5e1570f00d1c328","59f72b4991121a00104f036e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-07-18T17:03:08.339Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"curl","name":"cURL api_key","code":"curl \"https://api.cliengo.com/1.0/contacts?api_key={your_api_key}\""},{"code":"curl \"https://api.cliengo.com/1.0/contacts\" -H \"authorization:{jwt}\"","language":"curl","name":"cURL JWT"}]},"method":"get","results":{"codes":[{"status":200,"name":"","code":"{\n  paging: {\n    limit: 50,\n    total: 2,\n    offset: 0\n\t},\n  results: [\n    {\n      id: \"5c07d268e4b04608058f653c\",\n      accountId: \"560596e8e440153ae0337b1d\",\n      websiteId: \"56152273e4b49dd3a41b4b01\",\n      status: \"new\",\n      name: \"Norma\",\n      email: \"norma:::at:::gmail.com\",\n      phone: \"0362 427-3574\",\n      internationalPhoneNumber: \"+543624273574\",\n      whatsappPhoneNumber: \"543624273574\",\n      creationDate: \"2018-11-05T13:28:08.058Z\",\n      lastUpdateDate: \"2018-11-05T13:28:52+0000\",\n      lastName: \"\",\n      age: 0,\n      ip: \"186.111.157.108\",\n      referalUrl: \"android-app://com.google.android.gm\",\n      landingUrl: \"android-app://com.google.android.gm\",\n      conversionUrl: \"https://landing.test.com.ar?utm_source=newsletter&utm_medium=email\",\n      message: \"cliente: hola, quiero comprar un robot asesor: será un placer ayudarte, cuál es tu nombre? cliente: Norma asesor: Norma yo me encargo de ponerte en contacto con un asesor para que responda tu consulta asesor: podrás dejarme tu email y teléfono con código de área? cliente: Mi telefono es 3624273574 asesor: te puedo pedir además tu email? norma@gmail.com asesor: perfecto! asesor: con la información que me pasaste un asesor te contactará a la brevedad.\",\n      assignedTo: {\n        name: \"Marta Perez\",\n        email: \"marta@test.com.ar\",\n        creationDate: \"2017-09-05T12:57:43+0000\",\n        userId: \"59ae9ff3e4b0b259bc36afe6\",\n        phone: \"\"\n      },\n      geoip: {\n        latitude: \"-27.4667\",\n        longitude: \"-58.8333\",\n        country: \"AR\",\n        state: \"Corrientes\",\n        city: \"Corrientes\",\n        zipCode: \"3400\"\n      },\n      duplicatedContact: false,\n      notes: [ ],\n      medium: \"Desconocido\",\n      source: \"newsletter\",\n      mediumTranslate: \"Desconocido\",\n      sourceTranslate: \"newsletter\",\n      customParams: {\n        ldkCompanyId: \"560596e8e440153ae0337b1d\",\n        ldkWebsiteId: \"56152273e4b49dd3a41b4b01\",\n        conversationId: \"5c07d05ce4b042ff7791ff83\",\n        channel: \"CHATBOT\",\n      },\n      rating: 5,\n      conversationId: \"5a07d06ce4b032ff7791ff82\",\n      utmSource: \"newsletter\",\n      utmMedium: \"Desconocido\",\n      utmCampaign: \"Desconocido\",\n      utmContent: \"Desconocido\",\n      utmTerm: \"Desconocido\",\n      accountName: \"Company Test\",\n      websiteName: \"Website Test\"\n    },\n    {\n      id: \"55b7d5700364dfc80124b69d\",\n      status: \"new\",\n      name: \"Pablo Picaso\",\n      email: \"pablo@picaso.com\",\n      phone: \"4758948575\",\n      creationDate: \"2015-07-28T16:18:08.215-03:00\",\n      ip: \"171.24.4.55\",\n      conversionUrl: \"referer\",\n      landingUrl: \"refererTracking\",\n      message: \"mensaje nuevo\"\n    }\n  ]\n}","language":"json"}]},"settings":"","auth":"required","params":[{"_id":"55bb984ca8400c2d00873eb0","ref":"","in":"query","required":false,"desc":"find this query String within fields name, email and phone.","default":"","type":"string","name":"query"},{"_id":"55bb984ca8400c2d00873eaf","ref":"","in":"query","required":false,"desc":"The user's ID who the contact is assigned","default":"","type":"string","name":"assignedTo"},{"_id":"55bb984ca8400c2d00873eae","ref":"","in":"query","required":false,"desc":"filter contacts received in this websiteId","default":"","type":"string","name":"websiteId"},{"_id":"55bb984ca8400c2d00873ead","ref":"","in":"query","required":false,"desc":"the contact status. Posible values are: new, active, long_term and client","default":"","type":"string","name":"status"},{"_id":"5720f9d12ef7950e00fe6f80","ref":"","in":"query","required":false,"desc":"filter date since","default":"","type":"yyyy-mm-dd","name":"since"},{"_id":"5720f9d12ef7950e00fe6f7f","ref":"","in":"query","required":false,"desc":"filter date until","default":"","type":"yyyy-mm-dd","name":"until"},{"_id":"5bb50827f4c98f000355d42e","ref":"","in":"query","required":false,"desc":"filter since last update","default":"","type":"yyyy-mm-dd","name":"lastUpdateDate"},{"_id":"55bb984ca8400c2d00873eac","ref":"","in":"query","required":false,"desc":"you can move the lower limit of the result block (Default is 0)","default":"","type":"string","name":"offset"},{"_id":"55bb984ca8400c2d00873eab","ref":"","in":"query","required":false,"desc":"To reduce the page size you can change the limit parameter (Default is 25)","default":"","type":"string","name":"limit"}],"url":"/contacts"},"isReference":false,"order":0,"body":"You can retrieve all Contacts you have in Cliengo CRM.","excerpt":"Get all contacts","slug":"contacts-get","type":"endpoint","title":"/contacts"}

get/contacts

Get all contacts

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

query:
string
find this query String within fields name, email and phone.
assignedTo:
string
The user's ID who the contact is assigned
websiteId:
string
filter contacts received in this websiteId
status:
string
the contact status. Posible values are: new, active, long_term and client
since:
yyyy-mm-dd
filter date since
until:
yyyy-mm-dd
filter date until
lastUpdateDate:
yyyy-mm-dd
filter since last update
offset:
string
you can move the lower limit of the result block (Default is 0)
limit:
string
To reduce the page size you can change the limit parameter (Default is 25)

Examples


Result Format


Documentation

You can retrieve all Contacts you have in Cliengo CRM.

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