---
updatedAt: 2026-07-20T06:33:37.000Z
agentTools:
  projectIndex: https://docs.paymongo.com/llms.txt
---

# Get deal

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "contact": {
      "name": "Sales and Marketing Experience Team"
    },
    "description": "Sales API owns PayMongo's internal sales CRM: the organization/company\ncatalog, contacts, leads, deals and pipeline stages, sales activities and\ntrackers, notes, tags, tickets, and account invitations. Called by the\ninternal admin dashboard on behalf of authenticated PayMongo sales admins.\n",
    "title": "Sales API",
    "version": "1.0.0",
    "summary": "Internal sales CRM — organizations, contacts, leads, deals, pipelines, activities, and tickets.",
    "license": {
      "name": "PayMongo Internal",
      "identifier": "LicenseRef-PayMongo-Internal"
    },
    "x-paymongo-service-slug": "sales-api",
    "x-paymongo-service-tier": "tier-2",
    "x-paymongo-owner-slack": "#sales-api-channel",
    "x-paymongo-repo": "https://github.com/paymongo/sales-api",
    "x-paymongo-data-classification": "internal"
  },
  "servers": [
    {
      "url": "https://sales-api.paymongo.com",
      "description": "Production"
    },
    {
      "url": "https://sales-api.paymongo-uat.com",
      "description": "UAT"
    },
    {
      "url": "https://sales-api.paymongo-stg.com",
      "description": "Staging"
    }
  ],
  "tags": [
    {
      "name": "Deals",
      "description": "Deals and their lifecycle through pipeline stages."
    }
  ],
  "paths": {
    "/v1/internal/deals/{deal_id}": {
      "get": {
        "parameters": [
          {
            "description": "Deal ID",
            "example": "deal_0123456789abcdef01234567",
            "in": "path",
            "name": "deal_id",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "*/*": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ResponseRootDTO"
                    },
                    {
                      "properties": {
                        "data": {
                          "$ref": "#/components/schemas/GetDealResDTO"
                        }
                      },
                      "type": "object"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseRootDTO"
                }
              }
            }
          },
          "404": {
            "description": "Not Found",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseRootDTO"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorResponseRootDTO"
                }
              }
            }
          }
        },
        "security": [
          {
            "BearerAuth": []
          }
        ],
        "summary": "Get deal",
        "tags": [
          "Deals"
        ],
        "operationId": "get_internal_deals"
      }
    }
  },
  "components": {
    "schemas": {
      "ActivityRelationshipItemDTO": {
        "properties": {
          "body_preview": {
            "type": "string"
          },
          "created_at": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "due_at": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "id": {
            "example": "act_0123456789abcdef01234567",
            "type": "string"
          },
          "is_completed": {
            "example": true,
            "type": "boolean"
          },
          "subject": {
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ContactEmailDTO": {
        "properties": {
          "email": {
            "example": "juan@example.com",
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ContactRelationshipItemDTO": {
        "properties": {
          "association_role": {
            "example": "decision_maker",
            "type": "string"
          },
          "email": {
            "items": {
              "$ref": "#/components/schemas/ContactEmailDTO"
            },
            "type": "array"
          },
          "first_name": {
            "example": "Juan",
            "type": "string"
          },
          "id": {
            "example": "cnt_0123456789abcdef01234567",
            "type": "string"
          },
          "last_name": {
            "example": "Dela Cruz",
            "type": "string"
          },
          "phones": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "role": {
            "example": "CEO",
            "type": "string"
          }
        },
        "type": "object"
      },
      "LeadRelationshipItemDTO": {
        "properties": {
          "id": {
            "example": "lead_0123456789abcdef01234567",
            "type": "string"
          },
          "name": {
            "example": "Acme Corp",
            "type": "string"
          },
          "source": {
            "example": "website",
            "type": "string"
          },
          "stage_id": {
            "example": "stg_0123456789abcdef01234567",
            "type": "string"
          },
          "type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "NoteRelationshipItemDTO": {
        "properties": {
          "content_preview": {
            "type": "string"
          },
          "created_at": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "id": {
            "example": "note_0123456789abcdef01234567",
            "type": "string"
          }
        },
        "type": "object"
      },
      "OrganizationTagItemDTO": {
        "properties": {
          "color": {
            "type": "string"
          },
          "id": {
            "example": "tag_0123456789abcdef01234567",
            "type": "string"
          },
          "name": {
            "example": "Acme Corp",
            "type": "string"
          }
        },
        "type": "object"
      },
      "RelatedOrganizationItemDTO": {
        "properties": {
          "customer_locations": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "email": {
            "example": "juan@example.com",
            "type": "string"
          },
          "icp_tier": {
            "example": "tier_1",
            "type": "string"
          },
          "id": {
            "example": "sorg_0123456789abcdef01234567",
            "type": "string"
          },
          "is_target_account": {
            "type": "boolean"
          },
          "name": {
            "example": "Acme Corp",
            "type": "string"
          },
          "phone": {
            "example": "+639171234567",
            "type": "string"
          },
          "sector_group": {
            "example": "Financial Services",
            "type": "string"
          },
          "sector_mapping": {
            "example": "Professional Services",
            "type": "string"
          },
          "tpv_segment": {
            "example": "Large Enterprise",
            "type": "string"
          }
        },
        "type": "object"
      },
      "RelationshipListActivityDTO": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ActivityRelationshipItemDTO"
            },
            "type": "array"
          },
          "total": {
            "example": 42,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "RelationshipListContactDTO": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/ContactRelationshipItemDTO"
            },
            "type": "array"
          },
          "total": {
            "example": 42,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "RelationshipListLeadDTO": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/LeadRelationshipItemDTO"
            },
            "type": "array"
          },
          "total": {
            "example": 42,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "RelationshipListNoteDTO": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/NoteRelationshipItemDTO"
            },
            "type": "array"
          },
          "total": {
            "example": 42,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "RelationshipListOrganizationTagDTO": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/OrganizationTagItemDTO"
            },
            "type": "array"
          },
          "total": {
            "example": 42,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "RelationshipListRelatedOrganizationDTO": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/RelatedOrganizationItemDTO"
            },
            "type": "array"
          },
          "total": {
            "example": 42,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "RelationshipListTicketDTO": {
        "properties": {
          "items": {
            "items": {
              "$ref": "#/components/schemas/TicketRelationshipItemDTO"
            },
            "type": "array"
          },
          "total": {
            "example": 42,
            "type": "integer"
          }
        },
        "type": "object"
      },
      "TicketRelationshipItemDTO": {
        "properties": {
          "id": {
            "example": "tkt_0123456789abcdef01234567",
            "type": "string"
          },
          "priority": {
            "example": "high",
            "type": "string"
          },
          "status": {
            "type": "string"
          },
          "title": {
            "example": "Payment onboarding issue",
            "type": "string"
          }
        },
        "type": "object"
      },
      "OwnerResDTO": {
        "properties": {
          "email": {
            "example": "kam@example.com",
            "type": "string"
          },
          "first_name": {
            "example": "Jane",
            "type": "string"
          },
          "id": {
            "example": "12345678",
            "type": "string"
          },
          "last_name": {
            "example": "Doe",
            "type": "string"
          },
          "status": {
            "example": "active",
            "type": "string"
          }
        },
        "type": "object"
      },
      "PipelineResDTO": {
        "properties": {
          "created_at": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "deal_type": {
            "example": "acquisition",
            "type": "string"
          },
          "description": {
            "example": "Sample description",
            "type": "string"
          },
          "entity_type": {
            "example": "deal",
            "type": "string"
          },
          "id": {
            "example": "pipe_0123456789abcdef01234567",
            "type": "string"
          },
          "is_default": {
            "example": true,
            "type": "boolean"
          },
          "name": {
            "example": "Acme Corp",
            "type": "string"
          },
          "updated_at": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          }
        },
        "type": "object"
      },
      "StageResDTO": {
        "properties": {
          "created_at": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "display_order": {
            "type": "integer"
          },
          "id": {
            "example": "pipe_0123456789abcdef01234567",
            "type": "string"
          },
          "is_closed": {
            "example": false,
            "type": "boolean"
          },
          "is_won": {
            "example": false,
            "type": "boolean"
          },
          "name": {
            "example": "Acme Corp",
            "type": "string"
          },
          "pipeline_id": {
            "example": "pipe_0123456789abcdef01234567",
            "type": "string"
          },
          "updated_at": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "win_probability": {
            "type": "number"
          }
        },
        "type": "object"
      },
      "ErrorCode": {
        "enum": [
          "invalid_query_parameters",
          "invalid_request_body",
          "parameter_required",
          "not_found",
          "unauthorized",
          "internal_server_error"
        ],
        "type": "string",
        "x-enum-varnames": [
          "ErrInvalidQueryParameters",
          "ErrInvalidRequestBody",
          "ErrParameterRequired",
          "ErrNotFound",
          "ErrUnauthorized",
          "ErrInternalServerError"
        ]
      },
      "ErrorDetail": {
        "description": "Details about a specific error",
        "properties": {
          "code": {
            "allOf": [
              {
                "$ref": "#/components/schemas/ErrorCode"
              }
            ],
            "description": "Code is an application-specific error code, expressed as a string value.",
            "example": "invalid_request_body"
          },
          "detail": {
            "description": "Detail is a human-readable explanation specific to this occurrence of the problem.",
            "example": "Explanation of error code for this case",
            "type": "string"
          },
          "source": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Source"
              }
            ],
            "description": "Source is an object containing references to the primary source of the error"
          }
        },
        "type": "object"
      },
      "ErrorResponseRootDTO": {
        "description": "Standard error response containing one or more errors",
        "properties": {
          "errors": {
            "description": "Error objects MUST be returned as an array keyed by `errors` in the top level of a JSON:API document.",
            "items": {
              "$ref": "#/components/schemas/ErrorDetail"
            },
            "type": "array"
          }
        },
        "type": "object"
      },
      "ResponseRootDTO": {
        "properties": {
          "data": {}
        },
        "type": "object"
      },
      "Source": {
        "description": "Source of the error, providing context like JSON Pointer or query parameter",
        "properties": {
          "header": {
            "description": "Header indicates the name of a single request header which caused the error.",
            "example": "X-Header-Name",
            "type": "string"
          },
          "parameter": {
            "description": "Parameter indicates which URI query parameter caused the error.",
            "example": "field_name",
            "type": "string"
          },
          "pointer": {
            "description": "Pointer is a \"JSON Pointer\" [RFC6901] to the value in the request document that caused the error.",
            "example": "/data/customers/0/attributes/name",
            "type": "string"
          }
        },
        "type": "object"
      },
      "GetDealResDTO": {
        "properties": {
          "activities": {
            "$ref": "#/components/schemas/RelationshipListActivityDTO"
          },
          "business_group": {
            "type": "string"
          },
          "close_details": {
            "type": "string"
          },
          "close_won_reason": {
            "type": "string"
          },
          "closed_at": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "competitors": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "contacts": {
            "$ref": "#/components/schemas/RelationshipListContactDTO"
          },
          "created_at": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "critical_event": {
            "type": "string"
          },
          "critical_event_date": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "currency_code": {
            "type": "string"
          },
          "current_state": {
            "type": "string"
          },
          "current_update": {
            "description": "latest note content",
            "type": "string"
          },
          "daily_incremental_gp": {
            "type": "number"
          },
          "deal_health_status": {
            "type": "string"
          },
          "decision_criteria": {
            "type": "string"
          },
          "decision_maker": {
            "$ref": "#/components/schemas/ContactRelationshipItemDTO"
          },
          "decision_maker_id": {
            "example": "cnt_0123456789abcdef01234567",
            "type": "string"
          },
          "decision_process": {
            "type": "string"
          },
          "description": {
            "example": "Sample description",
            "type": "string"
          },
          "expected_close_date": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "forecast_category": {
            "type": "string"
          },
          "forecast_probability": {
            "type": "number"
          },
          "help_needed": {
            "example": true,
            "type": "boolean"
          },
          "help_needed_detail": {
            "type": "string"
          },
          "id": {
            "example": "deal_0123456789abcdef01234567",
            "type": "string"
          },
          "impact": {
            "type": "string"
          },
          "included_in_forecast": {
            "example": true,
            "type": "boolean"
          },
          "is_closed": {
            "example": true,
            "type": "boolean"
          },
          "is_won": {
            "example": true,
            "type": "boolean"
          },
          "leads": {
            "$ref": "#/components/schemas/RelationshipListLeadDTO"
          },
          "loss_reason": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "lost_to_competitor_details": {
            "type": "string"
          },
          "monthly_incremental_gp": {
            "type": "number"
          },
          "monthly_incremental_tpv": {
            "type": "number"
          },
          "name": {
            "example": "Acme Corp",
            "type": "string"
          },
          "next_update": {
            "description": "earliest open activity subject",
            "type": "string"
          },
          "next_update_date": {
            "description": "earliest open activity due date",
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "notes": {
            "$ref": "#/components/schemas/RelationshipListNoteDTO"
          },
          "organizations": {
            "$ref": "#/components/schemas/RelationshipListRelatedOrganizationDTO"
          },
          "outcome": {
            "enum": [
              "open",
              "won",
              "lost"
            ],
            "example": "open",
            "type": "string"
          },
          "outreach_start_date": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "owners": {
            "items": {
              "$ref": "#/components/schemas/OwnerResDTO"
            },
            "type": "array"
          },
          "pipeline": {
            "$ref": "#/components/schemas/PipelineResDTO"
          },
          "pipeline_id": {
            "example": "pipe_0123456789abcdef01234567",
            "type": "string"
          },
          "point_person": {
            "$ref": "#/components/schemas/ContactRelationshipItemDTO"
          },
          "point_person_id": {
            "example": "cnt_0123456789abcdef01234567",
            "type": "string"
          },
          "presenting_problem": {
            "type": "string"
          },
          "priority": {
            "example": "high",
            "type": "string"
          },
          "root_cause": {
            "type": "string"
          },
          "stage": {
            "$ref": "#/components/schemas/StageResDTO"
          },
          "stage_id": {
            "example": "stg_0123456789abcdef01234567",
            "type": "string"
          },
          "tags": {
            "$ref": "#/components/schemas/RelationshipListOrganizationTagDTO"
          },
          "tickets": {
            "$ref": "#/components/schemas/RelationshipListTicketDTO"
          },
          "updated_at": {
            "example": "2026-07-01 10:00:00+00:00",
            "type": "string"
          },
          "value_drivers": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "Admin access token (JWT) for PayMongo internal dashboard users; admin-only operations require an admin_id claim."
      }
    }
  }
}
```