Skip to main content
GET
/
api
/
lists
/
{id}
/
columns
List columns on a list
curl --request GET \
  --url https://app.puffle.ai/api/lists/{id}/columns \
  --header 'Authorization: Bearer <token>'
{
  "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": 4503599627370495,
      "schema": {
        "type": "text",
        "format": "plain",
        "currency": "USD",
        "scale": "none",
        "textFormat": "short",
        "options": [
          "<string>"
        ],
        "itemType": "text",
        "maxItems": 4503599627370495,
        "linkType": "generic"
      },
      "enrichmentType": "work_email",
      "config": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "isPreview": true,
      "category": "built-in",
      "builtInKey": "<string>"
    }
  ]
}

​
Overview

Return every non-preview column on the list, ordered by position ascending. Preview columns (created during enrichment preview) are filtered out. Optional subject query param limits results to person or company columns.
This operation shares the URL path /api/lists/{id}/columns 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. Must be owned by the caller.

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

​
subject
enum<string>

Filter to only person or company columns. Omit to return both.

Available options:
person,
company

Response

Columns for this list. Empty array is a valid response for a brand-new list that hasn't been seeded.

​
columns
object[]
required