Go to appAcademyWhat's new?
Back
Artisan IMG > Greenhouse (greenhouse) (3cddbb11-e165-4a2f-bd1c-1f1a58fc83f0)
Greenhouse
OverviewUse casesOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Create candidate
Copy

Create a new candidate

Sample Input

1
{
2
    "user_id": 12345,
3
    "title": "Software Engineer",
4
    "first_name": "John",
5
    "last_name": "Doe",
6
    "applications": [
7
        {
8
            "job_id": 67890,
9
            "source_id": 54321,
10
            "initial_stage_id": 98765,
11
            "referrer": {
12
                "type2": "email",
13
                "value": "jane.smith@example.com"
14
            },
15
            "attachments": [
16
                {
17
                    "filename": "john_doe_resume.pdf",
18
                    "type2": "resume",
19
                    "content": "base64encodedcontent==",
20
                    "content_type": "application/pdf"
21
                }
22
            ]
23
        }
24
    ],
25
    "company": "Tech Solutions Inc.",
26
    "phone_numbers": [
27
        {
28
            "type2": "mobile",
29
            "value": "+1 (555) 123-4567"
30
        }
31
    ],
32
    "addresses": [
33
        {
34
            "type2": "home",
35
            "value": "123 Main St, Anytown, USA 12345"
36
        }
37
    ],
38
    "email_addresses": [
39
        {
40
            "type2": "personal",
41
            "value": "john.doe@example.com"
42
        }
43
    ],
44
    "website_addresses": [
45
        {
46
            "type2": "portfolio",
47
            "value": "https://johndoe.portfolio.com"
48
        }
49
    ],
50
    "social_media_addresses": [
51
        "https://linkedin.com/in/johndoe"
52
    ],
53
    "tags": [
54
        "Java",
55
        "Python",
56
        "AWS"
57
    ],
58
    "custom_fields": [
59
        {
60
            "name_key": "current_salary",
61
            "value": "85000",
62
            "unit": "USD"
63
        }
64
    ],
65
    "recruiter": {
66
        "email": "recruiter@company.com"
67
    },
68
    "activity_feed_notes": [
69
        {
70
            "user_id": 11111,
71
            "body": "Initial contact made with candidate",
72
            "visibility": "private"
73
        }
74
    ]
75
}

Sample Output

1
{
2
    "photo_url": null,
3
    "addresses": [
4
        {
5
            "value": "123 Main St, Anytown, USA 12345",
6
            "type": "home"
7
        }
8
    ],
9
    "applications": [
10
        {
11
            "credited_to": {
12
                "id": 22222,
13
                "first_name": "Jane",
14
                "last_name": "Smith",
15
                "name": "Jane Smith",
16
                "employee_id": null
17
            },
18
            "prospect_detail": {
19
                "prospect_pool": null,
20
                "prospect_stage": null,
21
                "prospect_owner": null
22
            },
23
            "rejection_details": null,
24
            "prospect": false,
25
            "status": "active",
26
            "rejected_at": null,
27
            "answers": [],
28
            "applied_at": "2023-06-15T14:30:00Z",
29
            "location": null,
30
            "jobs": [
31
                {
32
                    "id": 67890,
33
                    "name": "Senior Software Engineer"
34
                }
35
            ],
36
            "candidate_id": 123456,
37
            "current_stage": {
38
                "id": 98765,
39
                "name": "Application Review"
40
            },
41
            "rejection_reason": null,
42
            "last_activity_at": "2023-06-15T14:30:00Z",
43
            "source": {
44
                "id": 54321,
45
                "public_name": "Employee Referral"
46
            },
47
            "id": 987654
48
        }
49
    ],
50
    "keyed_custom_fields": {
51
        "current_salary": {
52
            "name": "Current Salary",
53
            "type": "currency",
54
            "value": "85000"
55
        },
56
        "desired_salary": null
57
    },
58
    "employments": [],
59
    "custom_fields": {
60
        "current_salary": "85000",
61
        "desired_salary": null
62
    },
63
    "application_ids": [
64
        987654
65
    ],
66
    "created_at": "2023-06-15T14:30:00Z",
67
    "recruiter": {
68
        "id": 33333,
69
        "first_name": "Alex",
70
        "last_name": "Johnson",
71
        "name": "Alex Johnson",
72
        "employee_id": null
73
    },
74
    "educations": [],
75
    "is_private": false,
76
    "coordinator": null,
77
    "attachments": [],
78
    "last_name": "Doe",
79
    "social_media_addresses": [
80
        {
81
            "value": "https://linkedin.com/in/johndoe"
82
        }
83
    ],
84
    "updated_at": "2023-06-15T14:30:00Z",
85
    "title": "Software Engineer",
86
    "last_activity": "2023-06-15T14:30:00Z",
87
    "tags": [
88
        "Java",
89
        "Python",
90
        "AWS"
91
    ],
92
    "phone_numbers": [
93
        {
94
            "value": "+1 (555) 123-4567",
95
            "type": "mobile"
96
        }
97
    ],
98
    "first_name": "John",
99
    "id": 123456,
100
    "company": "Tech Solutions Inc.",
101
    "website_addresses": [
102
        {
103
            "value": "https://johndoe.portfolio.com",
104
            "type": "portfolio"
105
        }
106
    ],
107
    "email_addresses": [
108
        {
109
            "value": "john.doe@example.com",
110
            "type": "personal"
111
        }
112
    ]
113
}

Create candidate application
Copy

Create a new application for this candidate or prospect. If a prospect, this will add a new candidate application to the given job on their profile, this will not convert their existing prospect application into a candidate application.

Sample Input

1
{
2
    "user_id": 12345,
3
    "candidate_id": 67890,
4
    "job_id": 54321,
5
    "source_id": 9876,
6
    "initial_stage_id": "1234",
7
    "referrer": {
8
        "type2": "email",
9
        "value": "john.doe@example.com"
10
    },
11
    "attachments": [
12
        {
13
            "filename": "resume.pdf",
14
            "type2": "resume",
15
            "content": "base64encodedcontenthere",
16
            "content_type": "application/pdf"
17
        },
18
        {
19
            "filename": "cover_letter.docx",
20
            "type2": "cover_letter",
21
            "url": "https://example.com/cover_letter.docx"
22
        }
23
    ]
24
}

Sample Output

