---
title: "Get List"
method: GET
path: "/api/v1/lists/{list_id}"
tags: ["lists"]
---

# Get List

`GET /api/v1/lists/{list_id}`

## Path parameters

- `list_id` string, uuid, required

## Query parameters

- `page` integer
- `per_page` integer

## Response `200`

Successful Response

- ContactListDetailRead
  - `id` string, uuid, required
  - `tenant_id` string, uuid, required
  - `name` string, required
  - `description` string, nullable
  - `kind` 'static' | 'dynamic'
  - `membership_mode` 'accumulate' | 'live'
  - `criteria` Criteria — A versioned dynamic-list definition.
    - `version` integer
    - `match` 'all' | 'any'
    - `clauses` Clause[]
      - `field` string, required
      - `op` 'eq' | 'neq' | 'in' | 'gte' | 'lte' | 'is_true' | 'is_false', required
      - `value` union
        - string
        - integer
        - number
        - boolean
        - union[]
          - union
            - string
            - integer
            - number
            - boolean
    - `last_interaction_within_days` integer, nullable
    - `arriving_within_hours` integer, nullable
    - `in_house` boolean, nullable
    - `property_ids` string[], nullable
  - `created_by_user_id` string, uuid, nullable
  - `member_count` integer, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `members` ContactListMemberRead[]
    - `id` string, uuid, required
    - `kind` 'customer' | 'business', required
    - `customer_profile_id` string, uuid, nullable
    - `business_id` string, uuid, nullable
    - `name` string, nullable
    - `subtitle` string, nullable
    - `entered_at` string, date-time, nullable
  - `members_total` integer

## Other responses

- `404` — List not found
- `422` — Validation Error

---

[API](https://skmtc.dev/getanana/apis/cleon-api.md) · [All operations](https://skmtc.dev/getanana/apis/cleon-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getanana/cleon-api/revisions/c0f54348e251/schema)