Capsule Parties API
The Parties API from Capsule — 5 operation(s) for parties.
Capsule Parties API is one of 4 APIs that Capsule publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Parties. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes 8 operations across 5 paths, and defines 2 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Capsule Parties 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 8
Across 5 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is PartyEnvelope (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Capsule 3
Other APIs Capsule publishes across the network.