Respond.io is a platform designed for managing and automating customer messages and communications across various channels. This service enables businesses to centralize and manage messages from different messaging applications, such as WhatsApp, Facebook Messenger, Viber, Telegram, LINE, and others, in one place.
Informations about settings for developers and API documentation for Respond.io found here.
List Contact allows you to list all available contacts. You can use filters in the request body to limit the results to only records with matching contact field values.
Configuration
Respond.io - Connection
Token
Uses to authorize and authenticate connections. More information about where to find the token can be found here.
Respond.io - List Contacts Settings
Error behavior
The available values are:
-
Fail and return response: The connector fails at the specified line but generates output with error details.
-
Fail without response: The connector fails - the error will be displayed only in the log.
-
Do not fail and return response: The connector does not fail but generates output records that may be marked with an error and detailed information.
Input & Output Schema
Input
Respond.io - List Contacts Request (ver. 1.2.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Search | String | Yes | Search query to filter contacts |
| Timezone | String | Yes | Timezone of the user requesting data |
| Filters | Respond.io - Filters v1.2.0 |
Yes | Criteria to filter the contacts list |
Respond.io - Filters (ver. 1.2.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| FilterAnd | Respond.io - Filter v1.2.0 |
Yes | Filters to apply where all conditions must be met (logical AND operation) |
| FilterOr | Respond.io - Filter v1.2.0 |
Yes | Filters to apply where any condition can be met (logical OR operation) |
Respond.io - Filter (ver. 1.2.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Category | String | No | The category to which the filter applies. |
| Field | String | No | The specific field within the category to filter. |
| Operator | String | No | The operator used for filtering (e.g., equals, contains). |
| StringValue | String | Yes | The string value to be used for filtering. |
| IntValue | Integer | Yes | The integer value to be used for filtering. |
Output
Respond.io - List Contacts Response (ver. 1.1.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| StatusCode | Integer | No | HTTP status code of the response |
| Message | String | Yes | Message detailing the response status or errors |
| Items | Respond.io - List Contacts Contact v1.1.0 |
Yes | Complex schema |
Status Code
- 200 Success
- 400 Bad request
- 500 Server error
Respond.io - List Contacts Contact (ver. 1.1.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| ID | Integer | Yes | Contact ID |
| Status | String | Yes | Conversation status of the contact (e.g. open, closed) |
| Tags | Respond.io - List Contacts Tag v1.0.0 |
Yes | Tags of the contact (max. 10 items) |
| Assignee | Respond.io - List Contacts Assignee v1.1.0 |
Yes | User to whom the contact is assigned |
| CreatedAt | DateTime | Yes | Unix timestamp in seconds representing when the contact was created |
| FirstName | String | Yes | First name of the contact |
| LastName | String | Yes | Last name of the contact |
| Phone | String | Yes | Phone number of the contact |
| String | Yes | Email address of the contact | |
| Language | String | Yes | Language following the ISO 639-1 standard |
| ProfilePictureUrl | String | Yes | URL of the profile picture |
| CountryCode | String | Yes | Code of the country following the ISO 3166-1 alpha-2 standard |
| CustomFields | Respond.io - List Contacts Custom Field v1.1.0 |
Yes | Custom value |
Respond.io - List Contacts Tag (ver. 1.0.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Tag | String | No | Tags assigned to the contact |
Respond.io - List Contacts Assignee (ver. 1.1.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| ID | Integer | Yes | Unique identifier of the assignee |
| FirstName | String | Yes | First name of the assignee |
| LastName | String | Yes | Last name of the assignee |
| String | Yes | Email address of the assignee |
Respond.io - List Contacts Custom Field (ver. 1.1.0)
| Column | Data type | Allow null | Description |
|---|---|---|---|
| Name | String | No | Custom name of the field |
| Value | String | Yes | Value assigned to the custom field |
Release notes
3.0.4
- First release.