Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Lists

Get the details of a specific list

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

get/api/v2/lists/{id}

Path parameters

idinteger required

Response

Returned when successful.

idinteger required

List ID.

namestring required

List name.

descriptionstring nullable required

Description of the list.

favoritedboolean required

Is the List favorited? See Favorites list.

membersCountinteger required

List members count.

serviceboolean required

Internal service field.

sharedboolean nullable required

Is the list shared among all sub-accounts?

isDefaultboolean 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.

Example response

{
  "id": 715,
  "name": "Private list",
  "description": "Private contacts of C. R. Conway",
  "membersCount": 332,
  "user": {
    "id": 305,
    "displayTimeFormat": "24h",
    "username": "charles.conway",
    "firstName": "Charles",
    "lastName": "Conway",
    "email": "charles@example.com",
    "status": "A",
    "balance": 208.64,
    "phone": "447860021130",
    "company": "Example Ltd.",
    "currency": {
      "id": "GBP",
      "unicodeSymbol": "£",
      "htmlSymbol": "&pound;"
    },
    "country": {
      "id": "US",
      "name": "India"
    },
    "timezone": {
      "id": 55,
      "area": "Europe",
      "dst": 1,
      "offset": 10800,
      "timezone": "Europe\\/Tallinn"
    },
    "subaccountType": "P",
    "emailAccepted": true,
    "phoneAccepted": true,
    "avatar": {
      "href": "avatars/lav5d8de21d89971646555094.png"
    }
  },
  "avatar": {
    "href": "avatars/lav5d8de21d89971646555094.png"
  }
}