Ви можете отримати всі свої контакти або певну групу контактів за допомогою цього методу. Якщо ви хочете отримати інформацію лише про один контакт за його ідентифікатором, скористайтеся методом Отримання інформації про контакт . Щоб знайти контакти за значенням їх атрибутів, використовуйте метод Пошук контактів

➡️ Запит

Параметри сортування

Щоб відсортувати контакти у порядку спадання, використовуйте у запиті параметр order=desc. Щоб відсортувати у порядку зростання - використовуйте order=asc.

✅ Відповідь на успішний запит

Якщо ваш запит пройшов успішно, ви отримаєте код статусу успішного виконання 200 OK разом із наведеним нижче тілом відповіді.

{
  "data": [
    {
      "id": 542335,
      "name": "John Doe",
      "email": "john.doe@example.com",
      "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",
      "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
      }
    }
  ],
  "total": 256
}

Ви можете отримати деталі по кожному полю обʼєкту контакту у статті Модель даних контакту.

Як отримати всі контакти

За замовчуванням цей метод повертає лише перших 100 контакти. Щоб отримати інший список контактів, слід використовувати параметри offset і limit у рядку запиту запиту GET.

Щоб переглянути всі доступні контакти, спершу надішліть запит без будь-яких параметрів і витягніть загальну (total) кількість контактів із відповіді JSON, яку ви отримаєте.

Після цього надсилайте наступні запити зі зростаючими зміщеннями (offset) та фіксованим лімітом (limit), доки не отримаєте всі дані.

https://api.helpcrunch.com/customers?offset=100&limit=100
https://api.helpcrunch.com/customers?offset=200&limit=100
https://api.helpcrunch.com/customers?offset=300&limit=100
...

Загальний ліміт запитів становить 120 за хвилину.

🛑 Відповіді з помилками

Ви можете отримати один із наведених нижче кодів статусу помилки та відповіді. Детальніше про коди помилок ви можете прочитати за посиланням.

400 Bad Request

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "customer",
      "message": "This value should be of type numeric."
    },
    {
      "code": "filter[0].field",
      "message": "This value should not be blank."
    }
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "unauthorized",
      "message": "Unauthorized"
    }
  ]
}

429 Too Many Requests

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "too_many_requests",
      "message": "Too many requests"
    }
  ]
}