/target-fields

GET

/crm/v1/target-fields

GET

/api/crm/v1/target-fields

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

200Retrieved

1 {
2   "Account": [
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   "Contact": [
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   "Lead": [
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   "Note": [
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   "Opportunity": [
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   "Stage": [
38     {
39       "name": "example_target_field_name",
40       "description": "this is a example description of a target field",
41       "is_mapped": "true"
42     }
43   ],
44   "User": [
45     {
46       "name": "example_target_field_name",
47       "description": "this is a example description of a target field",
48       "is_mapped": "true"
49     }
50   ],
51   "Task": [
52     {
53       "name": "example_target_field_name",
54       "description": "this is a example description of a target field",
55       "is_mapped": "true"
56     }
57   ],
58   "Engagement": [
59     {
60       "name": "example_target_field_name",
61       "description": "this is a example description of a target field",
62       "is_mapped": "true"
63     }
64   ]
65 }

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

Accountlist of objectsOptional

Contactlist of objectsOptional

Leadlist of objectsOptional

Notelist of objectsOptional

Opportunitylist of objectsOptional

Stagelist of objectsOptional

Userlist of objectsOptional

Tasklist of objectsOptional

Engagementlist of objectsOptional

Authentication

Headers

Response