1
{
2
    "credited_to": {
3
        "id": null,
4
        "name": "Jane Smith",
5
        "employee_id": null
6
    },
7
    "prospect_detail": {
8
        "prospect_pool": null,
9
        "prospect_stage": null,
10
        "prospect_owner": null
11
    },
12
    "rejection_details": null,
13
    "prospect": false,
14
    "status": "active",
15
    "rejected_at": null,
16
    "answers": [],
17
    "applied_at": "2023-05-15T14:30:00Z",
18
    "location": null,
19
    "jobs": [
20
        {
21
            "id": 54321,
22
            "name": "Software Engineer"
23
        }
24
    ],
25
    "candidate_id": 67890,
26
    "current_stage": {
27
        "id": 1234,
28
        "name": "Application Review"
29
    },
30
    "rejection_reason": null,
31
    "last_activity_at": "2023-05-15T14:30:00Z",
32
    "source": {
33
        "id": 9876,
34
        "public_name": "Employee Referral"
35
    },
36
    "id": 98765
37
}

Create candidate note
Copy

Create a candidate note.

Sample Input

1
{
2
    "user_id": 12345,
3
    "candidate_id": 67890,
4
    "body": "Candidate showed excellent problem-solving skills during the technical interview. Recommend moving forward to the next round.",
5
    "visibility": "private"
6
}

Sample Output

1
{
2
    "id": 98765,
3
    "created_at": "2023-05-15T14:30:22Z",
4
    "body": "Candidate showed excellent problem-solving skills during the technical interview. Recommend moving forward to the next round.",
5
    "private": true,
6
    "visibility": "private",
7
    "visiblity": "private",
8
    "user": {
9
        "id": 12345,
10
        "first_name": "John",
11
        "last_name": "Doe",
12
        "name": "John Doe",
13
        "employee_id": null
14
    }
15
}

Create prospect
Copy

Create a new prospect. The difference between a prospect and a candidate is that a prospect can be on no jobs or many jobs.

Sample Input

1
{
2
    "user_id": 12345,
3
    "title": "Software Engineer",
4
    "first_name": "John",
5
    "last_name": "Doe",
6
    "company": "Tech Solutions Inc.",
7
    "phone_numbers": [
8
        {
9
            "type2": "mobile",
10
            "value": "+1 (555) 123-4567"
11
        }
12
    ],
13
    "addresses": [
14
        {
15
            "type2": "work",
16
            "value": "123 Tech Street, San Francisco, CA 94105"
17
        }
18
    ],
19
    "email_addresses": [
20
        {
21
            "type2": "work",
22
            "value": "john.doe@techsolutions.com"
23
        }
24
    ],
25
    "website_addresses": [
26
        {
27
            "type2": "portfolio",
28
            "value": "https://johndoe.portfolio.com"
29
        }
30
    ],
31
    "social_media_addresses": [
32
        "https://linkedin.com/in/johndoe"
33
    ],
34
    "tags": [
35
        "Java",
36
        "Python",
37
        "Cloud Computing"
38
    ],
39
    "custom_fields": [
40
        {
41
            "key": "Years of Experience",
42
            "value": "5"
43
        }
44
    ],
45
    "recruiter": {
46
        "email": "recruiter@company.com"
47
    },
48
    "activity_feed_notes": [
49
        {
50
            "user_id": 67890,
51
            "body": "Excellent candidate with strong technical skills",
52
            "visibility": "private"
53
        }
54
    ],
55
    "application": {
56
        "job_ids": [
57
            1001,
58
            1002
59
        ],
60
        "source_id": 5001,
61
        "attachments": [
62
            {
63
                "filename": "john_doe_resume.pdf",
64
                "type2": "resume",
65
                "content": "base64encodedcontent...",
66
                "content_type": "application/pdf"
67
            }
68
        ]
69
    }
70
}

Sample Output

1
{
2
    "photo_url": null,
3
    "addresses": [],
4
    "applications": [
5
        {
6
            "credited_to": null,
7
            "prospect_detail": {
8
                "prospect_pool": null,
9
                "prospect_stage": null,
10
                "prospect_owner": null
11
            },
12
            "rejection_details": null,
13
            "prospect": true,
14
            "status": "active",
15
            "rejected_at": null,
16
            "answers": [],
17
            "applied_at": "2023-05-15T14:30:00Z",
18
            "location": null,
19
            "jobs": [],
20
            "candidate_id": 98765,
21
            "current_stage": null,
22
            "rejection_reason": null,
23
            "last_activity_at": "2023-05-15T14:30:00Z",
24
            "source": null,
25
            "id": 54321
26
        }
27
    ],
28
    "keyed_custom_fields": {
29
        "current_salary": null,
30
        "desired_salary": null
31
    },
32
    "employments": [],
33
    "custom_fields": {
34
        "current_salary": null,
35
        "desired_salary": null
36
    },
37
    "application_ids": [
38
        54321
39
    ],
40
    "created_at": "2023-05-15T14:30:00Z",
41
    "recruiter": null,
42
    "educations": [],
43
    "is_private": false,
44
    "coordinator": null,
45
    "attachments": [],
46
    "last_name": "Doe",
47
    "social_media_addresses": [
48
        "https://linkedin.com/in/johndoe"
49
    ],
50
    "updated_at": "2023-05-15T14:30:00Z",
51
    "title": "Software Engineer",
52
    "last_activity": "2023-05-15T14:30:00Z",
53
    "tags": [
54
        "Java",
55
        "Python",
56
        "Cloud Computing"
57
    ],
58
    "phone_numbers": [],
59
    "first_name": "John",
60
    "id": 98765,
61
    "company": null,
62
    "website_addresses": [],
63
    "email_addresses": [
64
        {
65
            "value": "john.doe@techsolutions.com",
66
            "type": "work"
67
        }
68
    ]
69
}

Get application
Copy

Retrieve an application by its ID.

Sample Input

1
{
2
    "application_id": 12345
3
}

Sample Output

