/target-fields

curl https://api.merge.dev/api/knowledgebase/v1/target-fields \
     -H "X-Account-Token: X-Account-Token" \
     -H "Authorization: Bearer <token>"

{
  "Container": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Article": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Attachment": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "User": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Group": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ]
}

Get all organization-wide Target Fields, this will not include any Linked Account specific Target Fields. Organization-wide Target Fields are additional fields appended to the Merge Common Model for all Linked Accounts in a category. Learn more.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Response

Containerlist of objects or null

Articlelist of objects or null

Attachmentlist of objects or null

Userlist of objects or null

Grouplist of objects or null

1	{
2	"Container": [
3	{
4	"name": "example_target_field_name",
5	"description": "this is a example description of a target field",
6	"is_mapped": "true"
7	}
8	],
9	"Article": [
10	{
11	"name": "example_target_field_name",
12	"description": "this is a example description of a target field",
13	"is_mapped": "true"
14	}
15	],
16	"Attachment": [
17	{
18	"name": "example_target_field_name",
19	"description": "this is a example description of a target field",
20	"is_mapped": "true"
21	}
22	],
23	"User": [
24	{
25	"name": "example_target_field_name",
26	"description": "this is a example description of a target field",
27	"is_mapped": "true"
28	}
29	],
30	"Group": [
31	{
32	"name": "example_target_field_name",
33	"description": "this is a example description of a target field",
34	"is_mapped": "true"
35	}
36	]
37	}

Authentication

Headers

Response