Get all conversations from a channel (getConversations)

GET {{baseUrl}}/channels/:providerChannelId/conversations?conversations_limit=30&messages_limit=30&after=<string>

Endpoint is used to sync an initial batch of conversations and their messages and participant. It is called right after a channel is registered in the Channels API using the POST /channels endpoint in the Pipedrive API.

Request Params

KeyDatatypeRequiredDescription
conversations_limitnumberThe maximum number of conversations expected in the response. It's recommended to use this default value and support pagination, for better performance
messages_limitnumberThe maximum number of messages expected for each conversation in the response. It's recommended to use this default value and support pagination, for better performance
afterstringThe pointer used to fetch more conversations

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{&quot;success&quot;:true,&quot;data&quot;:[{&quot;id&quot;:&quot;cillum&quot;,&quot;link&quot;:&quot;magna dolore qui aliqua irure&quot;,&quot;status&quot;:&quot;open&quot;,&quot;seen&quot;:false,&quot;next_messages_cursor&quot;:&quot;culpa sit sint&quot;,&quot;messages&quot;:[{&quot;id&quot;:&quot;est ex sint&quot;,&quot;status&quot;:&quot;delivered&quot;,&quot;created_at&quot;:&quot;2004-08-19T19:00:38.791Z&quot;,&quot;message&quot;:&quot;proident mollit eu ut&quot;,&quot;sender_id&quot;:&quot;ut nulla sint&quot;,&quot;reply_by&quot;:&quot;2014-09-30T03:55:13.302Z&quot;,&quot;attachments&quot;:[{&quot;id&quot;:&quot;magna esse&quot;,&quot;type&quot;:&quot;laborum anim&quot;,&quot;url&quot;:&quot;non id veniam laboris&quot;,&quot;name&quot;:&quot;reprehenderit sit tempor eiusmod labore&quot;,&quot;size&quot;:-7016019.936842218,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;in irure deserunt esse&quot;},{&quot;id&quot;:&quot;eu ullamco veniam pariatur&quot;,&quot;type&quot;:&quot;commodo do dolore&quot;,&quot;url&quot;:&quot;labore cillum Lorem&quot;,&quot;name&quot;:&quot;in aliquip&quot;,&quot;size&quot;:-82338344.83431263,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;eu&quot;}]},{&quot;id&quot;:&quot;culpa in et mollit&quot;,&quot;status&quot;:&quot;read&quot;,&quot;created_at&quot;:&quot;2002-09-15T09:16:24.889Z&quot;,&quot;message&quot;:&quot;incididunt ex laboris cupidatat&quot;,&quot;sender_id&quot;:&quot;sunt nulla laboris aute et&quot;,&quot;reply_by&quot;:&quot;1957-06-10T13:30:35.990Z&quot;,&quot;attachments&quot;:[{&quot;id&quot;:&quot;velit enim dolor laboris&quot;,&quot;type&quot;:&quot;nulla dolor sunt elit&quot;,&quot;url&quot;:&quot;eiusmod quis ad ex&quot;,&quot;name&quot;:&quot;cupidatat&quot;,&quot;size&quot;:8178901.289163947,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;dolore et&quot;},{&quot;id&quot;:&quot;eu do&quot;,&quot;type&quot;:&quot;mollit Ut ex velit&quot;,&quot;url&quot;:&quot;cupidatat occaecat pariatur&quot;,&quot;name&quot;:&quot;ea minim eiusmod commodo&quot;,&quot;size&quot;:35999121.78892884,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;veniam non dolore&quot;}]}],&quot;participants&quot;:[{&quot;id&quot;:&quot;in&quot;,&quot;name&quot;:&quot;ut et&quot;,&quot;role&quot;:&quot;source_user&quot;,&quot;avatar_url&quot;:&quot;reprehenderit amet pariatur&quot;,&quot;fetch_avatar&quot;:false,&quot;avatar_expires&quot;:false},{&quot;id&quot;:&quot;anim enim sint deserunt cillum&quot;,&quot;name&quot;:&quot;id tempor in&quot;,&quot;role&quot;:&quot;end_user&quot;,&quot;avatar_url&quot;:&quot;ea cupidatat deserunt Duis&quot;,&quot;fetch_avatar&quot;:false,&quot;avatar_expires&quot;:false}]},{&quot;id&quot;:&quot;Lorem ad&quot;,&quot;link&quot;:&quot;labore ut anim&quot;,&quot;status&quot;:&quot;closed&quot;,&quot;seen&quot;:true,&quot;next_messages_cursor&quot;:&quot;ipsum Duis ut incididunt&quot;,&quot;messages&quot;:[{&quot;id&quot;:&quot;occaecat laboris&quot;,&quot;status&quot;:&quot;sent&quot;,&quot;created_at&quot;:&quot;1988-01-02T18:28:38.494Z&quot;,&quot;message&quot;:&quot;Excepteur id ut&quot;,&quot;sender_id&quot;:&quot;cupidatat Ut&quot;,&quot;reply_by&quot;:&quot;1996-02-02T22:34:07.679Z&quot;,&quot;attachments&quot;:[{&quot;id&quot;:&quot;ad irure esse est&quot;,&quot;type&quot;:&quot;labore id est&quot;,&quot;url&quot;:&quot;officia in nostrud&quot;,&quot;name&quot;:&quot;laboris tempor nostrud&quot;,&quot;size&quot;:-71713015.0712476,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;aliqua in&quot;},{&quot;id&quot;:&quot;reprehenderit deserunt ut ad&quot;,&quot;type&quot;:&quot;in non&quot;,&quot;url&quot;:&quot;cupidatat elit&quot;,&quot;name&quot;:&quot;aliquip qui tempor eiusmod&quot;,&quot;size&quot;:-12001091.475489378,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;ad occaecat laboris consequat&quot;}]},{&quot;id&quot;:&quot;adipisicing id esse elit magna&quot;,&quot;status&quot;:&quot;sent&quot;,&quot;created_at&quot;:&quot;1963-07-15T02:37:28.817Z&quot;,&quot;message&quot;:&quot;cillum sint reprehenderit dolore&quot;,&quot;sender_id&quot;:&quot;in Lorem veniam fugiat&quot;,&quot;reply_by&quot;:&quot;1962-10-12T05:06:59.398Z&quot;,&quot;attachments&quot;:[{&quot;id&quot;:&quot;dolor reprehenderit&quot;,&quot;type&quot;:&quot;sunt dolore ea voluptate&quot;,&quot;url&quot;:&quot;esse aliqua reprehenderit exercitation ex&quot;,&quot;name&quot;:&quot;ipsum anim aute cupidatat&quot;,&quot;size&quot;:62047230.79487881,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;sit in voluptate incididunt&quot;},{&quot;id&quot;:&quot;qui reprehenderit&quot;,&quot;type&quot;:&quot;et Excepteur dolor ipsum aute&quot;,&quot;url&quot;:&quot;Duis fugiat ad veniam&quot;,&quot;name&quot;:&quot;et&quot;,&quot;size&quot;:-98168674.08877723,&quot;link_expires&quot;:false,&quot;preview_url&quot;:&quot;ipsum Excepteur ad dolore&quot;}]}],&quot;participants&quot;:[{&quot;id&quot;:&quot;nulla veniam Lorem qui exercitation&quot;,&quot;name&quot;:&quot;dolor minim commodo&quot;,&quot;role&quot;:&quot;end_user&quot;,&quot;avatar_url&quot;:&quot;cillum in laboris sit&quot;,&quot;fetch_avatar&quot;:false,&quot;avatar_expires&quot;:false},{&quot;id&quot;:&quot;dolore esse&quot;,&quot;name&quot;:&quot;exercitation cupidatat ul&quot;,&quot;role&quot;:&quot;end_user&quot;,&quot;avatar_url&quot;:&quot;id&quot;,&quot;fetch_avatar&quot;:false,&quot;avatar_expires&quot;:false}]}],&quot;additional_data&quot;:{&quot;after&quot;:&quot;&quot;}}