Lists
v1
Retrieve Lists
Retrieve all lists available in the account. The response includes each list's attributes and can be filtered through query parameters.
Credit Note: Retrieving list definitions does not consume credits.
:::info Requires the lists:read OAuth2 scope. :::
get/v1/lists
Query parameters
account_idstring required
The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.
page[num]integer
Page of results to fetch.
page[size]integer
The number of items per page. Maximum is 100.
filter[scope]'company' | 'contact' required
Filter by entities that apply to either company or contact.
Response
Success
Example response
{
"data": [
{
"type": "list",
"id": "company_123",
"attributes": {
"name": "US Prospects",
"scope": "company",
"created_at": "2024-12-10T15:57:25Z",
"updated_at": "2024-11-24T11:50:00Z"
},
"relationships": {
"created_by": {
"id": "12345"
}
}
}
],
"meta": {
"pagination": {
"page_num": 1,
"page_count": 1,
"total_count": 1
},
"request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
}
}