Get Lead - Puffle Docs

Get Lead

curl --request GET \
  --url https://app.puffle.ai/api/leads \
  --header 'Authorization: Bearer <token>'

{
  "leads": [
    {
      "id": "<string>",
      "type": "person",
      "name": {
        "full": "<string>",
        "short": "<string>",
        "aliases": [
          "<string>"
        ],
        "first": "<string>",
        "last": "<string>"
      },
      "lists": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "sources": [
        {
          "id": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "location": {
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "raw": "<string>"
      },
      "socials": [
        {
          "url": "<string>"
        }
      ],
      "contacts": [
        {
          "value": "<string>"
        }
      ],
      "attributes": {},
      "raw": {},
      "title": "<string>",
      "company": {
        "name": "<string>",
        "id": "<string>",
        "domain": "<string>"
      }
    }
  ],
  "nextCursor": "<string>"
}

GET

api

leads

Get Lead

curl --request GET \
  --url https://app.puffle.ai/api/leads \
  --header 'Authorization: Bearer <token>'

{
  "leads": [
    {
      "id": "<string>",
      "type": "person",
      "name": {
        "full": "<string>",
        "short": "<string>",
        "aliases": [
          "<string>"
        ],
        "first": "<string>",
        "last": "<string>"
      },
      "lists": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ],
      "sources": [
        {
          "id": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "location": {
        "city": "<string>",
        "state": "<string>",
        "country": "<string>",
        "raw": "<string>"
      },
      "socials": [
        {
          "url": "<string>"
        }
      ],
      "contacts": [
        {
          "value": "<string>"
        }
      ],
      "attributes": {},
      "raw": {},
      "title": "<string>",
      "company": {
        "name": "<string>",
        "id": "<string>",
        "domain": "<string>"
      }
    }
  ],
  "nextCursor": "<string>"
}

CLI:

puffle lead
puffle lead --id <id> --type <type> --limit <limit> --cursor <cursor> --q <q> --name <name> --title <title> --role <role> --company <company> --domain <domain> --email <email> --industry <industry> --location <location>

Overview

Returns Leads for the effective user. Pass id to fetch one Lead. Otherwise, use type, limit, and cursor to page through workspace Leads by person or company. Use q for broad saved-Lead filtering across name, role/title, company, domain, industry, location, and work email fields. Use the narrower filters when you already know the field: name, title, role, company, domain, email, industry, or location. Use this endpoint when you need Leads across the whole workspace. Lists group these same Leads; they do not own separate copies of Lead data.

AI agent notes

Use this endpoint when you need Lead records independent of any single List. If you are rendering a List screen, prefer the List view or List Leads endpoints because they include membership and view-field context.The response is paginated. Keep the returned cursor and stop when no next cursor is present.

Authorizations

Authorization

string

header

required

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

Query Parameters

string

type

enum<string>

Available options:

person,

company

limit

integer

Required range: 1 <= x <= 500

cursor

string

Broad text filter across saved Lead name, role/title, company, domain, industry, location, and work email fields.