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"
    }
  ]
}

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

string

required

Response

The found contacts

data

object[]

required

Show child attributes

data.id

string

required

The ID of the contact

Example:

"1"

data.teamId

string

required

The ID of the team the contact belongs to

Example:

"1"

data.createdByUserId

string

required

The ID of the user who created the contact

Example:

"1"

data.name

string

required

The name of the contact

Example:

"John Doe"

data.phone

string

required

The phone number of the contact

Example:

"+1234567890"

data.email

string

required

The email address of the contact

Example:

"[email protected]"

data.externalId

string

required

The external ID of the contact

Example:

"1234"

data.optOut

boolean

required

Whether the contact has opted out of messages

Example:

false

data.avatarURL

string

required

The URL of the contact avatar

Example:

"https://example.com/avatar.jpg"

data.public

boolean

required

Whether the contact is public

Example:

false

data.data

object

required

Additional metadata for the contact

Example:

{}

data.attributes

object[]

required

The contact attributes

Show child attributes

data.attributes.id

string

required

data.attributes.attributeTypeId

string

required

data.attributes.createdAt

string<date-time>

required

data.attributes.updatedAt

string<date-time>

required

data.attributes.value

object

Example:

[]

data.created

string<date-time>

required

Example:

"2021-01-01T00:00:00.000Z"

data.updated

string<date-time>

required

Example:

"2021-01-01T00:00:00.000Z"

Unread Message Counts Create a contact

⌘I

Public

Public Admin

Search for a contact

Authorizations

Query Parameters

Response