v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Tasks

Search for Tasks

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

<a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion. Use the Search for Tasks endpoint to find tasks that your team has created in Apollo. To protect Apollo's performance for all users, this endpoint has a display limit of 50,000 records (100 records per page, up to 500 pages). Add more filters to narrow your search results as much as possible. 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.

post/tasks/search

Query parameters

sort_by_fieldstring

Sort the tasks by 1 of the following options: <ul> <li> task_due_at: The most future-dated first. </li> <li> task_priority: The highest priority first. </li> </ul>

open_factor_names[]string[]

Enter task_types for this parameter to return a count of tasks by task type. When used, the response includes a "task_types": [] array with a "count" value for each task type.

pageinteger

The page number of the Apollo data that you want to retrieve. Use this parameter in combination with the per_page parameter to make search results for navigable and improve the performance of the endpoint. 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. Use the page parameter to search the different pages of data. Example: 10

Response

200

pipeline_totalinteger

{"stackTrail":"paths:/tasks/search:post:responses:200:content:application/json:schema:properties:num_fetch_result","oasType":"schema","type":"unknown"}

Example response

{
  "tasks": [
    {
      "id": "66e8cc45028aed019c25d724",
      "user_id": "66a3d80d4238fe02d2baaaaf",
      "created_at": "2024-09-17T00:24:37.436Z",
      "due_at": "2024-09-21T00:00:00.000+00:00",
      "type": "action_item",
      "priority": "medium",
      "status": "scheduled",
      "opportunity_id": "66e8c4567f32a501b2605004",
      "title": "Reminder - Schedule Demo Call",
      "creator_id": "60affe7d6e270a00f5db6fe4",
      "opportunity": {
        "id": "66e8c4567f32a501b2605004",
        "team_id": "6095a710bd01d100a506d4ac",
        "owner_id": "66a3d80d4238fe02d2baaaaf",
        "amount": 3000,
        "closed_date": "2024-11-03T00:00:00.000+00:00",
        "account_id": "612f9d6cd26c290001d9bda0",
        "name": "5 Seats of Acme | $2K | Google",
        "opportunity_stage_id": "66e4b9b5e5aa6b0e57f078a1",
        "source": "ui_form",
        "created_at": "2024-09-16T23:50:46.311Z",
        "next_step": "Schedule Demo",
        "forecast_category": "omitted",
        "deal_probability": 50,
        "created_by_id": "60affe7d6e270a00f5db6fe4",
        "opportunity_pipeline_id": "66e4b85ce5aa6b03f3f08b6e",
        "stage_updated_at": "2024-09-17T16:44:07.133+00:00",
        "next_step_last_updated_at": "2024-09-17T00:03:13.420+00:00",
        "exchange_rate_code": "USD",
        "exchange_rate_value": 1,
        "amount_in_team_currency": 3000,
        "forecasted_revenue": 1500,
        "last_activity_date": "2024-09-17T16:44:07.134Z",
        "existence_level": "full",
        "typed_custom_fields": {
          "6095a711bd01d100a506d4da": [
            "6153414ac0559d00016ce5eb"
          ],
          "6095a711bd01d100a506d4dc": [
            "6153414ac0559d00016ce5f3"
          ],
          "66e4ba346fe95a073461e00e": [
            "66e4ba346fe95a073461e00c"
          ]
        },
        "opportunity_contact_roles": [
          {
            "id": "66e8c9d7320e8a01b44f1e82",
            "contact_id": "665c3338da53130001243ac4",
            "is_primary": true,
            "created_at": "2024-09-17T00:14:15.655Z",
            "updated_at": "2024-09-17T00:14:15.655Z",
            "role": [
              {
                "opportunity_contact_role_type_id": "64288550ffb0470001cbf2b0",
                "is_primary": true
              }
            ]
          }
        ],
        "currency": {
          "name": "US Dollar",
          "iso_code": "USD",
          "symbol": "$"
        },
        "account": {
          "id": "612f9d6cd26c290001d9bda0",
          "domain": "google.com",
          "name": "Google",
          "team_id": "6095a710bd01d100a506d4ac",
          "organization_id": "5fc93db64c38d300d6aa24e6",
          "account_stage_id": "6095a710bd01d100a506d4b9",
          "source": "csv_import",
          "original_source": "csv_import",
          "created_at": "2021-09-01T15:34:04.371Z",
          "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": "Uploaded from CSV"
        }
      }
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 3,
    "total_entries": 179,
    "total_pages": 60
  },
  "faceting": {
    "task_types": [
      {
        "value": "contact_call",
        "display_name": "Call Contact",
        "count": 30
      }
    ],
    "total_facets": [
      {
        "value": "pipeline_total",
        "display_name": "Total",
        "count": 179
      }
    ]
  },
  "pipeline_total": 179
}