Sign in
latestSwagger 2.02026-08-101561322.2 MB

3e4029d19684

Lists

Get favorite contacts and lists

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

get/api/v2/contacts/favorite

Query parameters

pageinteger

Fetch specified results page.

limitinteger

The number of results per page.

querystring

Find contacts or lists by specified search query.

Response

Favorite entities have been returned with success.

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": [
    {
      "entityId": 629,
      "entityType": "contact",
      "primaryLabel": "Favorite contact name.",
      "secondaryLabel": "45",
      "tertiaryLabel": "Australia",
      "avatar": "avatars/dummy_avatar.png"
    }
  ]
}