List Lead Lists

Saved lead lists: static lists (hand-picked) and segments (saved filters), with their member counts.

API key access

Needs the leads:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.

GET/api/v1/lists

Authorization

AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X GET "http://localhost:8000/api/v1/lists" \
  -H "X-Workspace-Id: string"

curl -X GET "http://localhost:8000/api/v1/lists" \  -H "X-Workspace-Id: string"

{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "kind": "static",
      "filters": {
        "status": [
          "string"
        ],
        "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
        "company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
        "q": "string",
        "title": "string",
        "industry": "string",
        "country": "st",
        "replied": true
      },
      "member_count": 0,
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ]
}

Authorization

Header Parameters

Response Body

200