List all merge tags

Retrieve all merge tags for your company.

get/merge-tags

Request

Base URL
https://enterprise.knak.io/api/published/v1
Auth
none declared
TypeScript
https://skmtc.dev/knak/apis/knak-enterprise-api/docs/merge-tags/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

pageinteger

Page number

per_pageinteger

Number of items per page

filter[name]string

Filter by name. Exact match filter.

filter[platform_id]string

Filter by platform ID. Exact match filter.

Response

Example response

{
  "data": [
    {
      "type": "merge-tag",
      "id": "609d7ce223411",
      "attributes": {
        "id": "609d7ce223411",
        "name": "City",
        "description": "The target city of the marketing campaign",
        "platform_id": "marketo",
        "merge_tag_value": "{{lead.City}}",
        "velocity_script_token": "${lead.City}",
        "knak_tag": "{{!City.knakTagId:609d7ce223411!}}"
      }
    }
  ],
  "links": {
    "first": "https://enterprise.knak.io/api/published/v1/merge-tags?page=1",
    "last": "https://enterprise.knak.io/api/published/v1/merge-tags?page=3",
    "prev": "https://enterprise.knak.io/api/published/v1/merge-tags?page=1",
    "next": "https://enterprise.knak.io/api/published/v1/merge-tags?page=3"
  },
  "meta": {
    "current_page": 2,
    "from": 1,
    "last_page": 3,
    "links": [
      {
        "url": "https://enterprise.knak.io/api/published/v1/merge-tags?page=2",
        "label": "Next",
        "active": true
      }
    ],
    "path": "https://enterprise.knak.io/api/published/v1/merge-tags?page=2",
    "per_page": 10,
    "to": 3,
    "total": 3
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.