Outreach

Manage prospects and sequences in Outreach.io.

The OutreachResourceClient provides access to the Outreach API, allowing you to manage prospects, sequences, and other sales engagement data.

Usage

import { myOutreachClient } from "./clients";

const result = await myOutreachClient.invoke(
  "GET",
  "/api/v2/prospects",
  "list-prospects",
  {
    query: { "page[size]": "25" },
  }
);

if (result.ok && result.result.body.kind === "json") {
  console.log("Prospects:", result.result.body.value);
}

Inputs

The invoke method accepts the following arguments:

method · string · required

The HTTP method to use: "GET", "POST", "PUT", "PATCH", or "DELETE".

path · string · required

The Outreach API path (e.g., /api/v2/prospects).

invocationKey · string · required

A unique identifier for this operation.

options · object

Optional configuration object.

Show properties

query · Record<string, string | string[]>

Query parameters for filtering and pagination.

body · object

The request body for create/update operations.

timeoutMs · number

Timeout in milliseconds (default: 30000).

Outputs

The output format is the same as the Custom API client.

kind · "api"

Discriminator for the response type.

status · number

The HTTP status code.

body · ResponseBody

The response body (typically JSON).