1
{
2
    "application_found": true,
3
    "body": {
4
        "credited_to": {
5
            "id": 67890,
6
            "first_name": "John",
7
            "last_name": "Doe",
8
            "name": "John Doe",
9
            "employee_id": null
10
        },
11
        "prospect_detail": {
12
            "prospect_pool": null,
13
            "prospect_stage": null,
14
            "prospect_owner": null
15
        },
16
        "rejection_details": null,
17
        "prospect": false,
18
        "status": "active",
19
        "rejected_at": null,
20
        "answers": [],
21
        "applied_at": "2023-05-15T14:30:00Z",
22
        "location": null,
23
        "jobs": [
24
            {
25
                "id": 54321,
26
                "name": "Software Engineer"
27
            }
28
        ],
29
        "candidate_id": 98765,
30
        "current_stage": null,
31
        "rejection_reason": null,
32
        "last_activity_at": "2023-05-16T09:45:00Z",
33
        "source": {
34
            "id": 246,
35
            "public_name": "Company Website"
36
        },
37
        "id": 12345
38
    }
39
}

Get candidate
Copy

Retrieve a candidate by ID.

Sample Input

1
{
2
    "candidate_id": 12345
3
}

Sample Output

1
{
2
    "candidate_found": true,
3
    "body": {
4
        "photo_url": null,
5
        "addresses": [],
6
        "applications": [
7
            {
8
                "credited_to": {
9
                    "id": 67890,
10
                    "first_name": "John",
11
                    "last_name": "Doe",
12
                    "name": "John Doe",
13
                    "employee_id": null
14
                },
15
                "prospect_detail": {
16
                    "prospect_pool": null,
17
                    "prospect_stage": null,
18
                    "prospect_owner": null
19
                },
20
                "rejection_details": null,
21
                "prospect": false,
22
                "status": "active",
23
                "rejected_at": null,
24
                "answers": [],
25
                "applied_at": "2023-05-15T10:30:00Z",
26
                "location": null,
27
                "jobs": [
28
                    {
29
                        "id": 54321,
30
                        "name": "Software Engineer"
31
                    }
32
                ],
33
                "candidate_id": 12345,
34
                "current_stage": {
35
                    "id": 98765,
36
                    "name": "Phone Interview"
37
                },
38
                "rejection_reason": null,
39
                "last_activity_at": "2023-05-16T14:45:00Z",
40
                "source": {
41
                    "id": 11111,
42
                    "public_name": "Company Website"
43
                },
44
                "id": 22222
45
            }
46
        ],
47
        "keyed_custom_fields": {
48
            "current_salary": null,
49
            "desired_salary": null
50
        },
51
        "employments": [],
52
        "custom_fields": {
53
            "current_salary": null,
54
            "desired_salary": null
55
        },
56
        "application_ids": [
57
            22222
58
        ],
59
        "created_at": "2023-05-15T10:00:00Z",
60
        "recruiter": null,
61
        "educations": [],
62
        "is_private": false,
63
        "coordinator": null,
64
        "attachments": [],
65
        "last_name": "Smith",
66
        "social_media_addresses": [],
67
        "updated_at": "2023-05-16T14:45:00Z",
68
        "title": null,
69
        "last_activity": "2023-05-16T14:45:00Z",
70
        "tags": [
71
            "Java",
72
            "Spring Boot"
73
        ],
74
        "phone_numbers": [],
75
        "first_name": "Alice",
76
        "id": 12345,
77
        "company": null,
78
        "website_addresses": [],
79
        "email_addresses": [
80
            {
81
                "value": "alice.smith@example.com",
82
                "type": "personal"
83
            }
84
        ]
85
    }
86
}

Get current offer by application
Copy

Retrieve the current offer for an application.

Sample Input

1
{
2
    "application_id": 12345
3
}

Sample Output

1
{
2
    "offer_found": true,
3
    "body": {
4
        "starts_at": "2023-07-01",
5
        "keyed_custom_fields": {
6
            "notes": {
7
                "name": "Notes",
8
                "type": "text",
9
                "value": null
10
            },
11
            "salary": {
12
                "name": "Salary",
13
                "type": "number",
14
                "value": null
15
            },
16
            "visa_cost": {
17
                "name": "Visa Cost",
18
                "type": "number",
19
                "value": null
20
            },
21
            "employment_type": {
22
                "name": "Employment Type",
23
                "type": "single_select",
24
                "value": "Full-time"
25
            },
26
            "current_salary": {
27
                "name": "Current Salary",
28
                "type": "number",
29
                "value": null
30
            },
31
            "source_cost": {
32
                "name": "Source Cost",
33
                "type": "number",
34
                "value": null
35
            },
36
            "benefits": {
37
                "name": "Benefits",
38
                "type": "text",
39
                "value": null
40
            },
41
            "options": {
42
                "name": "Options",
43
                "type": "text",
44
                "value": null
45
            },
46
            "bonus": {
47
                "name": "Bonus",
48
                "type": "number",
49
                "value": null
50
            }
51
        },
52
        "custom_fields": {
53
            "notes": null,
54
            "salary": null,
55
            "visa_cost": null,
56
            "employment_type": "Full-time",
57
            "current_salary": null,
58
            "source_cost": null,
59
            "benefits": null,
60
            "options": null,
61
            "bonus": null
62
        },
63
        "created_at": "2023-06-15T10:30:00Z",
64
        "application_id": 12345,
65
        "status": "created",
66
        "candidate_id": 67890,
67
        "updated_at": "2023-06-15T10:30:00Z",
68
        "version": 1,
69
        "resolved_at": null,
70
        "sent_at": null,
71
        "id": 54321,
72
        "job_id": 98765
73
    }
74
}

Get job
Copy

Retrieve a job by its ID.

Sample Input

1
{
2
    "job_id": 12345
3
}

Sample Output

