List contact tags

Tags (not archived) for a site

Contact Tag Attributes

• name (string) - The name of the contact tag

Pagination

Use the page[number] and page[size] query parameters to paginate results:

Get first page of 10 items

• GET /v1/contact_tags?page[number]=1&page[size]=10

Get second page of 25 items

• GET /v1/contact_tags?page[number]=2&page[size]=25

The response includes pagination links and meta data:

{
  "links": {
    "self": "https://api.kajabi.com/v1/contact_tags?page[number]=2&page[size]=10",
    "first": "https://api.kajabi.com/v1/contact_tags?page[number]=1&page[size]=10",
    "prev": "https://api.kajabi.com/v1/contact_tags?page[number]=1&page[size]=10",
    "next": "https://api.kajabi.com/v1/contact_tags?page[number]=3&page[size]=10",
    "last": "https://api.kajabi.com/v1/contact_tags?page[number]=5&page[size]=10"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}

Filter by Site ID

Use the filter[site_id] parameter to get contact tags for a specific site:

Get contact tags for site with ID 123

• GET /v1/contact_tags?filter[site_id]=123

Response will only include contact tags for that site

{
  "data": [{
    "id": "456",
    "type": "contact_tags",
    "attributes": {
      "name": "Source"
    },
    "relationships": {
      "site": {
        "data": {
          "id": "123",
          "type": "sites"
        }
      }
    }
  }]
}

Filter by Name Contains

Use the filter[name_cont] parameter to find contact tags where the name contains specific text:

Get contact tags with names containing “vip”

• GET /v1/contact_tags?filter[name_cont]=vip

Response will include contact tags with matching names

{
  "data": [{
    "id": "456",
    "type": "contact_tags",
    "attributes": {
      "name": "VIP Customer"
    }
  }]
}

Using Multiple Parameters Together

You can combine pagination, sorting, sparse fields and filtering in a single request:

Get page 2 of contact tags for site 123, sorted by name descending

• GET /v1/contact_tags?page[number]=2&page[size]=10&sort=-name&filter[site_id]=123

Response will include only requested fields, sorted and paginated

{
  "data": [{
    "id": "456",
    "type": "contact_tags",
    "attributes": {
      "name": "Webinar Attendee"
    }
  }, {
    "id": "789",
    "type": "contact_tags",
    "attributes": {
      "name": "VIP Customer"
    }
  }],
  "links": {
    "self": "https://api.kajabi.com/v1/contact_tags?page[number]=2&page[size]=10&sort=-name&fields[contact_tags]=name,handle&filter[site_id]=123",
    "first": "https://api.kajabi.com/v1/contact_tags?page[number]=1&page[size]=10&sort=-name&fields[contact_tags]=name,handle&filter[site_id]=123",
    "prev": "https://api.kajabi.com/v1/contact_tags?page[number]=1&page[size]=10&sort=-name&fields[contact_tags]=name,handle&filter[site_id]=123",
    "next": "https://api.kajabi.com/v1/contact_tags?page[number]=3&page[size]=10&sort=-name&fields[contact_tags]=name,handle&filter[site_id]=123",
    "last": "https://api.kajabi.com/v1/contact_tags?page[number]=5&page[size]=10&sort=-name&fields[contact_tags]=name,handle&filter[site_id]=123"
  },
  "meta": {
    "total_pages": 5,
    "total_count": 50,
    "current_page": 2
  }
}