Skip to main content

Get a conversation's assignment

Get the user and the team a conversation is assigned to.

Endpoint​

GET https://api.p.2chat.io/open/conversations/<session-key>/assignment
  • <session-key> is the session_key of the conversation, e.g. WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176. See where to get it.

Authentication​

Include your API key in the X-User-API-Key header. Learn more about authentication.

Invocation​

curl --location --request GET 'https://api.p.2chat.io/open/conversations/WA-WAN8fd3442f-e111-4fed-9323-1824fd7546c9-14085550176/assignment' \
--header 'X-User-API-Key: your_api_key_here'

Response​

Success (HTTP 200 OK)​

{
"success": true,
"data": {
"assigned_user": {
"uuid": "USR4f1c8a73-2e91-4d6b-9c44-1a72bfe0d521",
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com"
},
"assigned_team": {
"uuid": "VUGa71c3e09-8b52-4f0d-9d1e-5c6b2f8e4a10",
"name": "Sales"
}
}
}
FieldDescription
data.assigned_userThe user the conversation is assigned to, or null. See the assignment object.
data.assigned_teamThe team the conversation is assigned to, or null.

An unassigned conversation returns null in both fields.

Error​

{
"success": false,
"error": true,
"error_message": "Description of what went wrong"
}
HTTP statusWhen
401The API key is missing or invalid
403The user who owns the API key can't open this conversation. See permissions
404There is no conversation with that session_key in your account