Skip to main content
GET
/
public
/
message-templates
List message templates
curl --request GET \
  --url https://web-api.clerk.chat/public/message-templates \
  --header 'apiKey: <api-key>'
{
  "data": [
    {
      "id": 1,
      "teamId": "00000000-0000-0000-0000-000000000000",
      "name": "Welcome Message",
      "body": "Hello {{first_name}}, welcome!",
      "isPersonal": false,
      "attachmentIds": [],
      "created": "2021-01-01T00:00:00.000Z",
      "updated": "2021-01-01T00:00:00.000Z",
      "userId": "1",
      "externalId": "external-id"
    }
  ],
  "total": 1,
  "links": {
    "next": "<string>",
    "prev": "<string>",
    "self": "<string>"
  }
}

Authorizations

apiKey
string
header
required

Query Parameters

limit
number

Number of items to return (max 50)

page
number

Page number

Response

A paginated list of message templates

data
object[]
required
total
number
required

The total number of message templates

Example:

1