Twenty

Twenty Opportunities API

Opportunity/deal CRM records

GitHub OpenAPI
Business capability
Opportunity & Pipeline Management BC-410.30

Operations 5

GET /opportunities Find Many Opportunities #
POST /opportunities Create One Opportunity #
GET /opportunities/{id} Find One Opportunity #
PATCH /opportunities/{id} Update One Opportunity #
DELETE /opportunities/{id} Delete One Opportunity #

Documentation

📖
Documentation
https://docs.twenty.com/developers/extend/api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/twenty/openapi/twenty-opportunities-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/twenty/json-schema/twenty-opportunity.json

Other Resources

🔗
Examples
https://artifacts.apis.io/twenty/examples/twenty-create-company.json
🔗
Examples
https://artifacts.apis.io/twenty/examples/twenty-list-companies.json
🔗
Examples
https://artifacts.apis.io/twenty/examples/twenty-create-custom-object.json
🔗
GraphQL
https://artifacts.apis.io/twenty/graphql/twenty-graphql.md

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/twenty:twenty-opportunities-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

twenty-opportunities-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Twenty Core Opportunities API
  description: The Twenty Core API provides REST endpoints for CRUD operations on all CRM records including companies, people, opportunities, notes, tasks, and any custom objects defined in a workspace.
  version: v0.1
  contact:
    email: felix@twenty.com
  license:
    name: AGPL-3.0
    url: https://github.com/twentyhq/twenty?tab=License-1-ov-file#readme
  termsOfService: https://github.com/twentyhq/twenty?tab=coc-ov-file#readme
servers:
- url: https://api.twenty.com/rest/core
  description: Production
security:
- bearerAuth: []
tags:
- name: Opportunities
  description: Opportunity/deal CRM records
paths:
  /opportunities:
    get:
      tags:
      - Opportunities
      summary: Find Many Opportunities
      operationId: findManyOpportunities
      parameters:
      - $ref: '#/components/parameters/filter'
      - $ref: '#/components/parameters/orderBy'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/startingAfter'
      - $ref: '#/components/parameters/endingBefore'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityListResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
    post:
      tags:
      - Opportunities
      summary: Create One Opportunity
      operationId: createOneOpportunity
      parameters:
      - $ref: '#/components/parameters/depth'
      - $ref: '#/components/parameters/upsert'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpportunityInput'
            example:
              name: New Deal with Acme
              stage: NEW
              amount:
                amountMicros: 50000000000
                currencyCode: USD
              closeDate: '2026-12-31'
      responses:
        '201':
          description: Opportunity created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
  /opportunities/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      tags:
      - Opportunities
      summary: Find One Opportunity
      operationId: findOneOpportunity
      parameters:
      - $ref: '#/components/parameters/depth'
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
    patch:
      tags:
      - Opportunities
      summary: Update One Opportunity
      operationId: updateOneOpportunity
      parameters:
      - $ref: '#/components/parameters/depth'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OpportunityInput'
      responses:
        '200':
          description: Opportunity updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OpportunityResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
    delete:
      tags:
      - Opportunities
      summary: Delete One Opportunity
      operationId: deleteOneOpportunity
      responses:
        '200':
          description: Opportunity deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
