Skip to main content
GET
Get Contact Conversations
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 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