Public
Public
Search for a contact
Searches for a contact on your team
GET
/
public
/
contacts
Copy
curl --request GET \
--url https://web-api.clerk.chat/public/contacts \
--header 'apiKey: <api-key>'
Copy
{
"data": [
{
"id": "1",
"teamId": "1",
"createdByUserId": "1",
"name": "John Doe",
"phone": "+1234567890",
"email": "johndoe@example.com",
"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
Query Parameters
Response
200
application/json
The found contacts
The response is of type object
.
Copy
curl --request GET \
--url https://web-api.clerk.chat/public/contacts \
--header 'apiKey: <api-key>'
Copy
{
"data": [
{
"id": "1",
"teamId": "1",
"createdByUserId": "1",
"name": "John Doe",
"phone": "+1234567890",
"email": "johndoe@example.com",
"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"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.