Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Capsule Opportunities API

The Opportunities API from Capsule — 7 operation(s) for opportunities.

Capsule Opportunities API is one of 4 APIs that Capsule publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Opportunities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 11 operations across 7 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.

Requests are made against a single base URL, https://api.capsulecrm.com/api/v2.

11 operations 7 paths 3 schemas 2 DELETE6 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Server
https://api.capsulecrm.com/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Capsule Opportunities API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — OAuth 2.0 access token or personal access token. The OAuth authorization endpoint is https://api.capsulecrm.com/oauth/authorise and the token endpoint is https…

Paths & Operations 11

Across 7 paths, the API surfaces 11 operations — 2 DELETE, 6 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Opportunities 11
GET
/opportunities
List opportunities
2 params → 200
POST
/opportunities
Create an opportunity
body → 201
GET
/opportunities/{opportunityId}
Show an opportunity
1 param → 200
PUT
/opportunities/{opportunityId}
Update an opportunity
1 param body → 200
DELETE
/opportunities/{opportunityId}
Delete an opportunity
1 param → 204
GET
/opportunities/deleted
List deleted opportunities
1 param → 200
GET
/opportunities/search
Search opportunities
1 param → 200
GET
/opportunities/{opportunityId}/parties
List additional parties on an opportunity
1 param → 200
POST
/opportunities/{opportunityId}/parties/{partyId}
Add an additional party to an opportunity
2 params → 201
DELETE
/opportunities/{opportunityId}/parties/{partyId}
Remove an additional party from an opportunity
2 params → 204
GET
/parties/{partyId}/opportunities
List opportunities for a party
1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed is OpportunityEnvelope (1 property). Each schema is shown below with its type and property counts.

Party
object
OpportunityEnvelope
object
1 property
Opportunity
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

capsule-opportunities-api-openapi.yml Raw ↑

Other APIs Capsule publishes across the network.

Capsule Parties API
Capsule Projects API
Capsule Tasks API