---
title: "GET /api/lists"
method: GET
path: "/api/lists"
tags: ["Lists"]
---

# GET /api/lists

`GET /api/lists`

## Request

- Base URL: `https://api.gmass.co`
- URL: `https://api.gmass.co/api/lists`
- Auth: none declared

## Query parameters

- `limit` integer
- `offset` integer
- `page` integer
- `search` string
- `q` string

## Response `200`

OK

- ListSearchResults
  - `count` integer
  - `offset` integer
  - `limit` integer
  - `total` integer
  - `lists` ListDetails[]
    - `id` integer
    - `aliasAddress` string
    - `spreadSheetName` string
    - `workSheetName` string
    - `columns` string
    - `filterCriteria` string
    - `andOr` string
    - `creationDate` string, date-time
    - `addressCount` integer

---

[API](https://skmtc.dev/gmass/apis/gmass-api.md) - [All operations](https://skmtc.dev/gmass/apis/gmass-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gmass/apis/gmass-api/revisions/0498e4a9c765?raw)
