Skip to main content
GET
/
api
/
lists
/
{id}
/
companies
List companies in a list
curl --request GET \
  --url https://app.puffle.ai/api/lists/{id}/companies \
  --header 'Authorization: Bearer <token>'
{
  "companies": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain": "<string>",
      "linkedinUrl": "<string>",
      "name": "<string>",
      "industry": "<string>",
      "employeeCount": "<string>",
      "employeeCountExact": 0,
      "foundedYear": 0,
      "fundingStage": "<string>",
      "fundingTotal": 123,
      "location": "<string>",
      "city": "<string>",
      "state": "<string>",
      "country": "<string>",
      "description": "<string>",
      "website": "<string>",
      "logoUrl": "<string>",
      "source": "<string>",
      "sourceId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "signals": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "signalType": "new_initiative",
          "title": "<string>",
          "postUrl": "<string>",
          "postDate": "<string>",
          "confidence": 123
        }
      ]
    }
  ],
  "columns": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "listId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "prompt": "<string>",
      "responseType": "auto",
      "source": "profile",
      "subject": "person",
      "isFilter": true,
      "position": 0,
      "schema": {
        "type": "<string>"
      },
      "enrichmentType": "work_email",
      "config": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "isPreview": true,
      "category": "built-in",
      "builtInKey": "<string>"
    }
  ],
  "cells": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "columnId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyRowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>",
      "status": "idle",
      "error": "<string>",
      "reasoning": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 4503599627370495,
  "limit": 4503599627370495,
  "offset": 4503599627370495,
  "hasMore": true
}

Overview

Paginated company-row view for a list. Returns the company rows (camelCase), their enrichment cells, and the company-subject column definitions needed to render a spreadsheet. Also attaches any matching buying-intent signals by LinkedIn URL for the caller. Pure read — no side effects.
This operation shares the URL path /api/lists/{id}/companies with other verbs. See the sibling page for related operations on the same resource.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

List UUID

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

limit
integer

Page size. Values over 500 are clamped to 500. Defaults to 100.

Required range: 1 <= x <= 500
offset
integer

Zero-indexed offset for pagination. Defaults to 0.

Required range: 0 <= x <= 9007199254740991

Response

Companies plus their columns, cells, and pagination counters.

companies
object[]
required

Paginated company rows for this list. Ordered by created_at DESC, id DESC for stable pagination.

columns
object[]
required

Company-subject columns (non-preview) for this list, ordered by position.

cells
object[]
required

Enrichment cells for the companies in this page only. Not a full cell dump.

total
integer
required

Total company rows in this list (ignoring pagination).

Required range: 0 <= x <= 9007199254740991
limit
integer
required
Required range: 0 < x <= 9007199254740991
offset
integer
required
Required range: 0 <= x <= 9007199254740991
hasMore
boolean
required

True when offset + companies.length < total.