Ви можете отримати всі дані про контакт за його ID.
Використовуйте метод Отримати всі контакти, якщо ви хочете витягнути всі контакти зі свого облікового запису. Ви також можете шукати конкретний контакт або групу контактів за допомогою методу Пошук контактів.
➡️ Запит
| URL | https://api.helpcrunch.com/v1/customers/<customer_id> |
| Метод | GET |
| Headers | Authorization: Bearer <your_api_key> |
<customer_id> – це ID контакту, наданий HelpCrunch. Він обов’язковий для цього методу і виглядає як комбінація чисел (наприклад, 1568834).
✅ Відповідь на успішний запит
Якщо ваш запит виконано успішно, ви отримаєте код статусу успішного виконання 200 OK разом із наведеним нижче тілом відповіді.
{
"id": 542335,
"name": "John Doe",
"email": "[email protected]",
"userId": "user_1234567890",
"company": "Example Inc.",
"phone": "+10233456781",
"firstSeen": "1603885746",
"lastSeen": "1603885746",
"location": {
"regionCode": "Kyyivs'ka Oblast",
"countryCode": "UA",
"city": "Kyiv"
},
"device": {
"id": 542335,
"ip": "192.168.1.1",
"timezone": "Europe/Kiev",
"platform": "desktop",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.111 Safari/537.36"
},
"unsubscribed": false,
"blocked": false,
"source": "https://example.com",
"referer": "https://example.com",
"lastPage": "https://example.com",
"locale": "uk",
"createdFrom": "telegram",
"integrationId": "465847687",
"notes": "Lorem ipsum",
"tags": [
{
"name": "vip",
"color": "#ff0000"
}
],
"customData": {
"subscription_status": "active",
"number_of_payments": 15,
"last_paid_amount": 15.99,
"last_payment_date": 1603885746,
"last_invoice_url": "https://example.com/invoice.html",
"last_payment_was_successful": true
}
}Ви можете отримати деталі по кожному полю обʼєкту контакту у статті Модель даних контакту.
🛑 Відповіді з помилками
Ви можете отримати один із наведених нижче кодів статусу помилки та відповіді. Детальніше про коди помилок ви можете прочитати за посиланням.
401 Unauthorized
{
"errors": [
{
"code": "invalid_request",
"message": "Invalid request"
},
{
"code": "unauthorized",
"message": "Unauthorized"
}
]
}404 Not Found
{
"errors": [
{
"code": "invalid_request",
"message": "Invalid request"
},
{
"code": "not_found",
"message": "Chat not found"
}
]
}429 Too Many Requests
{
"errors": [
{
"code": "invalid_request",
"message": "Invalid request"
},
{
"code": "too_many_requests",
"message": "Too many requests"
}
]
}