Capsule

Capsule Opportunities API

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

GitHub OpenAPI

Operations 11

GET /opportunities List opportunities
POST /opportunities Create an opportunity
GET /opportunities/{opportunityId} Show an opportunity
PUT /opportunities/{opportunityId} Update an opportunity
DELETE /opportunities/{opportunityId} Delete an opportunity
GET /opportunities/deleted List deleted opportunities
GET /opportunities/search Search opportunities
GET /opportunities/{opportunityId}/parties List additional parties on an opportunity
POST /opportunities/{opportunityId}/parties/{partyId} Add an additional party to an opportunity
DELETE /opportunities/{opportunityId}/parties/{partyId} Remove an additional party from an opportunity
GET /parties/{partyId}/opportunities List opportunities for a party

Documentation

📖
Documentation
https://developer.capsulecrm.com/
📖
Authentication
https://developer.capsulecrm.com/v2/overview/authentication

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/capsule/refs/heads/main/openapi/capsule-opportunities-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/capsule/refs/heads/main/overlays/capsule-opportunities-api-overlay.yaml
🔗
Webhooks
https://developer.capsulecrm.com/v2/overview/avoid-polling-with-rest-hooks
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/capsule/refs/heads/main/apis.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/capsule-opportunities-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

capsule-opportunities-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Capsule CRM REST Opportunities API
  description: 'Capsule CRM v2 REST API for parties (contacts and companies),

    opportunities, projects (kases), and tasks. Authentication uses

    OAuth 2.0 bearer tokens (authorization code flow) or personal

    access tokens.


    This specification is a best-effort, hand-authored representation of

    the publicly documented operations at https://developer.capsulecrm.com/.

    Request bodies and response schemas are modeled generically; refer to

    the developer docs for the full property set per resource.

    '
  version: 2.0.0
  contact:
    name: Capsule CRM
    url: https://developer.capsulecrm.com/
servers:
- url: https://api.capsulecrm.com/api/v2
  description: Production
security:
- bearerAuth: []
tags:
- name: Opportunities
paths:
  /opportunities:
    get:
      tags:
      - Opportunities
      summary: List opportunities
      parameters:
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/PerPage'
      responses:
        '200':
          $ref: '#/components/responses/OpportunityList'
    post:
      tags:
      - Opportunities
      summary: Create an opportunity
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpportunityEnvelope'
      responses:
        '201':
          $ref: '#/components/responses/OpportunityObject'
  /opportunities/{opportunityId}:
    parameters:
    - $ref: '#/components/parameters/OpportunityId'
    get:
      tags:
      - Opportunities
      summary: Show an opportunity
      responses:
        '200':
          $ref: '#/components/responses/OpportunityObject'
    put:
      tags:
      - Opportunities
      summary: Update an opportunity
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpportunityEnvelope'
      responses:
        '200':
          $ref: '#/components/responses/OpportunityObject'
    delete:
      tags:
      - Opportunities
      summary: Delete an opportunity
      responses:
        '204':
          description: Deleted
  /opportunities/deleted:
    get:
      tags:
      - Opportunities
      summary: List deleted opportunities
      parameters:
      - in: query
        name: since
        schema:
          type: string
          format: date-time
      responses:
        '200':
          $ref: '#/components/responses/OpportunityList'
  /opportunities/search:
    get:
      tags:
      - Opportunities
      summary: Search opportunities
      parameters:
      - in: query
        name: q
        schema:
          type: string
      responses:
        '200':
          $ref: '#/components/responses/OpportunityList'
  /opportunities/{opportunityId}/parties:
    parameters:
    - $ref: '#/components/parameters/OpportunityId'
    get:
      tags:
      - Opportunities
      summary: List additional parties on an opportunity
      responses:
        '200':
          $ref: '#/components/responses/PartyList'
  /opportunities/{opportunityId}/parties/{partyId}:
    parameters:
    - $ref: '#/components/parameters/OpportunityId'
    - $ref: '#/components/parameters/PartyId'
    post:
      tags:
      - Opportunities
      summary: Add an additional party to an opportunity
      responses:
        '201':
          $ref: '#/components/responses/Generic'
    delete:
      tags:
      - Opportunities
      summary: Remove an additional party from an opportunity
      responses:
        '204':
          description: Removed
  /parties/{partyId}/opportunities:
    parameters:
    - $ref: '#/components/parameters/PartyId'
    get:
      tags:
      - Opportunities
      summary: List opportunities for a party
      responses:
        '200':
          $ref: '#/components/responses/OpportunityList'
components:
  responses:
    Generic:
      description: Operation accepted.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: true
    OpportunityObject:
      description: Opportunity envelope.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OpportunityEnvelope'
    OpportunityList:
      description: List of opportunities.
      content:
        application/json:
          schema:
            type: object
            properties:
              opportunities:
                type: array
                items:
                  $ref: '#/components/schemas/Opportunity'
    PartyList:
      description: List of parties.
      content:
        application/json:
          schema:
            type: object
            properties:
              parties:
                type: array
                items:
                  $ref: '#/components/schemas/Party'
  schemas:
    Opportunity:
      type: object
      additionalProperties: true
    OpportunityEnvelope:
      type: object
      properties:
        opportunity:
          $ref: '#/components/schemas/Opportunity'
    Party:
      type: object
      additionalProperties: true
  parameters:
    PartyId:
      in: path
      name: partyId
      required: true
      schema:
        type: string
    PerPage:
      in: query
      name: perPage
      schema:
        type: integer
    Page:
      in: query
      name: page
      schema:
        type: integer
    OpportunityId:
      in: path
      name: opportunityId
      required: true
      schema:
        type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: '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://api.capsulecrm.com/oauth/token.

        '