Get info of an AI contact
Contact Management
Get info of an AI contact
GET
Get info of an AI contact
Overview
Retrieve comprehensive information about a specific contact, including their profile data, active ticket, last closed ticket, and custom metadata. This endpoint is essential for getting the complete context of a contact’s current state and interaction history.Use Cases
- Contact Profile Display: Show detailed contact information in your CRM or dashboard
- Ticket Management: Access current and historical ticket data for support workflows
- Custom Data Integration: Retrieve custom metadata fields for personalized experiences
- Contact Status Tracking: Monitor contact engagement status and last interaction
- Support Agent Context: Provide agents with full contact history before responding
- Agent Assignment Tracking: See which team members are currently assigned to a contact
Authentication
This endpoint requires authentication using an API key. Include your API key in the request header:Path Parameters
Response Structure
The endpoint returns a contact object with the following structure:Contact Object
Assigned Agent Object
Each item in theassigned_agents array contains:
Active Ticket Object
When a contact has an active ticket, theactive_ticket field contains:
Last Closed Ticket Object
Thelast_closed_ticket field has the same structure as active_ticket but represents the most recently closed ticket.
Example Response
Common Use Cases
1. Display Contact Profile in Dashboard
2. Check for Active Tickets
3. Access Custom Metadata
4. Get Last Interaction Info
Chat Status Values
Thechat_status field can have the following values:
Platform Values
Theplatform field indicates the communication channel:
Error Responses
Tips
- Contact ID Format: Always use the UUID format for
aiContactId - Null Values: Many fields can be
null- always check before accessing nested properties - Metadata Structure: Custom metadata fields vary by organization - check your specific fields
- Ticket History: Only the last closed ticket is returned, not all historical tickets
- Real-time Data: This endpoint returns current data - for historical conversation data, use the messages endpoint
- Backward Compatibility: The response includes both
active_ticket_v2andactive_ticketfor compatibility
Headers
API key required to authorize the request
Path Parameters
ID of the AI contact
Query Parameters
When true, date/datetime custom fields are serialized in ISO 8601 format (e.g. "2026-03-31T20:00:00.000Z" or "2026-03-31" for date-only fields). Defaults to false for backward compatibility.
Response
AI contact info retrieved successfully.
