Search Resources
To find resources matching a specified search query you can use the commands listed in this section.
Search for contacts
To get all contacts matching a specified query, use:
GET /api/v2/contacts/search
with the parameters:
| Name | Required? | Example | Description |
|---|---|---|---|
| page | No | 3 |
Fetch the specified results page. The default is 1. |
| limit | No | 25 |
The number of results per page. The default is 10. |
| shared | No | 1 |
Should contacts in the shared lists be included in response? The default is 0 (false). |
| ids | No | 310092,2385002,19400 |
Desired contact IDs, separated by comma. |
| listId | No | 319901 |
Fetch only contacts that belong to this list. |
| query | No | Conway447012 |
Search for contacts containing specified text in the first name, last name or phone number. |
You will receive the standard paginated response:
| Parameter | Example | Description |
|---|---|---|
| page | 3 |
The current fetched page. |
| limit | 25 |
The number of results per page. |
| pageCount | 150 |
The total number of pages. |
| resources | Array of contact resources | See this section for contact resource format details. |
Search for lists
To get all the lists matching a specified query, use:
GET /api/v2/lists/search
with the parameters:
| Name | Required? | Example | Description |
|---|---|---|---|
| page | No | 3 |
Fetch the specified results page. The default is 1. |
| limit | No | 25 |
How many results to return. The default is 10. |
| ids | No | 32009,29771,28101 |
Desired list IDs, separated by comma. |
| query | No | Customers |
Search for lists containing specified text in the name or description. |
You will receive the standard paginated response:
| Parameter | Example | Description |
|---|---|---|
| page | 3 |
The current fetched page. |
| limit | 25 |
The number of results per page. |
| pageCount | 150 |
The total number of pages. |
| resources | Array of list resources | See this section for list resource format details. |
Search for inbound messages
To get all the messages matching a specified query, use:
GET /api/v2/replies/search
with the parameters:
| Name | Required? | Example | Description |
|---|---|---|---|
| page | No | 3 |
Fetch the specified results page. The default is 1. |
| limit | No | 25 |
How many results to return. The default is 10. |
| ids | No | 32009,29771,28101 |
Desired inbound message IDs, separated by commas. |
| query | No | Customers |
Search for inbound messages contain specified text in the contact name, phone number or text. |
You will receive the standard paginated response:
| Parameter | Example | Description |
|---|---|---|
| page | 3 |
The current fetched page. |
| limit | 25 |
The number of results per page. |
| pageCount | 150 |
The total number of pages. |
| resources | Array of reply resources | See this section for reply resource format details. |
Search for messages
To get all the lists matching a specified query, use:
GET /api/v2/messages/search
with the parameters:
| Name | Required? | Example | Description |
|---|---|---|---|
| page | No |
3
|
Fetch the specified results page. The default is 1. |
| limit | No | 25 |
How many results to return. The default is 10. |
| ids | No | 218,400543,657561 |
Desired message IDs, separated by commas. |
| sessionId | No | 993101 |
Fetch only messages that belong to this session. |
| query | No | Conway447012 |
Search for messages containing specified text in the contact name, phone number or text. |
You will get the standard paginated response:
| Parameter | Example | Description |
|---|---|---|
| page | 3 |
The current fetched page. |
| limit | 25 |
The number of results per page. |
| pageCount | 150 |
The total number of pages. |
| resources | Array of message resources | See this section for message resource format details. |
Search for templates
To get all the templates matching a specified query, use:
GET /api/v2/templates/search
with the parameters:
| Name | Required? | Example | Description |
|---|---|---|---|
| page | No | 3 |
Fetch the specified results page. The default is 1. |
| limit | No | 25 |
How many results to return. The default is 10. |
| ids | No | 3339,708 |
Desired template IDs, separated by commas. |
| query | No | Customers |
Search for templates containing specified text in the name or content. |
You will receive the standard paginated response:
| Parameter | Example | Description |
|---|---|---|
| page | 3 |
The current fetched page. |
| limit | 25 |
The number of results per page. |
| pageCount | 150 |
The total number of pages. |
| resources | Array of template resources | See this section for template resource format details. |
