Passer au contenu principal
GET
/
v1
/
api
/
contact
/
{contact_id}
Get Contact
curl --request GET \
  --url https://api.withallo.com/v1/api/contact/{contact_id} \
  --header 'Authorization: <api-key>'
{
  "data": {
    "id": "cnt_abc123",
    "name": "John",
    "last_name": "Doe",
    "numbers": [
      "+1234567890"
    ],
    "emails": [
      "[email protected]"
    ],
    "company": {
      "name": "Acme Corp",
      "id": "com_xyz789"
    },
    "job_title": "CEO",
    "website": "https://acme.com",
    "integration_data": {
      "HUBSPOT": {
        "contact_id": "12345",
        "deal_stage": "Negotiation"
      }
    },
    "custom_properties": {
      "preferred_language": "English",
      "vip_status": true
    },
    "engagement": "ENGAGED",
    "activity": [
      {
        "type": "INBOUND_CALL",
        "made_by": "John Doe",
        "made_at": "2024-01-15T10:30:00",
        "allo_number": "+1234567890",
        "content": null
      },
      {
        "type": "OUTBOUND_SMS",
        "made_by": "Jane Smith",
        "made_at": "2024-01-14T09:15:00",
        "allo_number": null,
        "content": "Thank you for your call. We will follow up shortly."
      }
    ],
    "conversation_url": "/v1/api/contact/cnt_abc123/conversation"
  }
}

Autorisations

Authorization
string
header
requis

Scope needed: CONTACTS_READ

Paramètres de chemin

contact_id
string
requis

The unique identifier of the contact (e.g., "cnt_abc123")

Exemple:

"cnt_abc123"

Paramètres de requête

extend
string

Comma-separated list of additional data to include. Available options: engagement (includes engagement level), activity (includes recent communication activities).

Exemple:

"engagement,activity"

Réponse

Contact context retrieved successfully

Standard response wrapper for contact context

data
object

Comprehensive contact context including integration data and activity