{"_id":"56548c8e9c4c6d0d00aeda0f","editedParams2":true,"parentDoc":null,"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"},"__v":2,"project":"55aa7d973be8f60d00041d42","category":{"_id":"56548b9c9c4c6d0d00aeda0c","version":"55aa7d983be8f60d00041d45","pages":["565493dc11032117008a1e20","5655d211648fc80d00bd0afa","565c68bcea82b00d00f949c0","566a38991766bf0d00e737c8"],"project":"55aa7d973be8f60d00041d42","__v":4,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-24T16:09:00.420Z","from_sync":false,"order":9,"slug":"conversations-in-development","title":"Conversations (In Development)"},"editedParams":true,"githubsync":"","user":"55aa7d625d3abb0d0012f3da","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-24T16:13:02.844Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"name":"","code":"curl \"https://api.cliengo.com/1.0/conversations?api_key={your_api_key}\"","language":"curl"}]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"[{\n  id: \"55b7d5700364dfc80124b69d\",\n  lastMessage: \"Sí, dale!\",\n  creationDate: \"2015-07-28T16:18:08.215-03:00\",\n  participants : [\n    {\n      id: \"userId_1\",\n     \ttype:\"user\"\n    },\n    {\n      id: \"robotID\",\n     \ttype:\"robot\"\n    },\n    {\n      id: \"0.31676287087611854:::at:::leadaki-chats.com\",\n     \ttype:\"visitor\"\n    }\n  ],\n  contactId: \"55dfasdf3452364237235\", //se crea cuando el visitante deja sus datos\n  websiteId: \"3452346a8ns8hn1864224\",\n  totalUnreadMessages: 0,\n},\n{\n  id: \"55b7d5700343523623134\",\n  lastMessage: \"No, dale!\",\n  creationDate: \"2015-07-28T16:18:08.215-03:00\",\n  participants : [\n    {\n      id: \"userId_1\",\n     \ttype:\"user\"\n    },\n    {\n      id: \"robotID\",\n     \ttype:\"robot\"\n    },\n    {\n      id: \"0.31676287087611854@leadaki-chats.com\",\n     \ttype:\"visitor\"\n    }\n  ],\n  contactId: \"55dfasdf87Y7dtastasd\", //se crea cuando el visitante deja sus datos\n  websiteId: \"128123asha8ns8hn18\",\n  totalUnreadMessages: 0,\n}]","name":""}]},"settings":"","auth":"required","params":[{"_id":"55bb984ca8400c2d00873eae","ref":"","in":"query","required":false,"desc":"Filter conversations received in this websiteId","default":"","type":"string","name":"websiteId"},{"_id":"55bb984ca8400c2d00873ead","ref":"","in":"query","required":false,"desc":"The conversations status. Posible values are: new, active, long_term and client","default":"","type":"string","name":"status"},{"_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":"/conversations"},"isReference":false,"order":0,"body":"You can retrieve all Conversations you have in Cliengo CRM.","excerpt":"Get all conversations","slug":"conversations","type":"endpoint","title":"/conversations"}

get/conversations

Get all conversations

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

websiteId:
string
Filter conversations received in this websiteId
status:
string
The conversations status. Posible values are: new, active, long_term and client
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 Conversations 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 }}