1
{
2
    "job_found": true,
3
    "body": {
4
        "notes": null,
5
        "departments": [
6
            {
7
                "id": 1001,
8
                "name": "Engineering",
9
                "parent_id": null,
10
                "child_ids": [
11
                    1002,
12
                    1003
13
                ],
14
                "external_id": null
15
            },
16
            {
17
                "id": 1002,
18
                "name": "Frontend",
19
                "parent_id": 1001,
20
                "child_ids": [],
21
                "external_id": null
22
            }
23
        ],
24
        "keyed_custom_fields": {
25
            "employment_type": {
26
                "name": "Employment Type",
27
                "type": "single_select",
28
                "value": null
29
            },
30
            "salary": {
31
                "name": "Salary Range",
32
                "type": "short_text",
33
                "value": null
34
            },
35
            "bonus": {
36
                "name": "Bonus",
37
                "type": "short_text",
38
                "value": null
39
            },
40
            "options": {
41
                "name": "Stock Options",
42
                "type": "yes_no",
43
                "value": null
44
            }
45
        },
46
        "closed_at": null,
47
        "custom_fields": {
48
            "employment_type": null,
49
            "salary": null,
50
            "bonus": null,
51
            "options": null
52
        },
53
        "confidential": false,
54
        "opened_at": "2023-05-01T09:00:00Z",
55
        "created_at": "2023-04-28T14:30:00Z",
56
        "name": "Senior Frontend Developer",
57
        "hiring_team": {
58
            "hiring_managers": [],
59
            "recruiters": [
60
                {
61
                    "id": 2001,
62
                    "first_name": "Jane",
63
                    "last_name": "Smith",
64
                    "name": "Jane Smith",
65
                    "employee_id": null,
66
                    "responsible": true
67
                }
68
            ],
69
            "coordinators": [],
70
            "sourcers": []
71
        },
72
        "status": "open",
73
        "offices": [],
74
        "id": 12345,
75
        "openings": [
76
            {
77
                "id": 5001,
78
                "opening_id": null,
79
                "status": "open",
80
                "opened_at": "2023-05-01T09:00:00Z",
81
                "closed_at": null,
82
                "application_id": null,
83
                "close_reason": null
84
            }
85
        ],
86
        "requisition_id": null
87
    }
88
}

Get offer
Copy

Retrieve an offer by its ID.

Sample Input

1
{
2
    "offer_id": 12345
3
}

Sample Output

1
{
2
    "offer_found": true,
3
    "body": {
4
        "starts_at": "2023-07-01T09:00:00Z",
5
        "keyed_custom_fields": {
6
            "notes": {
7
                "name": "Notes",
8
                "type": "long_text",
9
                "value": null
10
            },
11
            "salary": {
12
                "name": "Salary",
13
                "type": "number",
14
                "value": null
15
            },
16
            "visa_cost": {
17
                "name": "Visa Cost",
18
                "type": "number",
19
                "value": null
20
            },
21
            "employment_type": {
22
                "name": "Employment Type",
23
                "type": "single_select",
24
                "value": "Full-time"
25
            },
26
            "current_salary": {
27
                "name": "Current Salary",
28
                "type": "number",
29
                "value": null
30
            },
31
            "source_cost": {
32
                "name": "Source Cost",
33
                "type": "number",
34
                "value": null
35
            },
36
            "benefits": {
37
                "name": "Benefits",
38
                "type": "long_text",
39
                "value": null
40
            },
41
            "options": {
42
                "name": "Options",
43
                "type": "long_text",
44
                "value": null
45
            },
46
            "bonus": {
47
                "name": "Bonus",
48
                "type": "number",
49
                "value": null
50
            }
51
        },
52
        "custom_fields": {
53
            "notes": null,
54
            "salary": null,
55
            "visa_cost": null,
56
            "employment_type": "Full-time",
57
            "current_salary": null,
58
            "source_cost": null,
59
            "benefits": null,
60
            "options": null,
61
            "bonus": null
62
        },
63
        "created_at": "2023-06-15T14:30:00Z",
64
        "application_id": 67890,
65
        "status": "created",
66
        "candidate_id": 54321,
67
        "updated_at": "2023-06-15T14:30:00Z",
68
        "version": 1,
69
        "resolved_at": null,
70
        "sent_at": null,
71
        "id": 12345,
72
        "job_id": 98765
73
    }
74
}

Get user
Copy

Retrieve a user by ID.

Sample Input

1
{
2
    "user_id": 12345
3
}

Sample Output

1
{
2
    "user_found": true,
3
    "body": {
4
        "created_at": "2023-05-15T09:30:00Z",
5
        "name": "John Doe",
6
        "employee_id": null,
7
        "last_name": "Doe",
8
        "emails": [
9
            "john.doe@example.com",
10
            "johnd@company.com"
11
        ],
12
        "site_admin": false,
13
        "updated_at": "2023-06-20T14:45:00Z",
14
        "first_name": "John",
15
        "id": 12345,
16
        "disabled": false
17
    }
18
}

List applications
Copy

Retrieve a list of application. Can be filtered if required.

Sample Input

1
{
2
    "job_id": 12345,
3
    "created_after": "2023-01-01T00:00:00Z",
4
    "created_before": "2023-06-30T23:59:59Z",
5
    "last_activity_after": "2023-05-01T00:00:00Z",
6
    "status": "Active",
7
    "results_per_page": 10,
8
    "page": 1
9
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "credited_to": null,
5
            "prospect_detail": {
6
                "prospect_stage": null,
7
                "prospect_pool": null,
8
                "prospect_owner": null
9
            },
10
            "rejection_details": null,
11
            "prospect": false,
12
            "status": "Active",
13
            "rejected_at": null,
14
            "answers": [],
15
            "applied_at": "2023-05-15T14:30:00Z",
16
            "location": null,
17
            "jobs": [
18
                {
19
                    "name": "Software Engineer",
20
                    "id": 12345
21
                }
22
            ],
23
            "candidate_id": 67890,
24
            "current_stage": {
25
                "name": "Phone Screen",
26
                "id": 1
27
            },
28
            "rejection_reason": {
29
                "type": {
30
                    "name": null,
31
                    "id": null
32
                },
33
                "name": null,
34
                "id": null
35
            },
36
            "last_activity_at": "2023-06-01T10:15:00Z",
37
            "source": {
38
                "public_name": "Company Website",
39
                "id": 1
40
            },
41
            "id": 54321
42
        }
43
    ]
44
}

List candidates
Copy

Retrieve a list of candidates. Can be filtered if required.

Sample Input

