v1

latestOpenAPI 3.0.02026-08-062420.2 KB

Returns a list of conversations.

get/v1/conversation_export

Query parameters

closed_afterstring date

Filter for conversations closed after this date. Format should be yyyy-mm-dd or Unix timestamp in ms

closed_beforestring date

Filter for conversations closed before this date. Format should be yyyy-mm-dd or Unix timestamp in ms

created_afterstring date

Filter for conversations created after this date. Format should be yyyy-mm-dd or Unix timestamp in ms

created_beforestring date

Filter for conversations created before this date. Format should be yyyy-mm-dd or Unix timestamp in ms

updated_afterstring date

Filter for conversations updated after this date. Format should be yyyy-mm-dd or Unix timestamp in ms

updated_beforestring date

Filter for conversations updated before this date. Format should be yyyy-mm-dd or Unix timestamp in ms

last_message_created_afterstring date

Filter for conversations where the last message was created after this date. Format should be yyyy-mm-dd or Unix timestamp in ms

last_message_created_beforestring date

Filter for conversations where the last message was created before this date. Format should be yyyy-mm-dd or Unix timestamp in ms

csidsinteger[]

Filter for this list of conversation IDs, comma separated

Response

Array of conversations

idinteger required

Id of the conversation

created_atinteger required

Timestamp of when the conversation was created

initial_channelstring required

The channel through which the communication was established

requester_idstring uuid required

Id of the enduser who requested the conversation

requester_namestring

Name of the enduser who requested the conversation

requester_emailstring

Email of the enduser who requested the conversation

requester_additional_emailsstring[]

Additional email addresses of the enduser who requested the conversation

requester_phone_numberstring

Phone number of the enduser who requested the conversation

requester_additional_phone_numbersstring[]

Additional phone numbers of the enduser who requested the conversation

queued_atnumber

Timestamp of when the conversation was queued

queue_idstring uuid

Id of the last queue where the conversation was placed

queue_namestring

Name of the last queue where the conversation was placed

closed_atnumber

Timestamp of when the conversation was closed

rating_score0 | 1

Rating score. This field is only relevant if you have set up the thumbs up/down ratings

rating_messagestring

Rating message associated with the rating score. This field is only relevant if you have set up the thumbs up/down ratings

direction'inbound' | 'outbound'

Direction of the conversation

assigned_atinteger

Timestamp of when the conversation was assigned to an agent

assignee_idstring uuid

Id of the agent that the conversation was assigned to

assignee_namestring

Name of the agent that the conversation was assigned to

assignee_emailstring

Email of the agent that the conversation was assigned to

assignee_phone_numberstring

Phone number of the agent that the conversation was assigned to

to_provisioned_phone_number_idstring

Called phone number id (for inbound calls), which is the phone number itself

to_provisioned_phone_number_namestring

Name of the called phone number provided

total_durationnumber

Call duration in seconds if it exists. This is a derived value closed_at - created_at. For advanced analytics, take a look at our Analytics API.

handling_durationnumber

Handling duration in seconds. This is a derived value closed_at - assigned_at. For advanced analytics, take a look at our Analytics API.

dixa_email_integration_idstring

Id of the email integration, which is the email address itself

dixa_email_integration_sender_namestring

Sender name of the email integration, if it exists

forwarding_emailstring

Forwarding email address

facebook_page_idstring

Page id coming from facebook

facebook_page_namestring

Page name coming from facebook

widget_idstring uuid

Id of the widget that was used

widget_namestring

Name of the widget that was used

tagsstring[]

All tags associated with the conversation

tags_infostring[]

All tags info associated with the conversation

conversation_wrapup_notesstring[]

All notes associated with the conversation

transferee_namestring

Target entity name of the transfer, which is either a queue or a user

transfer_timenumber

Timestamp of the latest transfer

originating_countrystring

Country the conversation originates from

updated_atnumber

Timestamp of when the conversation was last time updated

last_message_created_atnumber

Timestamp of when the last associated message was created

status'open' | 'closed' | 'pending' | 'awaitingpending'

Status of the conversation

transferee_numberstring

Phone number of the agent to whom the conversation was transferred

from_provisioned_phone_number_idstring

Calling phone number id (for outbound calls), which is the phone number itself

from_provisioned_phone_number_namestring

Name of the calling phone number provided

subjectstring

Subject field (for email and contact form)

anonymized_atnumber

Timestamp of when the conversation was anonymized

exports_handling_durationnumber

Cumulative assignment time across all agents that handled the conversation (in seconds). Can be different from handling_duration. This value corresponds to the handling_duration field in the "Integrations -> Export Conversations" CSV file.

link_type'email_forward' | 'follow_up' | 'side' | 'related'

Type of link associated with the conversation

linked_atinteger

Timestamp of when the conversation was linked

linked_tointeger

ID of the conversation this conversation is linked to

Example response

[
  {
    "initial_channel": "email",
    "ratings": [
      {
        "rating_type": "stars",
        "rating_status": "rated",
        "rating_language": "en"
      }
    ],
    "link_type": "side",
    "linked_at": 1762787749131,
    "linked_to": 14665
  }
]

All 2 operations