v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Deals

View Deal

This endpoint doesn't consume Apollo credits. Learn more about API pricing and credits.

<a href="https://knowledge.apollo.io/hc/en-us/articles/4415062467725-Deals-Overview" target="_blank">Deals</a> on Apollo help you track sales opportunities. Use the View Deal endpoint to retrieve complete details about a deal within your team's Apollo account. Deal information can include the ID of the deal owner, the monetary value of the deal, the deal stage, and general details about the account. This endpoint requires a master API key. If you call the endpoint without a master key, you receive a 403 response. Check out <a href="https://docs.apollo.io/docs/create-api-key">Create an API Key</a> to learn how to create a master key.

get/opportunities/{opportunity_id}

Path parameters

opportunity_idstring required

The ID for the deal you want to view. Each deal in the Apollo database is assigned a unique ID. To find deal IDs, call the <a href="https://docs.apollo.io/reference/list-all-deals" target="_blank">List All Deals endpoint</a> and identify the value for id for the desired deal. Example: 66e09ea8e3cfcf01b2208ec7

Response

200

Example response

{
  "opportunity": {
    "id": "66e09ea8e3cfcf01b2208ec7",
    "team_id": "6095a710bd01d100a506d4ac",
    "owner_id": "66302798d03b9601c7934ebf",
    "amount": 99999999,
    "account_id": "60afffecbff6de00a4b82be7",
    "name": "Massive Space Deal",
    "opportunity_stage_id": "6095a710bd01d100a506d4bd",
    "source": "api",
    "created_at": "2024-09-10T19:31:52.436Z",
    "forecast_category": "pipeline",
    "deal_probability": 10,
    "created_by_id": "60affe7d6e270a00f5db6fe4",
    "opportunity_pipeline_id": "654b989fcb2a5200010a90db",
    "stage_updated_at": "2024-09-10T19:33:40.529+00:00",
    "exchange_rate_code": "USD",
    "exchange_rate_value": 1,
    "amount_in_team_currency": 99999999,
    "forecasted_revenue": 9999999.9,
    "last_activity_date": "2024-09-10T19:33:40.529Z",
    "existence_level": "full",
    "currency": {
      "name": "US Dollar",
      "iso_code": "USD",
      "symbol": "$"
    },
    "account": {
      "id": "60afffecbff6de00a4b82be7",
      "domain": "nasa.gov",
      "name": "NASA - National Aeronautics and Space Administration",
      "team_id": "6095a710bd01d100a506d4ac",
      "organization_id": "55e16cfbf3e5bb66cf0026f3",
      "account_stage_id": "6095a710bd01d100a506d4b9",
      "source": "deployment",
      "original_source": "deployment",
      "created_at": "2021-05-27T20:24:12.644Z",
      "phone": "+1 202-555-0117",
      "phone_status": "no_status",
      "sanitized_phone": "+12025550117",
      "account_rule_config_statuses": [
        {
          "_id": "6466e8047759270001e53509",
          "rule_action_config_id": "64650edd434f8f00a3b13938",
          "rule_config_id": "64650edd434f8f00a3b13939",
          "status_cd": "completed",
          "id": "6466e8047759270001e53509",
          "key": "6466e8047759270001e53509"
        }
      ],
      "existence_level": "full",
      "label_ids": [
        "6466e8261e13be000133f25d"
      ],
      "modality": "account",
      "source_display_name": "Requested from Apollo"
    }
  }
}