1
{
2
    "job_id": 12345,
3
    "candidate_ids": [
4
        "67890",
5
        "78901"
6
    ],
7
    "email": "johndoe@example.com",
8
    "created_after": "2023-01-01T00:00:00Z",
9
    "updated_before": "2023-06-30T23:59:59Z",
10
    "results_per_page": 10,
11
    "page": 1
12
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": 67890,
5
            "first_name": "John",
6
            "last_name": "Doe",
7
            "company": "ABC Corp",
8
            "title": "Software Engineer",
9
            "created_at": "2023-02-15T10:30:00Z",
10
            "updated_at": "2023-06-20T14:45:00Z",
11
            "last_activity": "2023-06-20T14:45:00Z",
12
            "is_private": false,
13
            "photo_url": null,
14
            "attachments": [
15
                {
16
                    "filename": "john_doe_resume.pdf",
17
                    "url": "https://example.com/resumes/john_doe_resume.pdf",
18
                    "type": "resume"
19
                }
20
            ],
21
            "application_ids": [
22
                98765
23
            ],
24
            "phone_numbers": [
25
                {
26
                    "value": "+1 555-123-4567",
27
                    "type": "mobile"
28
                }
29
            ],
30
            "addresses": [
31
                {
32
                    "value": "123 Main St, Anytown, USA 12345",
33
                    "type": "home"
34
                }
35
            ],
36
            "email_addresses": [
37
                {
38
                    "value": "johndoe@example.com",
39
                    "type": "personal"
40
                }
41
            ],
42
            "website_addresses": [
43
                {
44
                    "value": "https://johndoe.com",
45
                    "type": "personal"
46
                }
47
            ],
48
            "social_media_addresses": [
49
                {
50
                    "value": "https://linkedin.com/in/johndoe"
51
                }
52
            ],
53
            "recruiter": {
54
                "id": 11111,
55
                "first_name": "Jane",
56
                "last_name": "Smith",
57
                "name": "Jane Smith",
58
                "employee_id": "EMP001"
59
            },
60
            "coordinator": {
61
                "id": 22222,
62
                "first_name": "Mike",
63
                "last_name": "Johnson",
64
                "name": "Mike Johnson",
65
                "employee_id": "EMP002"
66
            },
67
            "tags": [
68
                "Java",
69
                "Python",
70
                "AWS"
71
            ],
72
            "applications": [
73
                {
74
                    "id": 98765,
75
                    "candidate_id": 67890,
76
                    "prospect": false,
77
                    "applied_at": "2023-06-01T09:00:00Z",
78
                    "rejected_at": null,
79
                    "last_activity_at": "2023-06-20T14:45:00Z",
80
                    "location": {
81
                        "address": "456 Tech Ave, Silicon Valley, CA 94000"
82
                    },
83
                    "source": {
84
                        "id": 33333,
85
                        "public_name": "Company Website"
86
                    },
87
                    "credited_to": {
88
                        "id": 11111,
89
                        "first_name": "Jane",
90
                        "last_name": "Smith",
91
                        "name": "Jane Smith",
92
                        "employee_id": "EMP001"
93
                    },
94
                    "rejection_reason": null,
95
                    "rejection_details": null,
96
                    "jobs": [
97
                        {
98
                            "id": 12345,
99
                            "name": "Senior Software Engineer"
100
                        }
101
                    ],
102
                    "status": "active",
103
                    "current_stage": {
104
                        "id": 44444,
105
                        "name": "Phone Interview"
106
                    },
107
                    "answers": [
108
                        {
109
                            "question": "Years of experience",
110
                            "answer": "5"
111
                        }
112
                    ],
113
                    "prospect_detail": {
114
                        "prospect_pool": null,
115
                        "prospect_stage": null,
116
                        "prospect_owner": null
117
                    }
118
                }
119
            ],
120
            "educations": [],
121
            "employments": [],
122
            "custom_fields": {
123
                "current_salary": null,
124
                "desired_salary": null
125
            },
126
            "keyed_custom_fields": {
127
                "current_salary": null,
128
                "desired_salary": null
129
            }
130
        }
131
    ]
132
}

List custom fields
Copy

Retrieve a list of custom fields.

Sample Input

1
{
2
    "field_type": "candidate",
3
    "include_inactive": true
4
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": 1001,
5
            "name": "Current Salary",
6
            "active": true,
7
            "field_type": "candidate",
8
            "priority": 1,
9
            "value_type": "short_text",
10
            "private": true,
11
            "required": false,
12
            "require_approval": false,
13
            "trigger_new_version": false,
14
            "name_key": "current_salary",
15
            "custom_field_options": []
16
        },
17
        {
18
            "id": 1002,
19
            "name": "Preferred Work Location",
20
            "active": true,
21
            "field_type": "candidate",
22
            "priority": 2,
23
            "value_type": "multi_select",
24
            "private": false,
25
            "required": true,
26
            "require_approval": false,
27
            "trigger_new_version": true,
28
            "name_key": "preferred_work_location",
29
            "custom_field_options": [
30
                {
31
                    "id": 101,
32
                    "name": "Remote",
33
                    "priority": 1
34
                },
35
                {
36
                    "id": 102,
37
                    "name": "On-site",
38
                    "priority": 2
39
                },
40
                {
41
                    "id": 103,
42
                    "name": "Hybrid",
43
                    "priority": 3
44
                }
45
            ]
46
        },
47
        {
48
            "id": 1003,
49
            "name": "Years of Experience",
50
            "active": false,
51
            "field_type": "candidate",
52
            "priority": 3,
53
            "value_type": "number",
54
            "private": false,
55
            "required": false,
56
            "require_approval": false,
57
            "trigger_new_version": false,
58
            "name_key": "years_of_experience",
59
            "custom_field_options": []
60
        }
61
    ]
62
}

List departments
Copy

List all of an organization’s departments.

Sample Input

1
{
2
    "render_as": "tree",
3
    "results_per_page": 10,
4
    "page": 1
5
}

Sample Output

1
{
2
    "departments": [
3
        {
4
            "id": 1,
5
            "name": "Engineering",
6
            "children": [
7
                {
8
                    "id": 2,
9
                    "name": "Frontend Development",
10
                    "children": []
11
                },
12
                {
13
                    "id": 3,
14
                    "name": "Backend Development",
15
                    "children": []
16
                }
17
            ]
18
        },
19
        {
20
            "id": 4,
21
            "name": "Marketing",
22
            "children": [
23
                {
24
                    "id": 5,
25
                    "name": "Digital Marketing",
26
                    "children": []
27
                },
28
                {
29
                    "id": 6,
30
                    "name": "Content Marketing",
31
                    "children": []
32
                }
33
            ]
34
        },
35
        {
36
            "id": 7,
37
            "name": "Human Resources",
38
            "children": []
39
        }
40
    ],
41
    "meta": {
42
        "total": 7,
43
        "page": 1,
44
        "per_page": 10
45
    }
46
}

List job stages
Copy

List all of an organization’s job stages.

Sample Input

1
{
2
    "created_after": "2023-01-01T00:00:00Z",
3
    "updated_before": "2023-06-30T23:59:59Z",
4
    "per_page": 50,
5
    "page": 1
6
}

Sample Output

