​
GET lists

Fetch multiple lists.

GET /user-api/v1/lists

​
Headers

HeaderValue
x-rolodex-api-keyf1e2d3c4b5a697...

​
Query Parameters

​
limit
string

Number of records to return (Default:25)

​
offset
string

Number of records to skip (Default:0)

​
order by
string

Sort order: created_at:asc, created_at:desc, name:asc, name:desc

​
include
string

Related data to include: contacts, companies

​
type
string

Filter by list type: CONTACT, COMPANY

​
Response

{
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 50
  },
  "data": [
    {
      "id": "list_12345",
      "name": "Q1 Prospects",
      "description": "High-priority prospects for Q1 outreach",
      "type": "CONTACT",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "list_67890",
      "name": "Enterprise Clients",
      "description": "Large enterprise companies we're targeting",
      "type": "COMPANY",
      "created_at": "2025-01-14T09:15:00Z",
      "updated_at": "2025-01-14T09:15:00Z"
    }
  ]
}

​
With Include Paramters

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

​
Response with all includes (CONTACT list)

{
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 50
  },
  "data": [
    {
      "id": "list_12345",
      "name": "Q1 Prospects",
      "description": "High-priority prospects for Q1 outreach",
      "type": "CONTACT",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z",
      "contacts": [
        {
          "id": "contact_123",
          "full_name": "John Doe",
          "image_url": "<https://example.com/avatar.jpg>"
        }
      ]
    }
  ]
}

​
Response with all includes (COMPANY list)

{
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 50
  },
  "data": [
    {
      "id": "list_67890",
      "name": "Enterprise Clients",
      "description": "Large enterprise companies we're targeting",
      "type": "COMPANY",
      "created_at": "2025-01-14T09:15:00Z",
      "updated_at": "2025-01-14T09:15:00Z",
      "companies": [
        {
          "id": "company_456",
          "name": "Acme Corp",
          "logo_url": "<https://example.com/logo.png>"
        }
      ]
    }
  ]
}

​
GET a List

Fetch one list.

GET /user-api/v1/lists/:id

​
Path Parameters

​
id
string

List ID

​
Query Parameters

​
include
string

Related data to include: contacts, companies

​
Endpoint Example

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

​
Response

{
  "data": {
    "id": "list_12345",
    "name": "Q1 Prospects",
    "description": "High-priority prospects for Q1 outreach",
    "type": "CONTACT",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  }
}