Sign in

v1

latestOpenAPI 3.1.02026-07-247601.0 MB
Sequences

Search for Sequences

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

<a href="https://knowledge.apollo.io/hc/en-us/articles/4409237165837-Sequences-Overview" target="_blank">Sequences</a> are outreach campaigns that sales teams use to reach out to contacts over a planned period of time.<br><br>Use the Search for Sequences endpoint to search for the sequences that have 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.

post/emailer_campaigns/search

Query parameters

q_namestring

Add keywords to narrow the search of the sequences in your team's Apollo account. <br><br>Keywords should directly match at least part of a sequence's name. For example, searching the keyword marketing might return the result NY Marketing Sequence, but not NY Marketer Conference 2025 attendees. <br><br>This parameter only searches sequence names, not other sequence fields. <br><br>Example: marketing conference attendees

pagestring

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_pagestring

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

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

Example response

{
  "pagination": {
    "page": 1,
    "per_page": 5,
    "total_entries": 1,
    "total_pages": 1
  },
  "breadcrumbs": [
    {
      "label": "Name",
      "signal_field_name": "q_name",
      "value": "Copywriting Dublin",
      "display_name": "Copywriting Dublin"
    }
  ],
  "emailer_campaigns": [
    {
      "id": "66e9e215ece19801b219997f",
      "name": "Target Copywriting Clients in Dublin",
      "created_at": "2024-09-17T20:09:57.837Z",
      "emailer_schedule_id": "6095a711bd01d100a506d52a",
      "user_id": "66302798d03b9601c7934ebf",
      "excluded_account_stage_ids": [
        "6095a710bd01d100a506d4b8"
      ],
      "excluded_contact_stage_ids": [
        "6095a710bd01d100a506d4b5"
      ],
      "label_ids": [
        "66e9e215ece19801b2199980"
      ],
      "email_open_trigger_task_threshold": 3,
      "days_to_wait_before_mark_as_response": 5,
      "starred_by_user_ids": [
        "66302798d03b9601c7934ebf"
      ],
      "mark_finished_if_reply": true,
      "mark_finished_if_interested": true,
      "mark_paused_if_ooo": true,
      "permissions": "team_can_use",
      "sequence_ruleset_id": "6095a711bd01d100a506d4e0",
      "same_account_reply_delay_days": 30,
      "creation_type": "new",
      "num_steps": 3,
      "loaded_stats": true
    }
  ]
}