/target-fields

from merge import Merge
client = Merge(
    account_token="YOUR_ACCOUNT_TOKEN",
    api_key="YOUR_API_KEY",
)
client.ats.field_mapping.target_fields_retrieve()

{
  "Activity": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Application": [
    {
      "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"
    }
  ],
  "Candidate": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Department": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "EEOC": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "ScheduledInterview": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Job": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "JobPosting": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "JobInterviewStage": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Offer": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Office": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "RejectReason": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Scorecard": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "Tag": [
    {
      "name": "example_target_field_name",
      "description": "this is a example description of a target field",
      "is_mapped": "true"
    }
  ],
  "RemoteUser": [
    {
      "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

Activitylist of objects or null

Applicationlist of objects or null

Attachmentlist of objects or null

Candidatelist of objects or null

Departmentlist of objects or null

EEOClist of objects or null

ScheduledInterviewlist of objects or null

Joblist of objects or null

JobPostinglist of objects or null

JobInterviewStagelist of objects or null

Offerlist of objects or null

Officelist of objects or null

RejectReasonlist of objects or null

Scorecardlist of objects or null

Taglist of objects or null

RemoteUserlist of objects or null

1	{
2	"Activity": [
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	"Application": [
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	"Candidate": [
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	"Department": [
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	"EEOC": [
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	"ScheduledInterview": [
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	"Job": [
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	"JobPosting": [
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	"JobInterviewStage": [
66	{
67	"name": "example_target_field_name",
68	"description": "this is a example description of a target field",
69	"is_mapped": "true"
70	}
71	],
72	"Offer": [
73	{
74	"name": "example_target_field_name",
75	"description": "this is a example description of a target field",
76	"is_mapped": "true"
77	}
78	],
79	"Office": [
80	{
81	"name": "example_target_field_name",
82	"description": "this is a example description of a target field",
83	"is_mapped": "true"
84	}
85	],
86	"RejectReason": [
87	{
88	"name": "example_target_field_name",
89	"description": "this is a example description of a target field",
90	"is_mapped": "true"
91	}
92	],
93	"Scorecard": [
94	{
95	"name": "example_target_field_name",
96	"description": "this is a example description of a target field",
97	"is_mapped": "true"
98	}
99	],
100	"Tag": [
101	{
102	"name": "example_target_field_name",
103	"description": "this is a example description of a target field",
104	"is_mapped": "true"
105	}
106	],
107	"RemoteUser": [
108	{
109	"name": "example_target_field_name",
110	"description": "this is a example description of a target field",
111	"is_mapped": "true"
112	}
113	]
114	}

Authentication

Headers

Response