1
{
2
    "job_stages": [
3
        {
4
            "id": 1234,
5
            "name": "Phone Screen",
6
            "created_at": "2023-02-15T10:30:00Z",
7
            "updated_at": "2023-03-01T14:45:00Z",
8
            "active": true,
9
            "priority": 1
10
        },
11
        {
12
            "id": 1235,
13
            "name": "On-site Interview",
14
            "created_at": "2023-03-10T09:00:00Z",
15
            "updated_at": "2023-04-05T11:20:00Z",
16
            "active": true,
17
            "priority": 2
18
        },
19
        {
20
            "id": 1236,
21
            "name": "Technical Assessment",
22
            "created_at": "2023-04-20T13:15:00Z",
23
            "updated_at": "2023-05-12T16:30:00Z",
24
            "active": true,
25
            "priority": 3
26
        }
27
    ],
28
    "meta": {
29
        "total": 5,
30
        "page": 1,
31
        "per_page": 50
32
    }
33
}

List job stages for job
Copy

Retrieve the stages for the specified job id.

Sample Input

1
{
2
    "job_id": 12345,
3
    "created_after": "2023-01-01T00:00:00Z",
4
    "updated_before": "2023-06-30T23:59:59Z"
5
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": 67890,
5
            "name": "Phone Screen",
6
            "created_at": "2023-02-15T10:30:00Z",
7
            "updated_at": "2023-02-15T10:30:00Z",
8
            "job_id": 12345,
9
            "interviews": [
10
                {
11
                    "id": 11111,
12
                    "name": "Initial Phone Interview",
13
                    "interview_kit": {
14
                        "id": 22222,
15
                        "content": null,
16
                        "questions": []
17
                    }
18
                }
19
            ]
20
        },
21
        {
22
            "id": 67891,
23
            "name": "On-site Interview",
24
            "created_at": "2023-02-15T10:31:00Z",
25
            "updated_at": "2023-03-01T14:45:00Z",
26
            "job_id": 12345,
27
            "interviews": [
28
                {
29
                    "id": 11112,
30
                    "name": "Technical Interview",
31
                    "interview_kit": {
32
                        "id": 22223,
33
                        "content": null,
34
                        "questions": []
35
                    }
36
                },
37
                {
38
                    "id": 11113,
39
                    "name": "Culture Fit Interview",
40
                    "interview_kit": {
41
                        "id": 22224,
42
                        "content": null,
43
                        "questions": []
44
                    }
45
                }
46
            ]
47
        }
48
    ]
49
}

List jobs
Copy

List all of an organization’s jobs.

Sample Input

1
{
2
    "results_per_page": 10,
3
    "page": 1,
4
    "status": "open",
5
    "department_id": "123456",
6
    "created_after": "2023-01-01T00:00:00Z",
7
    "updated_before": "2023-06-30T23:59:59Z"
8
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": 12345,
5
            "name": "Software Engineer",
6
            "requisition_id": "REQ-2023-001",
7
            "notes": null,
8
            "confidential": false,
9
            "status": "open",
10
            "created_at": "2023-02-15T10:30:00Z",
11
            "opened_at": "2023-02-16T09:00:00Z",
12
            "closed_at": null,
13
            "departments": [
14
                {
15
                    "id": 67890,
16
                    "name": "Engineering",
17
                    "parent_id": null,
18
                    "child_ids": [],
19
                    "external_id": null
20
                }
21
            ],
22
            "offices": [
23
                {
24
                    "id": 54321,
25
                    "name": "San Francisco HQ",
26
                    "location": {
27
                        "name": "San Francisco, CA"
28
                    },
29
                    "primary_contact_user_id": 98765,
30
                    "parent_id": null,
31
                    "child_ids": [],
32
                    "external_id": null
33
                }
34
            ],
35
            "hiring_team": {
36
                "hiring_managers": [
37
                    {
38
                        "id": 11111,
39
                        "first_name": "John",
40
                        "last_name": "Doe",
41
                        "name": "John Doe",
42
                        "employee_id": "EMP001"
43
                    }
44
                ],
45
                "recruiters": [
46
                    {
47
                        "id": 22222,
48
                        "first_name": "Jane",
49
                        "last_name": "Smith",
50
                        "name": "Jane Smith",
51
                        "employee_id": "EMP002",
52
                        "responsible": true
53
                    }
54
                ],
55
                "coordinators": [],
56
                "sourcers": []
57
            },
58
            "custom_fields": {
59
                "employment_type": "Full-time",
60
                "salary": "$100,000 - $150,000",
61
                "bonus": "10% - 20%",
62
                "options": "10,000 RSUs",
63
                "level": "Senior"
64
            },
65
            "keyed_custom_fields": {
66
                "employment_type": {
67
                    "name": "Employment Type",
68
                    "type": "single_select",
69
                    "value": "Full-time"
70
                },
71
                "salary": {
72
                    "name": "Salary Range",
73
                    "type": "short_text",
74
                    "value": "$100,000 - $150,000"
75
                },
76
                "bonus": {
77
                    "name": "Bonus Range",
78
                    "type": "short_text",
79
                    "value": "10% - 20%"
80
                },
81
                "options": {
82
                    "name": "Stock Options",
83
                    "type": "short_text",
84
                    "value": "10,000 RSUs"
85
                },
86
                "level": {
87
                    "name": "Level",
88
                    "type": "single_select",
89
                    "value": "Senior"
90
                }
91
            },
92
            "openings": [
93
                {
94
                    "id": 33333,
95
                    "opening_id": null,
96
                    "status": "open",
97
                    "opened_at": "2023-02-16T09:00:00Z",
98
                    "closed_at": null,
99
                    "application_id": null,
100
                    "close_reason": null
101
                }
102
            ]
103
        }
104
    ]
105
}

List offers
Copy

Retrieve a list of offers. Can be filtered if required.

Sample Input

