Skip to main content
GET
/
api
/
v1
/
entities
/
leadlists
List Lead Lists
curl --request GET \
  --url https://api.example.com/api/v1/entities/leadlists \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "icpId": "660e8400-e29b-41d4-a716-446655440001",
    "name": "Q1 2024 Tech Startups",
    "type": "person",
    "startDate": "2024-01-01T00:00:00.000Z",
    "endDate": "2024-03-31T23:59:59.000Z",
    "personIds": ["lead_abc123", "lead_def456", "lead_ghi789"],
    "companyIds": [],
    "userIds": ["user_xyz789", "user_abc123"],
    "createdAt": "2024-01-02T10:30:00.000Z",
    "updatedAt": "2024-01-15T14:22:00.000Z"
  },
  {
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "icpId": null,
    "name": "Enterprise Accounts",
    "type": "company",
    "startDate": "2024-02-01T00:00:00.000Z",
    "endDate": "2024-06-30T23:59:59.000Z",
    "personIds": [],
    "companyIds": ["770e8400-e29b-41d4-a716-446655440001", "770e8400-e29b-41d4-a716-446655440002"],
    "userIds": ["user_xyz789"],
    "createdAt": "2024-02-01T09:00:00.000Z",
    "updatedAt": "2024-02-10T11:45:00.000Z"
  }
]
Retrieves a list of all lead lists that the currently authenticated user has access to. Lead lists are collections of leads (persons or companies) organized for sales prospecting campaigns.

​
Authentication

This endpoint requires authentication. The user must be signed in to access lead lists.
Users can only see lead lists they have been granted access to via the userIds field. Admin users can see all lead lists in the organization.

​
Request

This endpoint does not require any query parameters or request body.

​
Response

Returns an array of lead list objects.
​
leadlists
array
An array of lead list objects accessible to the user.

​
Response Examples

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "icpId": "660e8400-e29b-41d4-a716-446655440001",
    "name": "Q1 2024 Tech Startups",
    "type": "person",
    "startDate": "2024-01-01T00:00:00.000Z",
    "endDate": "2024-03-31T23:59:59.000Z",
    "personIds": ["lead_abc123", "lead_def456", "lead_ghi789"],
    "companyIds": [],
    "userIds": ["user_xyz789", "user_abc123"],
    "createdAt": "2024-01-02T10:30:00.000Z",
    "updatedAt": "2024-01-15T14:22:00.000Z"
  },
  {
    "id": "550e8400-e29b-41d4-a716-446655440002",
    "icpId": null,
    "name": "Enterprise Accounts",
    "type": "company",
    "startDate": "2024-02-01T00:00:00.000Z",
    "endDate": "2024-06-30T23:59:59.000Z",
    "personIds": [],
    "companyIds": ["770e8400-e29b-41d4-a716-446655440001", "770e8400-e29b-41d4-a716-446655440002"],
    "userIds": ["user_xyz789"],
    "createdAt": "2024-02-01T09:00:00.000Z",
    "updatedAt": "2024-02-10T11:45:00.000Z"
  }
]

​
Error Codes

Status CodeError CodeDescription
401UNAUTHORIZEDUser is not authenticated. Ensure a valid session exists.
500INTERNAL_ERRORAn unexpected server error occurred.