GET
/
v1
/
lists
curl https://api.pipeium.com/v1/lists \
  -H "Authorization: Bearer YOUR_API_KEY"

[
  {
    "id": "list_123",
    "name": "Tech Startups Q1 2024",
    "created_at": "2024-03-20T10:00:00Z",
    "updated_at": "2024-03-20T15:30:00Z",
    "signals": 2,
    "enrichments": 1
  }
]

​
List All Lists

Returns a list of all your lists.

​
Response

​
id
string

Unique identifier for the list

​
name
string

Name of the list

​
created_at
string

ISO timestamp when the list was created

​
updated_at
string

ISO timestamp when the list was last updated

​
signals
number

Number of signals configured for this list

​
enrichments
number

Number of enrichment jobs run on this list

curl https://api.pipeium.com/v1/lists \
  -H "Authorization: Bearer YOUR_API_KEY"

[
  {
    "id": "list_123",
    "name": "Tech Startups Q1 2024",
    "created_at": "2024-03-20T10:00:00Z",
    "updated_at": "2024-03-20T15:30:00Z",
    "signals": 2,
    "enrichments": 1
  }
]

​
Get Single List

GET /v1/lists/{listId}

Returns detailed information about a specific list.

​
Path Parameters

​
listId
string
required

The ID of the list to retrieve

​
Response

​
id
string

Unique identifier for the list

​
name
string

Name of the list

​
data
array

Array of prospect data objects

​
mappings
object

Field mappings used for this list

​
webhook_url
string

Webhook URL for notifications (if configured)

​
enrichments
array

Array of enrichment jobs run on this list

​
signals
array

Array of signals configured for this list

curl https://api.pipeium.com/v1/lists/list_123 \
  -H "Authorization: Bearer YOUR_API_KEY"

{
  "id": "list_123",
  "name": "Tech Startups Q1 2024",
  "data": [
    {
      "name": "John Smith",
      "company": "Acme Inc",
      "domain": "acme.com",
      "linkedin": "https://linkedin.com/in/johnsmith"
    }
  ],
  "mappings": {
    "first_name": "name",
    "website": "domain",
    "company_name": "company",
    "linkedin_url": "linkedin"
  },
  "webhook_url": "https://your-domain.com/webhook",
  "enrichments": [...],
  "signals": [...]
}