Crisp
Manage live-chat conversations, sessions, and contact profiles in Crisp via the Crisp REST API v1.
Operations
| Operation | Description | Required params |
|---|---|---|
list_conversations |
List conversations for the website (paginated) | websiteId, page (default 1) |
get_conversation |
Retrieve full details for a single conversation | websiteId, sessionId |
get_messages |
List all messages in a conversation | websiteId, sessionId |
send_message |
Send an operator message or private note into a conversation | websiteId, sessionId, messageContent, messageType (text/note) |
API Key Setup
- Log in to your Crisp dashboard.
- Go to Settings → Website → API & Webhooks.
- Under Access Tokens, click Generate Token.
- Copy both the Token Identifier and Token Key.
- Combine them as
token_identifier:token_key— that is the value forapiKey.
Your Website ID is shown in Settings → Website → Setup & Domain (it is a UUID).
Examples
List the first page of open conversations:
apiKey: abc123:secret456
websiteId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
operation: list_conversations
page: 1
Read all messages from a specific conversation:
apiKey: abc123:secret456
websiteId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
operation: get_messages
sessionId: session_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Send an operator reply:
apiKey: abc123:secret456
websiteId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
operation: send_message
sessionId: session_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
messageContent: Thanks for reaching out — we'll get back to you shortly.
messageType: text
Send a private note (visible to operators only):
apiKey: abc123:secret456
websiteId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
operation: send_message
sessionId: session_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
messageContent: Customer flagged as VIP — escalate if no response in 2h.
messageType: note
Auth
Uses HTTP Basic authentication per the Crisp Website Token scheme:
Authorization: Basic BASE64(token_id:token_key) plus X-Crisp-Tier: website.
No OAuth flow — a single token_id:token_key string is all that is needed.