Skip to main content
GET
/
conversation
/
v1
/
conversations
/
{conversationId}
Retrieve a conversation
curl --request GET \
  --url https://api.sandbox.asapp.com/conversation/v1/conversations/{conversationId} \
  --header 'asapp-api-id: <api-key>' \
  --header 'asapp-api-secret: <api-key>'
{
  "id": "01BX5ZZKBKACTAV9WEVGEMMVRZ",
  "externalId": "id-111",
  "agent": {
    "externalId": "agent-111",
    "name": "agent-x"
  },
  "customer": {
    "externalId": "customer-x",
    "name": "customer-name-x"
  },
  "metadata": {
    "organizationalGroup": "some-group",
    "subdivision": "some-division",
    "queue": "some-queue"
  }
}

Authorizations

​
asapp-api-id
string
header
required
​
asapp-api-secret
string
header
required

Path Parameters

​
conversationId
string
required

The identifier for a conversation.

Response

Successfully fetched conversation

Represents a conversation between an agent and a customer.

​
externalId
string
required

The unique identifier for the conversation in your external chat or voice system.

​
customer
object
required

Information about the customer participating in the conversation.

​
id
string

The unique identifier for the conversation within the ASAPP system.

​
agent
object

Information about the agent participating in the conversation.

​
metadata
object

Additional key-value pairs to store custom metadata about the conversation. Use this for filtering or categorization purposes.

⌘I