The Catalyst public API is a simple, secure, JSON-based interface for viewing customer business data on the Catalyst platform in a programmatic way.
The Catalyst API is intended for software developers. To use it you should be familiar with web programming and be comfortable creating applications that consume web services through HTTP requests.
What you should know
- Create secure API keys to access endpoints
- There is a global rate limit of 100 calls per minute, per customer instance
- For the OpenAPI specification, please refer to our public API documentation
- Base URL:
https://api.catalyst.io
Query parameters
To control the date range of returned data, you can apply filtering and/or specify attributes. Filtering reduces response payloads and minimizes the risk of hitting rate limits.
Filters | Applies to /accounts, /notes, /tasks, /emails, /playbooks endpoints:
-
limit→ Max number of records to return (default 25, max 100) -
offset→ Offset for pagination (default 0) -
updated_at_gte→ greater than or equals to -
updated_at_lte→ less than or equals to -
updated_at_gt→ greater than -
updated_at_lt→ less than -
updated_at_eq→ equals to (ignores time passed in the parameter; e.g., 2020-01-01T10:20:30 becomes 2020-01-01) -
updated_at_ne→ not equals to (ignores time passed in the parameter; e.g., 2020-01-01T10:20:30 becomes 2020-01-01)
Filters | Applies to the /health scores endpoint:
The earliest date supported for health score change tracking is October 31, 2025.
-
limit→ Max number of records to return (default 25, max 100) -
offset→ Offset for pagination (default 0) -
score_updated_at_gte→ greater than or equals to -
score_updated_at_lte→ less than or equals to -
score_updated_at_gt→ greater than -
score_updated_at_lt→ less than -
score_updated_at_eq→ equals to (ignores time passed in the parameter; e.g., 2020-01-01T10:20:30 becomes 2020-01-01) -
score_updated_at_ne→ not equals to (ignores time passed in the parameter; e.g., 2020-01-01T10:20:30 becomes 2020-01-01)
Specify attributes | Applies to /accounts, /notes, /tasks endpoints:
-
attributes→ Array of attribute names to include in the response. Use the name field from GET/[object]/attributesto find available attribute names. Supports multiple formats: attributes[]=Name&attributes[]=Type or attributes=Name,Type (comma-separated)
Query parameter examples
GET /notes?updated_at_gt=2025-09-09
Filter records created or updated after 2025-09-09T00:00:00Z
GET /notes?updated_at_gt=2025-09-09T10:20:30
Filter records created or updated after 2025-09-09T10:20:30Z
GET /notes?Updated_at_gt=2025-09-08&updated_at_lt=2025-09-10
Filter records created or updated between 2025-09-08T00:00:00Z AND 2025-09-10T00:00:00
GET /notes?updated_at_eq=2025-09-08
Filter records created or updated on 2025-09-08
GET /notes?updated_at_eq=2025-09-08&attributes=Meeting%20Deck
Filter records created or updated on 2025-09-08 and include an additional "Note" field (Meeting Deck)
Accounts
Use for viewing account data and health scores.
| Endpoint | Method / Path |
| Lists accounts |
GET /accounts |
| Shows account |
GET /accounts/{account_id} |
| Lists account attributes |
GET /accounts/attributes |
| Lists all score_compositions for given account |
GET /accounts/{account_id}/health_groups |
Playbook Email
Use for getting details on emails sent by playbooks.
| Endpoint | Method / Path |
| List emails |
GET /emails |
| Show email by ID |
GET /accounts/{email_id} |
Health Scores
Use for getting all health scores, including health group and health inputs for each.
| Endpoint | Method / Path |
| List health scores |
GET /health_scores |
Notes
Use for viewing note data.
| Endpoint | Method / Path |
| List notes |
GET /notes |
| Show notes |
GET /notes/{note_id} |
| List note attributes |
GET /notes/attributes |
Playbooks
Use for viewing playbook data and overall performance.
| Endpoint | Method / Path |
| List all playbooks |
GET /playbooks |
| Show a specific playbook |
GET /playbooks/{playbook_id} |
| List executions of a playbook |
GET /playbooks/{playbook_id}/executions |
| List email templates of a playbook |
GET /playbooks/{playbook_id}/email_templates |
Tasks
Use for viewing task data.
| Endpoint | Method / Path |
| List tasks |
GET /tasks |
| Show task |
GET /tasks/{task_id} |
| List task attributes |
GET /tasks/attributes |
Unsubscribed Emails
Use for viewing unsubscribed data from playbook emails.
| Endpoint | Method / Path |
| List unsubscribed emails |
GET /unsubscribed |