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

# User Lists

`GET /v3/lists`

This endpoint allows you to retrieve the information of the user's lists. Query parameters are supported. Extra filters can be added (e.g. name[like]=myFirstList).

## Query parameters

- `limit` integer
- `skip` integer
- `offset` string

## Response `200`

Successfully retrieved the user lists information

- ListsResponse
  - `meta` MetadataDTO
    - `timestamp` integer, required — Transaction's date in timestamp
    - `transactionId` string, required — Id for the current transaction (Endpoint's call)
    - `explain` string — Explain string in case of failure
  - `pagination` PageDTO — pagination information
    - `offset` string — start point
    - `limit` integer — items to be displayed by page
    - `next` string — next item to be consulted in the following invocation
    - `page` integer — current page of data
    - `pages` integer — total amount of pages in the response
    - `total` integer — total amount of items in the response
  - `items` ListDTO[] — lists of owner
    - `id` integer, required — list id
    - `columns` Column[], required — list's columns
      - `name` string, required
      - `type` 'STRING' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'OBJECT', required
      - `defaultValue` string
      - `indexed` boolean
      - `required` boolean
      - `unique` boolean
      - `customConfiguration` object
    - `name` string, required — list's name
    - `userName` string, required — list's owner
    - `size` integer, required — list's size
    - `key` string, required — list's key
    - `autoId` boolean, required — Whether list uses or not an autogenerated key
    - `usesAutoColumns` boolean, required — Whether list uses or not an autogenerated default columns
    - `caseSensitive` boolean, required — Whether list uses or not case sensitive attribute for its columns's name
    - `usesGeneratedData` boolean, required — Whether list uses or not an autogenerated dummy data to fill unique columns with not data
    - `lastUpdated` string, date-time, required — last updated date in UTC
    - `createdAt` string, date-time, required — created updated date in UTC
    - `tags` string[], required — list's tags
    - `status` 'UPLOADING' | 'CREATED' | 'UPDATING' | 'OK' | 'FAILED_UPDATE', required — list's status
    - `totalLines` integer, required — Total lines read from last file used, if used, for adding users
    - `percentProcessed` integer, required — list's percentage when being created for first time with contacts
    - `listConfiguration` object, required — list's metadata

## Other responses

- `404` — Resource not found
- `500` — Internal server error

---

[API](https://skmtc.dev/messangi/apis/raven.md) · [All operations](https://skmtc.dev/messangi/apis/raven/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/messangi/raven/revisions/c87f398fa338/schema)