Skip to main content

Crisp API (conversations / people / operators)

Use this skill when you need to:

  • List conversations (conversations), get a conversation (conversation <session_id>).
  • Consult a person profile by email (people <email>) or their conversations (people-conversations <email>).
  • List operators (operators) or view one by user_id (operator <user_id>).

Quick Commands (from pla-cli/)​

php scripts/crisp_lookup.php conversations --page=1
php scripts/crisp_lookup.php conversation <session_id>
php scripts/crisp_lookup.php people [email protected]
php scripts/crisp_lookup.php people-conversations [email protected] --page=1
php scripts/crisp_lookup.php operators --search=support

Options​

  • --q (conversations): search text.
  • --page: pagination (conversations / people-conversations).
  • --raw: returns full payload without summary.
  • --active (operators): only active operators.
  • --search (operators): filters locally by email/nickname/name.

Prerequisites​

  • Variables in pla-cli/.env: CRISP_WEBSITE_ID, CRISP_IDENTIFIER, CRISP_KEY.
  • Optional CRISP_REGION: api.crisp.chat (default) or api.eu.crisp.chat.

Notes​

  • Basic Authentication with CRISP_IDENTIFIER:CRISP_KEY.
  • Endpoints used: /website/{website_id}/conversations/{page}, /conversation/{session_id}, /people/profile/{email}, /people/conversations/{email}/list/{page}, /operators/list, /operators/active, /operator/{user_id}.