Skip to main content

GET lists

Fetch multiple lists. GET /user-api/v1/lists

Headers

Query Parameters

string
Number of records to return (Default:25)
string
Number of records to skip (Default:0)
string
Sort order: created_at:asc, created_at:desc, name:asc, name:desc
string
Related data to include: contacts, companies
string
Filter by list type: CONTACT, COMPANY

Response

With Include Paramters

GET /user-api/v1/lists?include=contacts,companies&type=CONTACT

Response with all includes (CONTACT list)

Response with all includes (COMPANY list)

GET a List

Fetch one list. GET /user-api/v1/lists/:id

Path Parameters

string
List ID

Query Parameters

string
Related data to include: contacts, companies

Endpoint Example

GET /user-api/v1/lists/list_12345?include=contacts

Response