Skip to main content
GET
/
get_contact_conversations
Get Contact Conversations
curl --request GET \
  --url https://vevdoh3hve.execute-api.us-east-1.amazonaws.com/prod/get_contact_conversations \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "data": {
      "contacts": [
        {
          "contact_id": "<string>",
          "contact_name": "<string>",
          "phone_number": "<string>",
          "email": "<string>",
          "conversation_status": "<string>",
          "assigned_to": "<string>",
          "unread_message_count": "<string>",
          "latest_message_time": "2023-11-07T05:31:56Z",
          "channels": [
            "<string>"
          ]
        }
      ]
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.chatzy.ai/llms.txt

Use this file to discover all available pages before exploring further.

Retrieves a paginated list of contact conversations associated with the given user. Supports optional search, pagination, and filtering by conversation status. This endpoint is commonly used to display a user’s contact list in messaging interfaces.

​
Parameters:

  • user_email_id (required)
  • Your Chatzy AI account email ID.
  • search (optional) - Filter contacts by name, email, phone number or iframe user ID.
  • limit (optional) - Number of contacts to return per page (default: 10, min: 1, max: 100).
  • offset (optional) - Number of contacts to skip for pagination (default: 0).
  • filter (optional) - Filter by conversation status:
  • all - All conversations (default)
  • unread - Only conversations with unread messages
  • live - Active/live conversations

Authorizations

​
Authorization
string
header
required

Use the idToken retrieved from /get_id_token as the Bearer token.

Query Parameters

​
user_email_id
string
required

Email ID of the user whose contacts should be fetched.

​
search
string

Search by contact name, email, phone number or iframe user id.

​
limit
integer
default:10

Number of results to return (min 1, max 100).

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of results to skip.

Required range: x >= 0
​
filter
enum<string>
default:all

Filter conversation status: all, unread, or live.

Available options:
all,
unread,
live

Response

200 - application/json

A list of contacts for whom there is a conversation.

​
data
object