Skip to content
PurrCRMPurrCRMPurrCRM Docs

API reference

Every route your own code calls, with what it takes and answers. It is generated from the API itself, so it says what PurrCRM does. The same description is at /openapi.json (OpenAPI 3.1) for tools that read one.

Every route is at your PurrCRM address, https://app.purrcrm.com. Bodies are JSON unless a route says otherwise, and every refusal is problem JSON.

  • Guest API (/guest/v1/): for a website, web app or mobile app, on behalf of its signed-in user. How to call it.
  • Server API (/server/v1/): for your backend, with a server key. How to call it.
  • Public routes (/public/v1/): need no credential. Most are used by PurrCRM’s own pages and emails.

From a browser, the guest API and an app’s public details (GET /public/v1/apps/{key}) answer pages on the app’s web origins, and no others. The server API never answers a browser.

Guest API

Section titled “Guest API”
GroupRoutes
Messenger10
Tickets3
Help center5
In-app messages6
Events1
Push and notices4
Preferences4

Server API

Section titled “Server API”
GroupRoutes
Contacts3
Server events2

Public routes

Section titled “Public routes”
GroupRoutes
App1
Public help center6
Sign-up1
Email links8
Email hooks4
Links1

The bodies are on Models.