API Reference

Retrieve contacts by specific criteria.

Introduction

This endpoint will provide you a list of all of your contacts - both internal and external - that meets certain provided criteria.

Data Requirements

Provide the following data requirements when sending a POST request to the Search Contacts endpoint. The url of this request contains the following query parameters:

Parameter Required? Description Type
searchTerm Yes Search criteria by which matching contact will be returned. You can search contacts by their display name, slug, @handle, name and/or email. String
page No Positive number that indicates page to be accessed. Must be provided within a range of total pages. Number

Additional Header parameter:

Parameter Required? Description Type
Client-Id No Unique identifier of Child Account (required only for Partner). See Authentication Page to learn more. String
Language
Credentials
Bearer
JWT
URL
Click Try It! to start a request and see the response here!