Everything that happened with one contact, company or deal in your CRM, newest first, as its page in PristineSend shows it. And a search across companies, deals and contacts.
| Method | Path | Description |
|---|---|---|
GET | /api/v1/timeline | One contact's, company's or deal's timeline, newest first. |
GET | /api/v1/crm/search | Companies, deals and contacts that match some text. |
Both need the crm:read scope and an account with the CRM turned on. Both only read.
| Parameter | Type | Description |
|---|---|---|
contact_id / company_id / deal_id | string | Exactly one: the record whose timeline to read. |
limit | number | 1 to 100, 50 when left out. |
cursor | string | next_cursor from the page before. A timeline's cursor is its own: use the one it gave. |
Every timeline holds the replies and signups of its people (the contact, a company's contacts, a deal's contacts), the history and notes of its deals, and its own notes and tasks; a contact's also holds the emails you sent them. The timeline is built when it is read, so it always says what is true now: a note deleted in PristineSend is no longer on it.
Every item has kind, at (when it happened) and id, then the fields of its kind:
| kind | Type | Description |
|---|---|---|
email | kind | On a contact's timeline, a campaign or automation email you sent them: subject, and when it was delivered, opened, clicked, bounced, marked as spam, unsubscribed from or replied to. |
reply | kind | A reply to a tracked email: who wrote, to which address, its subject, whether a person wrote it or it was automatic, and what the pipeline did with it. Never the reply's words. |
form | kind | A signup on one of your forms: the form, and when it was submitted and confirmed. |
booking | kind | A meeting booked on one of your booking pages or through Calendly or Cal.com (provider: pages, calendly or calcom): the guest, the meeting's name, starts_at and ends_at, the host, status (booked or canceled), who cancelled and when, and rescheduled_from_starts_at when it is a new time for an earlier booking. Never the booking's answers, location or link. |
deal_event | kind | A deal's history: made, moved, changed, a contact added, taken off or made the main contact, or marked replied, with who did it. |
note | kind | A note: its kind, words and author. |
task | kind | A task: its title, due date, and when and by whom it was finished. |
Companies by name or domain, deals by name and contacts by address or name, at most 8 of each, from up to 200 characters of q. Read a match whole with its own endpoint, or its timeline here.
| Status | code | When |
|---|---|---|
400 | missing_field | No record named, or a search with no q. |
400 | invalid_field | A parameter the endpoint does not take, an id that is not one, a record that isn't the account's, a cursor that isn't one the timeline gave, or q over 200 characters (param names it). |
400 | invalid_request | Two records named at once. |
403 | insufficient_scope | The key lacks crm:read. |
403 | crm_not_enabled | Nobody has turned the CRM on for this account yet. |
503 | service_unavailable | A read behind the request failed: send the same request again. |
See Error codes for the envelope and the full list.