Public
Search for a contact
Public
Public
Search for a contact
Searches for a contact on your team
GET
/
public
/
contacts
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": "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 ID of the contact
Example:
"1"
The ID of the team the contact belongs to
Example:
"1"
The ID of the user who created the contact
Example:
"1"
The name of the contact
Example:
"John Doe"
The phone number of the contact
Example:
"+1234567890"
The email address of the contact
Example:
"johndoe@example.com"
The external ID of the contact
Example:
"1234"
Whether the contact has opted out of messages
Example:
false
The URL of the contact avatar
Example:
"https://example.com/avatar.jpg"
Whether the contact is public
Example:
false
Additional metadata for the contact
Example:
{}
Example:
"2021-01-01T00:00:00.000Z"
Example:
"2021-01-01T00:00:00.000Z"
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": "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"
}
]
}