{
  "url": "https://telipot.com/catalog/capabilities/email.sequences.search",
  "id": "email.sequences.search",
  "description": "Email outreach sequences in the credential's own account that match a name",
  "platform": "email",
  "providers": [
    {
      "slug": "apollo",
      "name": "Apollo"
    }
  ],
  "tasks": 1,
  "taskPages": [
    {
      "id": "apollo.email.sequences.search",
      "name": "Outreach sequences in the account by name, with ID, status",
      "provider": {
        "slug": "apollo",
        "name": "Apollo"
      },
      "capability": "email.sequences.search",
      "platform": "email",
      "kind": "data",
      "tier": "core",
      "identity": "key",
      "identityLabel": "Your plan",
      "price": {
        "amount": "Free",
        "state": "free",
        "label": "Free",
        "detail": "Free from the tool",
        "type": "free"
      },
      "providers": 1,
      "retention": "standard",
      "runsOn": "free",
      "live": true,
      "summary": "Use the search for sequences endpoint to search for the sequences that have been created for your team's Apollo account.",
      "method": "POST",
      "path": "/emailer_campaigns/search",
      "host": "https://api.apollo.io/api/v1",
      "docsUrl": "https://docs.apollo.io/reference/search-for-sequences",
      "auth": {
        "scheme": "api_key",
        "label": "api_key · in header as x-api-key",
        "short": "api_key · x-api-key"
      },
      "scope": "own_account",
      "principal": "organization",
      "requiredScopes": [],
      "verification": {
        "state": "none",
        "label": "Not verified yet",
        "detail": "Not checked yet. We test with a real request before we mark it."
      },
      "input": [
        {
          "name": "q_name",
          "location": "queryParams",
          "type": "string",
          "required": false,
          "constraints": [],
          "note": "Keywords matching part of a sequence's name; marketing finds NY Marketing Sequence but not NY Marketer Conference. Searches names only."
        },
        {
          "name": "page",
          "location": "queryParams",
          "type": "integer",
          "required": false,
          "constraints": [
            "at least 1"
          ],
          "note": "Page to return; use with per_page."
        },
        {
          "name": "per_page",
          "location": "queryParams",
          "type": "integer",
          "required": false,
          "constraints": [
            "at least 1"
          ],
          "note": "Results per page."
        }
      ],
      "sampleInput": {},
      "inputSchema": {
        "type": "object",
        "properties": {
          "q_name": {
            "type": "string",
            "description": "Keywords matching part of a sequence's name; marketing finds NY Marketing Sequence but not NY Marketer Conference. Searches names only.",
            "examples": [
              "marketing"
            ]
          },
          "page": {
            "type": "integer",
            "description": "Page to return; use with per_page.",
            "examples": [
              1
            ],
            "minimum": 1
          },
          "per_page": {
            "type": "integer",
            "description": "Results per page.",
            "examples": [
              10
            ],
            "minimum": 1
          }
        },
        "additionalProperties": false
      },
      "output": [
        {
          "name": "pagination",
          "type": "object"
        },
        {
          "name": "emailer_campaigns",
          "type": "object[]"
        }
      ],
      "outputSchema": {
        "type": "object",
        "properties": {
          "pagination": {
            "type": "object",
            "properties": {
              "page": {
                "type": "integer"
              },
              "per_page": {
                "type": "integer"
              },
              "total_entries": {
                "type": "integer"
              },
              "total_pages": {
                "type": "integer"
              }
            }
          },
          "emailer_campaigns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string"
                },
                "name": {
                  "type": "string"
                },
                "archived": {
                  "type": "boolean"
                },
                "active": {
                  "type": "boolean"
                },
                "created_at": {
                  "type": "string"
                },
                "user_id": {
                  "type": "string"
                },
                "emailer_schedule_id": {
                  "type": "string"
                },
                "num_steps": {
                  "type": "integer"
                },
                "label_ids": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "commands": {
        "mode": "inspect",
        "cli": "telipot inspect apollo.email.sequences.search",
        "http": "curl https://api.telipot.com/v1/tasks/apollo.email.sequences.search \\\n  -H \"Authorization: Bearer $TELIPOT_TOKEN\""
      },
      "siblings": []
    }
  ]
}