Lists
v1
Get List Details
Retrieve the details of a specific list using its unique ID. The response includes the list's attributes, such as its name and scope, along with any related information requested through query parameters. This endpoint is used to fetch the full definition of a list before viewing, updating, or managing its assigned items.
Credit Note: Retrieving list definitions does not consume credits.
:::info Requires the lists:read OAuth2 scope. :::
get/v1/lists/{id}
Path parameters
idstring required
Unique identifier of the list (e.g. company_123)
Query parameters
account_idstring required
The Leadfeeder Account ID. The Account ID can be retrieved using the List Accounts endpoint.
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": {
"request_id": "cf054205-dd8c-4473-8689-07c30fe0789f"
}
}