> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metal.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a deal by external id

> Retrieves a deal using your own external identifier.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/deals/externalId={externalId}
openapi: 3.1.0
info:
  title: Metal API
  version: 1.0.0
  description: >-
    REST API for Metal, the AI context layer for financial firms. Manage
    companies, deals, people, documents, activities, enrichments, scores,
    screenings, lists, workflows, and more. All endpoints are versioned under
    /v1, return JSON, and are scoped to the organization that owns your API key.
  contact:
    name: Metal Support
    email: support@metal.ai
    url: https://www.metal.ai
servers:
  - url: https://api.metal.ai
    description: Production
security:
  - MetalClientId: []
    MetalApiKey: []
tags:
  - name: API keys
    description: Create, list, and revoke API keys.
  - name: Companies
    description: Manage and enrich companies.
  - name: Deals
    description: Track opportunities through your pipeline.
  - name: People
    description: Manage contacts and relationships.
  - name: Documents
    description: Search and retrieve ingested documents.
  - name: Activities
    description: Log and search meetings, calls, and other interactions.
  - name: Enrichments
    description: Read and write enriched property values on resources.
  - name: Scores
    description: Score companies and deals against scoring frameworks.
  - name: Screenings
    description: Run and manage AI-powered company screenings.
  - name: Lists
    description: Organize and enrich resources in bulk.
  - name: Tags
    description: Label companies, deals, and lists.
  - name: Industries
    description: Manage your organization's industry taxonomy.
  - name: Sectors
    description: Manage sectors within an industry.
  - name: Subsectors
    description: Manage subsectors within a sector.
  - name: Workflows
    description: Run and monitor AI workflows.
  - name: Data
    description: Query time-series metrics and observations.
  - name: Teams
    description: Manage deal teams and their members.
  - name: Workspaces
    description: Organize documents and data by workspace.
paths:
  /v1/deals/externalId={externalId}:
    get:
      tags:
        - Deals
      summary: Get a deal by external id
      description: Retrieves a deal using your own external identifier.
      operationId: getDealByExternalId
      parameters:
        - $ref: '#/components/parameters/ExternalIdPath'
      responses:
        '200':
          $ref: '#/components/responses/DealResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    ExternalIdPath:
      name: externalId
      in: path
      required: true
      description: The external id.
      schema:
        type: string
  responses:
    DealResponse:
      description: A deal.
      content:
        application/json:
          schema:
            type: object
            properties:
              data:
                $ref: '#/components/schemas/Deal'
    Unauthorized:
      description: Missing or invalid API key credentials.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: invalid api key or clientId
    NotFound:
      description: The resource does not exist in your organization.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: not found
  schemas:
    Deal:
      type: object
      properties:
        id:
          type: string
          example: 665f1c2a9b1e4a0012a3b4c5
        name:
          type: string
          example: Project Atlas
        companyId:
          type: string
          description: The target company's id.
        status:
          type: string
          enum:
            - ACTIVE
            - CLOSED
            - PASSED_DEAD
          description: Internal lifecycle status.
          example: ACTIVE
        stage:
          type: string
          enum:
            - SOURCED
            - SCREENED
            - IOI_TERM_SHEET
            - DUE_DILIGENCE
            - IC_MEETING
            - DEAL_CLOSING
            - PORTFOLIO_COMPANY
            - REALIZED
            - PASSED
            - DEAD
          description: Pipeline stage.
          example: DUE_DILIGENCE
        externalStatus:
          type: string
          description: Your firm's custom status label, when configured.
        externalStage:
          type: string
          description: Your firm's custom stage label, when configured.
        acquisitionType:
          type: string
          enum:
            - add_on
            - platform
          readOnly: true
          description: >-
            Derived, read-only classification of the deal. `add_on` if the deal
            has a platform company (an add-on acquisition under an existing
            portfolio company), otherwise `platform`. Computed on read from the
            deal's platform company; cannot be set via create, update, or any
            other write endpoint.
          example: platform
        owners:
          type: array
          items:
            $ref: '#/components/schemas/Reference'
        sector:
          type: string
        industry:
          type: string
        size:
          type: number
        notes:
          type: string
        externalReference:
          $ref: '#/components/schemas/ExternalReference'
    Error:
      type: object
      properties:
        error:
          type: string
          description: A human-readable error message.
    Reference:
      type: object
      description: A reference to another resource, such as a user or team.
      properties:
        id:
          type: string
        type:
          type: string
          description: The referenced resource type, e.g. "user" or "team".
    ExternalReference:
      type: object
      description: A structured reference to a record in an external source system.
      properties:
        source:
          type: string
          description: The external system, e.g. a CRM provider.
        id:
          type: string
          description: The record id in the external system.
  securitySchemes:
    MetalClientId:
      type: apiKey
      in: header
      name: x-metal-client-id
      description: The Client ID of your API key.
    MetalApiKey:
      type: apiKey
      in: header
      name: x-metal-api-key
      description: The secret value of your API key.

````