1
{
2
    "job_id": 12345,
3
    "created_after": "2023-01-01T00:00:00Z",
4
    "created_before": "2023-06-30T23:59:59Z",
5
    "status": "accepted",
6
    "updated_after": "2023-03-01T00:00:00Z",
7
    "results_per_page": 10,
8
    "page": 1
9
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "starts_at": "2023-07-15T00:00:00Z",
5
            "keyed_custom_fields": {
6
                "salary_proposal": {
7
                    "name": "Salary Proposal",
8
                    "type": "short_text",
9
                    "value": "95000"
10
                },
11
                "department": {
12
                    "name": "Department",
13
                    "type": "short_text",
14
                    "value": "Engineering"
15
                },
16
                "location": {
17
                    "name": "Location",
18
                    "type": "short_text",
19
                    "value": "San Francisco"
20
                },
21
                "signing_bonus": {
22
                    "name": "Signing Bonus",
23
                    "type": "short_text",
24
                    "value": "10000"
25
                },
26
                "equity_grant_": {
27
                    "name": "Equity Grant",
28
                    "type": "short_text",
29
                    "value": "10000 RSUs"
30
                }
31
            },
32
            "custom_fields": {
33
                "salary_proposal": "95000",
34
                "department": "Engineering",
35
                "location": "San Francisco",
36
                "signing_bonus": "10000",
37
                "equity_grant:": "10000 RSUs"
38
            },
39
            "created_at": "2023-05-15T14:30:00Z",
40
            "application_id": 67890,
41
            "status": "accepted",
42
            "updated_at": "2023-06-01T10:15:00Z",
43
            "version": 2,
44
            "resolved_at": "2023-06-01T10:15:00Z",
45
            "sent_at": null,
46
            "id": 54321
47
        }
48
    ]
49
}

List offers by application
Copy

Retrieve a list of offers by application ID.

Sample Input

1
{
2
    "application_id": 12345,
3
    "results_per_page": 2,
4
    "page": 1
5
}

Sample Output

1
{
2
    "offer_found": true,
3
    "body": [
4
        {
5
            "starts_at": "2023-07-01",
6
            "keyed_custom_fields": {
7
                "notes": {
8
                    "name": "Notes",
9
                    "type": "text",
10
                    "value": null
11
                },
12
                "salary": {
13
                    "name": "Salary",
14
                    "type": "number",
15
                    "value": null
16
                },
17
                "visa_cost": {
18
                    "name": "Visa Cost",
19
                    "type": "number",
20
                    "value": null
21
                },
22
                "employment_type": {
23
                    "name": "Employment Type",
24
                    "type": "single_select",
25
                    "value": "Full-time"
26
                },
27
                "current_salary": {
28
                    "name": "Current Salary",
29
                    "type": "number",
30
                    "value": null
31
                },
32
                "source_cost": {
33
                    "name": "Source Cost",
34
                    "type": "number",
35
                    "value": null
36
                },
37
                "benefits": {
38
                    "name": "Benefits",
39
                    "type": "text",
40
                    "value": null
41
                },
42
                "options": {
43
                    "name": "Options",
44
                    "type": "text",
45
                    "value": null
46
                },
47
                "bonus": {
48
                    "name": "Bonus",
49
                    "type": "number",
50
                    "value": null
51
                }
52
            },
53
            "custom_fields": {
54
                "notes": null,
55
                "salary": null,
56
                "visa_cost": null,
57
                "employment_type": "Full-time",
58
                "current_salary": null,
59
                "source_cost": null,
60
                "benefits": null,
61
                "options": null,
62
                "bonus": null
63
            },
64
            "created_at": "2023-06-15T10:30:00Z",
65
            "application_id": 12345,
66
            "status": "created",
67
            "candidate_id": 67890,
68
            "updated_at": "2023-06-15T10:30:00Z",
69
            "version": 1,
70
            "resolved_at": null,
71
            "sent_at": null,
72
            "id": 54321,
73
            "job_id": 98765
74
        },
75
        {
76
            "starts_at": "2023-08-01",
77
            "keyed_custom_fields": {
78
                "notes": {
79
                    "name": "Notes",
80
                    "type": "text",
81
                    "value": null
82
                },
83
                "salary": {
84
                    "name": "Salary",
85
                    "type": "number",
86
                    "value": null
87
                },
88
                "visa_cost": {
89
                    "name": "Visa Cost",
90
                    "type": "number",
91
                    "value": null
92
                },
93
                "employment_type": {
94
                    "name": "Employment Type",
95
                    "type": "single_select",
96
                    "value": "Contract"
97
                },
98
                "current_salary": {
99
                    "name": "Current Salary",
100
                    "type": "number",
101
                    "value": null
102
                },
103
                "source_cost": {
104
                    "name": "Source Cost",
105
                    "type": "number",
106
                    "value": null
107
                },
108
                "benefits": {
109
                    "name": "Benefits",
110
                    "type": "text",
111
                    "value": null
112
                },
113
                "options": {
114
                    "name": "Options",
115
                    "type": "text",
116
                    "value": null
117
                },
118
                "bonus": {
119
                    "name": "Bonus",
120
                    "type": "number",
121
                    "value": null
122
                }
123
            },
124
            "custom_fields": {
125
                "notes": null,
126
                "salary": null,
127
                "visa_cost": null,
128
                "employment_type": "Contract",
129
                "current_salary": null,
130
                "source_cost": null,
131
                "benefits": null,
132
                "options": null,
133
                "bonus": null
134
            },
135
            "created_at": "2023-06-20T14:45:00Z",
136
            "application_id": 12345,
137
            "status": "created",
138
            "candidate_id": 67890,
139
            "updated_at": "2023-06-20T14:45:00Z",
140
            "version": 1,
141
            "resolved_at": null,
142
            "sent_at": null,
143
            "id": 54322,
144
            "job_id": 98765
145
        }
146
    ]
147
}

List offices
Copy

List all of an organization’s offices.

Sample Input

1
{
2
    "render_as": "list",
3
    "results_per_page": 10,
4
    "page": 1
5
}

Sample Output

1
{
2
    "offices": [
3
        {
4
            "id": 1,
5
            "name": "Headquarters",
6
            "location": "New York",
7
            "primary_contact_id": 101,
8
            "parent_id": null
9
        },
10
        {
11
            "id": 2,
12
            "name": "West Coast Office",
13
            "location": "San Francisco",
14
            "primary_contact_id": 102,
15
            "parent_id": 1
16
        },
17
        {
18
            "id": 3,
19
            "name": "European Office",
20
            "location": "London",
21
            "primary_contact_id": 103,
22
            "parent_id": 1
23
        }
24
    ],
25
    "meta": {
26
        "total": 3,
27
        "page": 1,
28
        "per_page": 10
29
    }
30
}

List sources
Copy

Lists an organization’s sources, grouped by strategy.

Sample Input

1
{
2
    "per_page": 50,
3
    "page": 1
4
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": 1234,
5
            "name": "LinkedIn",
6
            "type": {
7
                "id": 1,
8
                "name": "Social Media"
9
            }
10
        },
