Capsule CRM

Manage parties, opportunities, and tasks in Capsule CRM via its REST API v2.

This tool wraps the Capsule Developer API (https://api.capsulecrm.com/api/v2) using only the Python standard library. It reads and writes the three core Capsule record types — parties (people and organisations), opportunities, and tasks.

Operations

All read operations accept page (default 1) and perPage (1–100, default 50).

API key setup

Capsule supports a single personal access token so you do not need the full OAuth 2 flow for an internal integration:

1. Sign in to Capsule.
2. Go to My Preferences > API Authentication Tokens.
3. Generate a token and copy it.
4. Pass it as the apiKey input. The tool sends it as Authorization: Bearer <token> on every request.

No userEmail or app id is needed — the token alone authenticates the request.

Inputs

Outputs

• result — the raw Capsule JSON response body as a string.
• status — the HTTP status code as a string (e.g. 200, 201, 401).

The tool never raises on a non-2xx response; it returns the status and body so the caller can branch on them. A transport-level failure (DNS, refused, timeout) emits {"error": ...} and exits non-zero, marking the step FAILED.

Examples

Search for a contact named "Acme":

operation = search_parties
query     = Acme

Create a person with a work email:

operation = create_party
firstName = Scott
lastName  = Spacey
email     = [email protected]

Create an organisation:

operation    = create_party
organisation = Capsule Ltd
email        = [email protected]

Open a new opportunity against party 42 in milestone 3:

operation   = create_opportunity
name        = Website redesign
partyId     = 42
milestoneId = 3
description = Q3 redesign engagement

List open tasks:

operation = list_tasks
status    = open

Create a follow-up task due next week:

operation   = create_task
description  = Follow up on proposal
partyId      = 42
dueOn        = 2026-06-20

Notes

• Base URL: https://api.capsulecrm.com/api/v2
• Auth: Authorization: Bearer <personal access token>
• Standard library only (urllib, json); response bodies capped at ~5 MB.
• Grounded in https://developer.capsulecrm.com/.

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

• error
• result
• status

Input Properties

Every property this tool accepts, from its own tool.iml.