components:
  responses:
    '400':
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    '401':
      description: Unauthorized - missing or invalid Bearer token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            statusCode: 403
            messages:
            - Missing authentication token
            error: FORBIDDEN_EXCEPTION
  schemas:
    OpportunityResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            opportunity:
              $ref: '#/components/schemas/Opportunity'
    ActorMetadata:
      type: object
      description: Record of who created or last updated an object
      properties:
        source:
          type: string
          enum:
          - EMAIL
          - CALENDAR
          - API
          - IMPORT
          - MANUAL
          - SYSTEM
          - WORKFLOW
          - WEBHOOK
        workspaceMemberId:
          type:
          - string
          - 'null'
          format: uuid
        name:
          type:
          - string
          - 'null'
        context:
          type:
          - object
          - 'null'
    DeleteResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
              format: uuid
    ErrorResponse:
      type: object
      properties:
        statusCode:
          type: integer
        messages:
          type: array
          items:
            type: string
        error:
          type: string
    OpportunityListResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            opportunities:
              type: object
              properties:
                edges:
                  type: array
                  items:
                    type: object
                    properties:
                      node:
                        $ref: '#/components/schemas/Opportunity'
                      cursor:
                        type: string
                pageInfo:
                  $ref: '#/components/schemas/PageInfo'
                totalCount:
                  type: integer
    Opportunity:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
        createdAt:
          type: string
          format: date-time
          readOnly: true
        updatedAt:
          type: string
          format: date-time
          readOnly: true
        deletedAt:
          type:
          - string
          - 'null'
          format: date-time
          readOnly: true
        name:
          type: string
        stage:
          type: string
          enum:
          - NEW
          - SCREENING
          - MEETING
          - PROPOSAL
          - CUSTOMER
        amount:
          allOf:
          - $ref: '#/components/schemas/CurrencyMetadata'
        closeDate:
          type:
          - string
          - 'null'
          format: date
        position:
          type: number
        companyId:
          type:
          - string
          - 'null'
          format: uuid
        pointOfContactId:
          type:
          - string
          - 'null'
          format: uuid
        ownerId:
          type:
          - string
          - 'null'
          format: uuid
        createdBy:
          $ref: '#/components/schemas/ActorMetadata'
        updatedBy:
          $ref: '#/components/schemas/ActorMetadata'
    CurrencyMetadata:
      type: object
      description: Monetary amount with currency code
      properties:
        amountMicros:
          type:
          - integer
          - 'null'
          format: int64
          description: Amount in micros (e.g. 1000000 = 1.00)
        currencyCode:
          type:
          - string
          - 'null'
          description: ISO 4217 currency code
          example: USD
    PageInfo:
      type: object
      properties:
        hasNextPage:
          type: boolean
        hasPreviousPage:
          type: boolean
        startCursor:
          type:
          - string
          - 'null'
        endCursor:
          type:
          - string
          - 'null'
    OpportunityInput:
      type: object
      properties:
        name:
          type: string
        stage:
          type: string
          enum:
          - NEW
          - SCREENING
          - MEETING
          - PROPOSAL
          - CUSTOMER
        amount:
          $ref: '#/components/schemas/CurrencyMetadata'
        closeDate:
          type: string
          format: date
        companyId:
          type: string
          format: uuid
        pointOfContactId:
          type: string
          format: uuid
        ownerId:
          type: string
          format: uuid
  parameters:
    limit:
      name: limit
      in: query
      required: false
      description: Maximum number of records to return (default 60, max 60).
      schema:
        type: integer
        minimum: 0
        maximum: 60
        default: 60
    endingBefore:
      name: ending_before
      in: query
      required: false
      description: Cursor for backward pagination (use startCursor from current response).
      schema:
        type: string
    startingAfter:
      name: starting_after
      in: query
      required: false
      description: Cursor for forward pagination (use endCursor from previous response).
      schema:
        type: string
    id:
      name: id
      in: path
      required: true
      description: Object UUID
      schema:
        type: string
        format: uuid
    orderBy:
      name: order_by
      in: query
      required: false
      description: 'Ordering. Format: field1,field2[DIRECTION]. Directions: AscNullsFirst, AscNullsLast, DescNullsFirst, DescNullsLast.

        '
      schema:
        type: string
      examples:
        simple:
          value: createdAt
        complex:
          value: id[AscNullsFirst],createdAt[DescNullsLast]
    depth:
      name: depth
      in: query
      required: false
      description: 'Depth of nested relations to include. 0 = primary object only; 1 = primary object + direct relations.

        '
      schema:
        type: integer
        enum:
        - 0
        - 1
        default: 1
    filter:
      name: filter
      in: query
      required: false
      description: 'Filter expression. Format: field[COMPARATOR]:value. Multiple conditions separated by comma (AND). Supports eq, neq, in, is, gt, gte, lt, lte, like, ilike, startsWith, containsAny. Composable with and(), or(), not().

        '
      schema:
        type: string
      examples:
        simple:
          value: name[eq]:"Acme"
        dateRange:
          value: createdAt[gte]:"2024-01-01"
        composite:
          value: emails.primaryEmail[eq]:foo@example.com
        logical:
          value: or(stage[eq]:"NEW",stage[eq]:"IN_PROGRESS")
    upsert:
      name: upsert
      in: query
      required: false
      description: If true, creates or updates if record already exists.
      schema:
        type: boolean
        default: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Workspace-scoped Bearer token. Generate from Settings → Playground in your Twenty workspace.

        '
externalDocs:
  description: Twenty Developer Documentation
  url: https://docs.twenty.com/developers/extend/api