11
        {
12
            "id": 5678,
13
            "name": "Indeed",
14
            "type": {
15
                "id": 2,
16
                "name": "Job Board"
17
            }
18
        },
19
        {
20
            "id": 9101,
21
            "name": "Employee Referral",
22
            "type": {
23
                "id": 3,
24
                "name": "Internal"
25
            }
26
        }
27
    ]
28
}

List users
Copy

Retrieve a list of users. Can be filtered if required.

Sample Input

1
{
2
    "results_per_page": 2,
3
    "page": 1,
4
    "email": "john.doe@example.com",
5
    "created_after": "2023-01-01T00:00:00Z",
6
    "updated_before": "2023-06-30T23:59:59Z"
7
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "id": 12345,
5
            "name": "John Doe",
6
            "first_name": "John",
7
            "last_name": "Doe",
8
            "updated_at": "2023-05-15T14:30:00Z",
9
            "created_at": "2023-01-15T09:00:00Z",
10
            "disabled": false,
11
            "site_admin": false,
12
            "emails": [
13
                "john.doe@example.com"
14
            ],
15
            "employee_id": "EMP001"
16
        },
17
        {
18
            "id": 12346,
19
            "name": "Jane Smith",
20
            "first_name": "Jane",
21
            "last_name": "Smith",
22
            "updated_at": "2023-06-20T11:45:00Z",
23
            "created_at": "2023-02-01T10:30:00Z",
24
            "disabled": false,
25
            "site_admin": true,
26
            "emails": [
27
                "jane.smith@example.com",
28
                "j.smith@example.com"
29
            ],
30
            "employee_id": "EMP002"
31
        }
32
    ]
33
}

DDL operations
Copy

List attachment content types (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "result": [
3
        {
4
            "text": "PDF",
5
            "value": "application/pdf"
6
        },
7
        {
8
            "text": "Word Document",
9
            "value": "application/msword"
10
        },
11
        {
12
            "text": "Image (JPEG)",
13
            "value": "image/jpeg"
14
        },
15
        {
16
            "text": "Image (PNG)",
17
            "value": "image/png"
18
        },
19
        {
20
            "text": "Plain Text",
21
            "value": "text/plain"
22
        }
23
    ]
24
}

List candidate custom fields (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "result": [
3
        {
4
            "text": "Current Employer",
5
            "value": "current_employer"
6
        },
7
        {
8
            "text": "Desired Salary",
9
            "value": "desired_salary"
10
        },
11
        {
12
            "text": "Years of Experience",
13
            "value": "years_of_experience"
14
        },
15
        {
16
            "text": "Education Level",
17
            "value": "education_level"
18
        },
19
        {
20
            "text": "Preferred Location",
21
            "value": "preferred_location"
22
        }
23
    ]
24
}

List candidates (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "result": [
3
        {
4
            "text": "John Doe",
5
            "value": 1001
6
        },
7
        {
8
            "text": "Jane Smith",
9
            "value": 1002
10
        },
11
        {
12
            "text": "Michael Johnson",
13
            "value": 1003
14
        },
15
        {
16
            "text": "Emily Brown",
17
            "value": 1004
18
        },
19
        {
20
            "text": "David Wilson",
21
            "value": 1005
22
        }
23
    ]
24
}

List job custom field options (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{
2
    "custom_field": 12345
3
}

Sample Output

1
{
2
    "result": [
3
        {
4
            "text": "Entry Level",
5
            "value": 1
6
        },
7
        {
8
            "text": "Mid Level",
9
            "value": 2
10
        },
11
        {
12
            "text": "Senior Level",
13
            "value": 3
14
        },
15
        {
16
            "text": "Executive",
17
            "value": 4
18
        }
19
    ]
20
}

List job custom fields (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "result": [
3
        {
4
            "text": "Experience Level",
5
            "value": 1
6
        },
7
        {
8
            "text": "Required Skills",
9
            "value": 2
10
        },
11
        {
12
            "text": "Salary Range",
13
            "value": 3
14
        },
15
        {
16
            "text": "Remote Work Option",
17
            "value": 4
18
        },
19
        {
20
            "text": "Preferred Degree",
21
            "value": 5
22
        }
23
    ]
24
}

List job stages for job (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{
2
    "job_id": 12345
3
}

Sample Output

1
{
2
    "result": [
3
        {
4
            "text": "Application Review",
5
            "value": 1
6
        },
7
        {
8
            "text": "Phone Screen",
9
            "value": 2
10
        },
11
        {
12
            "text": "First Interview",
13
            "value": 3
14
        },
15
        {
16
            "text": "Second Interview",
17
            "value": 4
18
        },
19
        {
20
            "text": "Offer",
21
            "value": 5
22
        }
23
    ]
24
}

List jobs (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "result": [
3
        {
4
            "text": "Software Engineer",
5
            "value": 1001
6
        },
7
        {
8
            "text": "Product Manager",
9
            "value": 1002
10
        },
11
        {
12
            "text": "Data Analyst",
13
            "value": 1003
14
        },
15
        {
16
            "text": "Marketing Specialist",
17
            "value": 1004
18
        },
19
        {
20
            "text": "Customer Success Manager",
21
            "value": 1005
22
        }
23
    ]
24
}

List sources (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "result": [
3
        {
4
            "text": "Job Board",
5
            "value": 1
6
        },
7
        {
8
            "text": "Employee Referral",
9
            "value": 2
10
        },
11
        {
12
            "text": "LinkedIn",
13
            "value": 3
14
        },
15
        {
16
            "text": "Company Website",
17
            "value": 4
18
        },
19
        {
20
            "text": "Recruitment Agency",
21
            "value": 5
22
        }
23
    ]
24
}

List users (DDL)
Copy

Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping

Sample Input

1
{}

Sample Output

1
{
2
    "result": [
3
        {
4
            "text": "John Doe",
5
            "value": 1001
6
        },
7
        {
8
            "text": "Jane Smith",
9
            "value": 1002
10
        },
11
        {
12
            "text": "Mike Johnson",
13
            "value": 1003
14
        },
15
        {
16
            "text": "Emily Brown",
17
            "value": 1004
18
        },
19
        {
20
            "text": "Chris Lee",
21
            "value": 1005
22
        }
23
    ]
24
}

Previous

Use cases

Next

Operations