Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Lists

Get all lists

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

get/api/v2/lists

Query parameters

pageinteger

The current fetched page.

limitinteger

The number of results per page.

orderBy'id' | 'firstName' | 'lastName'

Order results by some field. Default is id.

direction'asc' | 'desc'

Order direction. Default is desc.

favoriteOnly0 | 1

Return only favorited lists.

onlyMine0 | 1

Return only current user lists.

Response

Returned when successful.

pageinteger required
pageCountinteger required

The total number of pages.

limitinteger required

The number of results per page.

Example response

{
  "page": 1,
  "pageCount": 10,
  "limit": 10,
  "resources": [
    {
      "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"
      }
    }
  ]
}