---
title: "Get Information About A List"
method: POST
path: "/get-list.json"
tags: ["Reporting"]
---

# Get Information About A List

`POST /get-list.json`

Get detailed information about a list, return custom fields and its contacts. 
This will return paginated information regarding individual contacts on a list and their data.

## Response `200`

Successful response containing information about the list and its members.

- object
  - `members_total` integer — Count of number of contacts on list. This will include deleted contacts.
  - `id` integer — Numeric ID of the list.
  - `name` string — Name of the list.
  - `created` string, date-time — Date list was first created. Returned in ISO8601 format YYYY-MM-DD HH:MM:SS in UTC Timezone.
  - `members_active` integer — Count of active contacts on list.
  - `fields` string[] — List of custom field names.
  - `members` object[] — Information about contacts on the list.
    - `list_id` integer — Numeric ID of the list contact is on.
    - `msisdn` integer — Mobile number of contact.
    - `first_name` string — First name of contact.
    - `last_name` string — Last name of contact.
    - `created_at` string, date-time — Date and time that contact was first added to list. Returned in ISO8601 format YYYY-MM-DD HH:MM:SS in UTC Timezone.
    - `status` 'active' | 'inactive' — Status of contact.
    - `fields` object

---

[API](https://skmtc.net/kudosity/apis/transmit-sms-api.md) · [All operations](https://skmtc.net/kudosity/apis/transmit-sms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kudosity/transmit-sms-api/versions/9f6c34b849af/schema)