---
title: "Get the details of a specific list"
method: GET
path: "/api/v2/lists/{id}"
tags: ["Lists"]
---

# Get the details of a specific list

`GET /api/v2/lists/{id}`

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Lists/getList" target="_blank">Try in sandbox</a><br>

## Path parameters

- `id` integer, required

## Response `200`

Returned when successful.

- List
  - `id` integer, required — List ID.
  - `name` string, required — List name.
  - `description` string, nullable, required — Description of the list.
  - `favorited` boolean, required — Is the List favorited? See [Favorites list](https://docs.textmagic.com/#operation/getFavourites).
  - `membersCount` integer, required — List members count.
  - `user` User, nullable, required
    - `id` integer, required — User ID.
    - `displayTimeFormat` '12h' | '24h' — User's preferred format of time display: * *12h* - AM/PM format; * *24h* - 24-hour clock format.
    - `username` string, required — Username.
    - `firstName` string, required — Account first name.
    - `lastName` string, required — Account last name.
    - `email` string, required — User email address.
    - `status` 'A' | 'T', required — Current account status: * **A** for Active; * **T** for Trial.
    - `balance` number, required — Account balance (in account currency).
    - `phone` string, nullable, required — User's phone number.
    - `company` string, nullable, required — Account company name.
    - `currency` Currency, required
      - `id` string, required — The 3-letter ISO currency ID.
      - `unicodeSymbol` string, required — Unicode-compatible currency symbol.
      - `htmlSymbol` string, required — HTML-compatible currency symbol.
    - `country` Country, nullable, required
      - `id` string, required — The 2-letter ISO country ID.
      - `name` string, required — Full country name.
    - `timezone` Timezone, required
      - `id` integer, required — Internal timezone ID.
      - `area` string, required — Timezone area.
      - `dst` integer, required — Is daylight saving time used in this timezone?
      - `offset` integer, required — Offset from UTC time in seconds. In this example, it is 21600/60/60=6 hours.
      - `timezone` string, required — User-friendly timezone name (with spaces replaced by underscores).
    - `subaccountType` 'P' | 'A' | 'U', required — Type of account: * **P** for Parent User; * **A** for Administrator Sub-Account; * **U** for Regular User.
    - `emailAccepted` boolean, required — Does the account have a confirmed email?
    - `phoneAccepted` boolean, required — Does the account have a confirmed phone number?
    - `avatar` UserImage, nullable, required
      - `href` string, required — The URI of a user avatar.
  - `service` boolean, required — Internal service field.
  - `shared` boolean, nullable, required — Is the list **shared** among all sub-accounts?
  - `avatar` ListImage, nullable, required
    - `href` string, required — The URI of a list avatar.
  - `isDefault` boolean, nullable, required — Indicates that List is used as a default. All new contacts added via the Web-app will be added in this List by default.

## Other responses

- `401` — Unauthorized request.
- `404` — Request data not found.

---

[API](https://skmtc.net/textmagic/apis/textmagic-api.md) · [All operations](https://skmtc.net/textmagic/apis/textmagic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/textmagic/textmagic-api/revisions/3e4029d19684/schema)
