---
title: "Get Information About All Lists"
method: GET
path: "/get-lists.json"
tags: ["Reporting"]
---

# Get Information About All Lists

`GET /get-lists.json`

## Request

- Base URL: `https://api.transmitsms.com`
- URL: `https://api.transmitsms.com/get-lists.json`
- Auth: HTTP basic

Get information about all lists in your account
This will return metadata on all your lists

## Pagination

This endpoint supports pagination using the page/max pattern:

**Parameters:**
- `page`: Page number starting from 1 (default: 1)
- `max`: Maximum results per page (default: varies, recommended: 10-50)

**Response Structure:**
The response includes pagination metadata:
- `page.count`: Total number of pages available
- `page.number`: Current page number
- `lists_total`: Total count of lists in your account

**Navigation Examples:**
```
# First page of lists (default)
GET /get-lists.json

# Second page with 20 results per page
GET /get-lists.json?page=2&max=20

# Get all lists with larger page size
GET /get-lists.json?max=50

# Navigate through all pages
GET /get-lists.json?page=1&max=25
GET /get-lists.json?page=2&max=25
# Continue until page.number >= page.count
```

**Best Practices:**
- Use max=10-25 for UI display purposes
- Use max=50 for administrative tasks or bulk operations
- Check page.count to determine if more pages exist
- For accounts with many lists, use appropriate page sizes to balance performance and usability
- Consider filtering or searching if you need specific lists rather than paginating through all

## Query parameters

- `page` integer
- `max` integer
- `response_style` 'array'

## Response `200`

Successful response containing information about the lists in your account.

- object
  - `lists_total` integer: Count of the number of lists in your account
  - `lists` object[]
    - `id` integer: Numeric ID of the list
    - `name` string: Name of the list
    - `created` string, date-time: Date and time that the list was first created. Returned in ISO8601 format YYYY-MM-DD HH:MM:SS in UTC Timezone.
    - `members_active` integer: Count of active members on the list
    - `fields` string[]: Custom field name. List of custom field names by field_n where n is an integer between 1 and 10.
    - `members_total` integer: Total number of contacts on the list

## Changes

- **2026-11-03** `486bd23529d2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/kudosity/apis/transmit-sms-api/changes/get-lists.json/get.md)

---

[API](https://skmtc.dev/kudosity/apis/transmit-sms-api.md) - [All operations](https://skmtc.dev/kudosity/apis/transmit-sms-api/llms.txt) - [OpenAPI document](https://skmtc.dev/kudosity/apis/transmit-sms-api/revisions/486bd23529d2?raw)