How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Twenty opportunities API

Opportunity/deal CRM records

Twenty opportunities API is one of 17 APIs that Twenty publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 3 JSON Schema definitions.

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

This API exposes 5 operations across 2 paths, and defines 9 schemas. It is described by OpenAPI 3.2.0, at version v0.1.

Requests are made against a single base URL, https://api.twenty.com/rest/core.

5 operations 2 paths 9 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v0.1
Server
https://api.twenty.com/rest/core
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — Workspace-scoped Bearer token. Generate from Settings → Playground in your Twenty workspace.

Paths & Operations 5

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

opportunities 5

Opportunity/deal CRM records

GET
/opportunities
Find Many Opportunities
findManyOpportunities 6 params → 200400401
POST
/opportunities
Create One Opportunity
createOneOpportunity 2 params body → 201400401
GET
/opportunities/{id}
Find One Opportunity
findOneOpportunity 2 params → 200400401
PATCH
/opportunities/{id}
Update One Opportunity
updateOneOpportunity 2 params body → 200400401
DELETE
/opportunities/{id}
Delete One Opportunity
deleteOneOpportunity 1 param → 200400401

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Opportunity (14 properties), OpportunityInput (7 properties), ActorMetadata (4 properties), PageInfo (4 properties). Each schema is shown below with its type and property counts.

OpportunityListResponse
object
1 property
PageInfo
object
4 properties
OpportunityResponse
object
1 property
Opportunity
object
14 properties
CurrencyMetadata
object
Monetary amount with currency code
2 properties
DeleteResponse
object
1 property
ActorMetadata
object
Record of who created or last updated an object
4 properties
ErrorResponse
object
3 properties
OpportunityInput
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

twenty-opportunities-api-openapi.yml Raw ↑

Other APIs Twenty publishes across the network.

Twenty companies API
Twenty fields API
Twenty notes API
Twenty objects API
Twenty openapi API
Twenty people API
Twenty relations API
Twenty tasks API
Twenty GraphQL API
Twenty Companies API
Twenty Metadata - Fields API
Twenty Metadata - Objects API
Where this information came from

This is an independent, third-party profile of Twenty opportunities API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.