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:

NameRequired?ExampleDescription
pageNo3Fetch the specified results page. The default is 1.
limitNo25The number of results per page. The default is 10.
sharedNo1Should contacts in the shared lists be included in response? The default is 0 (false).
idsNo310092,2385002,19400Desired contact IDs, separated by comma.
listIdNo319901Fetch only contacts that belong to this list.
queryNoConway
447012
Search for contacts containing specified text in the first name, last name or phone number.

You will receive the standard paginated response:

ParameterExampleDescription
page3The current fetched page.
limit25The number of results per page.
pageCount150The total number of pages.
resourcesArray of contact resourcesSee 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:

NameRequired?ExampleDescription
pageNo3Fetch the specified results page. The default is 1.
limitNo25How many results to return. The default is 10.
idsNo32009,29771,28101Desired list IDs, separated by comma.
queryNoCustomersSearch for lists containing specified text in the name or description.

You will receive the standard paginated response:

ParameterExampleDescription
page3The current fetched page.
limit25The number of results per page.
pageCount150The total number of pages.
resourcesArray of list resourcesSee 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:

NameRequired?ExampleDescription
pageNo3Fetch the specified results page. The default is 1.
limitNo25How many results to return. The default is 10.
idsNo32009,29771,28101Desired inbound message IDs, separated by commas.
queryNoCustomersSearch for inbound messages contain specified text in the contact name, phone number or text.

You will receive the standard paginated response:

ParameterExampleDescription
page3The current fetched page.
limit25The number of results per page.
pageCount150The total number of pages.
resourcesArray of reply resourcesSee 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:

NameRequired?ExampleDescription
pageNo 3 Fetch the specified results page. The default is 1.
limitNo25How many results to return. The default is 10.
idsNo218,400543,657561Desired message IDs, separated by commas.
sessionIdNo993101Fetch only messages that belong to this session.
queryNoConway
447012
Search for messages containing specified text in the contact name, phone number or text.

You will get the standard paginated response:

ParameterExampleDescription
page3The current fetched page.
limit25The number of results per page.
pageCount150The total number of pages.
resourcesArray of message resourcesSee 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:

NameRequired?ExampleDescription
pageNo3Fetch the specified results page. The default is 1.
limitNo25How many results to return. The default is 10.
idsNo3339,708Desired template IDs, separated by commas.
queryNoCustomersSearch for templates containing specified text in the name or content.

You will receive the standard paginated response:

ParameterExampleDescription
page3The current fetched page.
limit25The number of results per page.
pageCount150The total number of pages.
resourcesArray of template resourcesSee this section for template resource format details.