---
title: "Retrieve the pipeline"
method: GET
path: "/v1/finder/pipeline"
tags: ["RecruitAffiliates.ai"]
---

# Retrieve the pipeline

`GET /v1/finder/pipeline`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/finder/pipeline`
- Auth: HTTP bearer

The brand's saved prospects by stage, up to 100 cards a stage, with the board's five numbers.

**Scope:** `finder:read` (or `finder:write`)

## Query parameters

- `brand_id` string: Which brand. Defaults to the organization's oldest.
- `channel` 'website' | 'youtube' | 'podcast' | 'instagram' | 'tiktok'
- `country` string
- `assignee` string: A user id, or `unassigned`
- `list_id` string: Prefixed id (`fls_…`)
- `tag` string

## Response `200`

The board

- FinderPipeline
  - `object` 'finder_pipeline', required
  - `brand_id` string, required: Prefixed id (`fbr_…`)
  - `columns` object[], required
    - `stage` 'saved' | 'contacting' | 'replied' | 'negotiating' | 'onboarding' | 'activated' | 'no_reply' | 'declined' | 'on_hold', required
    - `count` integer, required: Every card in the stage; `cards` holds up to 100
    - `cards` FinderPipelineCard[], required
      - `prospect_id` string, required: Prefixed id (`fdi_…`)
      - `name` string, required
      - `channel` 'website' | 'youtube' | 'podcast' | 'instagram' | 'tiktok', required
      - `url` string, nullable, required
      - `stage` 'saved' | 'contacting' | 'replied' | 'negotiating' | 'onboarding' | 'activated' | 'no_reply' | 'declined' | 'on_hold', required
      - `assignee_user_id` string, nullable, required
      - `tags` string[], required
      - `deal` object, nullable, required
        - `id` string, required: Prefixed id (`fdl_…`)
        - `status` string, required
      - `campaign_id` string, nullable, required
      - `lane_id` string, nullable, required: The lane the card sits in inside its stage, from `GET /lanes`, or null for the stage's main column
      - `follow_up_on` string, nullable, required: The follow-up date a teammate set, `YYYY-MM-DD`, or null. The card shows as due from the start of that day (UTC).
      - `updated_at` string, date-time, required: ISO-8601, UTC
  - `metrics` FinderPipelineMetric[], required
    - `key` string, required
    - `label` string, required
    - `all_time` number, nullable, required
    - `last_30_days` number, nullable, required

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `402`: The organization's Recruit Affiliates plan does not include the API
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `409`: In conflict with the object's state, or the same idempotent request is still running
- `422`: The request was understood and refused
- `429`: Rate limited, by key or by organization: see Retry-After and X-RateLimit-Scope
- `501`: Not available to a test key (`sandbox_no_send`)

---

[API](https://skmtc.dev/affiliaterail/apis/affiliaterail-api.md) · [All operations](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/llms.txt) · [OpenAPI document](https://skmtc.dev/affiliaterail/apis/affiliaterail-api/revisions/ea41f345c092?raw)