Skip to main content
GET
/
public
/
contacts
Search for a contact
curl --request GET \
  --url https://web-api.clerk.chat/public/contacts \
  --header 'apiKey: <api-key>'
{
  "data": [
    {
      "id": "1",
      "teamId": "1",
      "createdByUserId": "1",
      "name": "John Doe",
      "phone": "+1234567890",
      "email": "[email protected]",
      "externalId": "1234",
      "optOut": false,
      "avatarURL": "https://example.com/avatar.jpg",
      "public": false,
      "data": {},
      "attributes": [],
      "created": "2021-01-01T00:00:00.000Z",
      "updated": "2021-01-01T00:00:00.000Z"
    }
  ]
}

Authorizations

​
apiKey
string
header
required

Query Parameters

​
email
string
required

Response

The found contacts

​
data
object[]
required