v1

latestOpenAPI 3.1.02026-07-247601.0 MB
Deals

List All Deals

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.<br><br>Use the List All Deals endpoint to retrieve every deal that has been created for your team's Apollo account.<br><br>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/search

Query parameters

sort_by_fieldstring

Sort the tasks by 1 of the following options: <ul> <li> amount: The largest deal values first. </li> <li> is_closed: Deals that have been closed first. </li> <li> is_won: Deals that have been won first. </li> </ul>

pageinteger

The page number of the Apollo data that you want to retrieve. <br><br>Use this parameter in combination with the per_page parameter to make search results for navigable and improve the performance of the endpoint. <br><br>Example: 4

per_pageinteger

The number of search results that should be returned for each page. Limiting the number of results per page improves the endpoint's performance. <br><br>Use the page parameter to search the different pages of data. <br><br>Example: 10

Response

200

partial_results_onlyboolean
has_joinboolean
disable_eu_prospectingboolean
partial_results_limitinteger
{"stackTrail":"paths:/opportunities/search:get:responses:200:content:application/json:schema:properties:num_fetch_result","oasType":"schema","type":"unknown"}

Example response

{
  "opportunities": [
    {
      "id": "66e09ea8e3cfcf01b2208ec7",
      "team_id": "6095a710bd01d100a506d4ac",
      "owner_id": "66302798d03b9601c7934ebf",
      "amount": 9999999999,
      "closed_date": "2026-10-15T00:00:00.000+00:00",
      "account_id": "60afffecbff6de00a4b82be7",
      "name": "Ridiculously Massive Space Deal",
      "opportunity_stage_id": "66bb94fbc1695c00017fba5f",
      "source": "api",
      "created_at": "2024-09-10T19:31:52.436Z",
      "forecast_category": "pipeline",
      "deal_probability": 25,
      "created_by_id": "60affe7d6e270a00f5db6fe4",
      "stage_updated_at": "2024-09-10T21:50:18.113+00:00",
      "exchange_rate_code": "USD",
      "exchange_rate_value": 1,
      "amount_in_team_currency": 9999999999,
      "forecasted_revenue": 2499999999.75,
      "last_activity_date": "2024-09-10T21:50:18.113Z",
      "existence_level": "full",
      "currency": {
        "name": "US Dollar",
        "iso_code": "USD",
        "symbol": "$"
      },
      "account": {
        "id": "60afffecbff6de00a4b82be7",
        "name": "NASA - National Aeronautics and Space Administration",
        "website_url": "http://www.nasa.gov",
        "linkedin_url": "http://www.linkedin.com/company/nasa",
        "twitter_url": "https://twitter.com/NASA",
        "facebook_url": "http://www.facebook.com/NASAJPL",
        "primary_phone": {
          "number": "+1 202-555-0117",
          "source": "Owler",
          "sanitized_number": "+12025550117"
        },
        "languages": [
          "English"
        ],
        "alexa_ranking": 1751,
        "phone": "+1 202-555-0117",
        "linkedin_uid": "2003",
        "founded_year": 1958,
        "publicly_traded_exchange": "nyse",
        "logo_url": "https://zenprospect-production.s3.amazonaws.com/uploads/pictures/139afb7258561417c1d70d4c/picture",
        "primary_domain": "nasa.gov",
        "sanitized_phone": "+12025550117",
        "domain": "nasa.gov",
        "team_id": "6095a710bd01d100a506d4ac",
        "organization_id": "55e16cfbf3e5bb66cf0026f3",
        "account_stage_id": "6095a710bd01d100a506d4b9",
        "source": "deployment",
        "original_source": "deployment",
        "created_at": "2021-05-27T20:24:12.644Z",
        "phone_status": "no_status",
        "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",
        "num_contacts": 2
      }
    }
  ],
  "partial_results_limit": 10000,
  "pagination": {
    "page": 1,
    "per_page": 3,
    "total_entries": 35,
    "total_pages": 12
  }
}