-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
9217 lines (8910 loc) · 350 KB
/
openapi.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Ashby API
description: The public API for accessing resources in your Ashby instance.
version: 1.0.0
contact:
name: Ashby Support
url: https://app.ashbyhq.com/support
email: support@ashbyhq.com
x-konfig-ignore:
object-with-no-properties: true
servers:
- url: https://api.ashbyhq.com
tags:
- name: Candidate
- name: Openings
- name: Job
- name: Application
- name: Assessment
- name: Interview Schedule
- name: Offer
- name: Custom Field
- name: Job Posting
- name: Location
- name: User
- name: Webhook
- name: Application Feedback
- name: Candidate Tag
- name: Department
- name: Feedback Form Definition
- name: Interview
- name: Interview Stage
- name: Survey Form Definition
- name: API Key
- name: Application Form
- name: Approval Definition
- name: Archive Reason
- name: Department & Team
- name: File
- name: Hiring Team
- name: Hiring Team Role
- name: Interview Event
- name: Interview Plan
- name: Job Interview Plan
- name: Offer Process
- name: Referral
- name: Referral Form
- name: Source
- name: Survey Request
- name: Survey Submission
- description: The Ashby API
name: ashby
paths:
/apiKey.info:
post:
tags:
- API Key
summary: apiKey.info
operationId: ApiKey_getInfo
description: >
Retrieve information about the API key being used to make the request.
**Requires the [`apiKeysRead`](authentication#permissions-apikeyinfo)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeyGetInfoRequest'
responses:
'200':
description: Responses for the apiKey.info endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/ApiKeyGetInfoResponse'
/application.change_source:
post:
tags:
- Application
summary: application.changeSource
operationId: Application_changeSource
description: >
Change the source of an application.
**Requires the
[`candidatesWrite`](authentication#permissions-applicationchangesource)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationChangeSourceRequest'
responses:
'200':
description: Responses from the application.changeSource endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationChangeSourceResponse'
/application.change_stage:
post:
tags:
- Application
summary: application.changeStage
operationId: Application_changeStage
description: >
Change the stage of an application
**Requires the
[`candidatesWrite`](authentication#permissions-applicationchangestage)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationChangeStageRequest'
responses:
'200':
description: Responses from the application.changeStage endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationChangeStageResponse'
/application.create:
post:
tags:
- Application
summary: application.create
operationId: Application_considerCandidate
description: >
Consider a candidate for a job
**Requires the
[`candidatesWrite`](authentication#permissions-applicationcreate)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationConsiderCandidateRequest'
responses:
'200':
description: Responses from the application.change_stage endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationConsiderCandidateResponse'
/application.info:
post:
tags:
- Application
summary: application.info
operationId: Application_getDetails
description: >
Fetch application details by application id or by submitted form
instance id (which is return by the `applicationForm.submit` endpoint).
If both applicationId and submittedFormInstanceId are provided, we will
lookup by applicationId.
**Requires the
[`candidatesRead`](authentication#permissions-applicationinfo)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGetDetailsRequest'
responses:
'200':
description: Responses from the application.info endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGetDetailsResponse'
/application.list:
post:
tags:
- Application
summary: application.list
operationId: Application_getAllSchedules
description: >
Gets all applications schedules in the organization.
**Requires the
[`candidatesRead`](authentication#permissions-applicationlist)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGetAllSchedulesRequest'
responses:
'200':
description: Responses from the application.list endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationGetAllSchedulesResponse'
/applicationFeedback.list:
post:
tags:
- Application Feedback
summary: applicationFeedback.list
operationId: ApplicationFeedback_listAll
description: >
List all feedback associated with an application.
**Requires the
[`candidatesRead`](authentication#permissions-applicationfeedbacklist)
permission.**
The `submittedValues` field in the response contains the submitted
feedback in an object where the key is the path of the field and the
value is the value submitted for that field.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationFeedbackListAllRequest'
responses:
'200':
description: Responses from the applicationFeedback.list endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationFeedbackListAllResponse'
/applicationFeedback.submit:
post:
tags:
- Application Feedback
summary: applicationFeedback.submit
operationId: ApplicationFeedback_submitFeedback
description: >
Application feedback forms support a variety of field types.
**Requires the
[`candidatesWrite`](authentication#permissions-applicationfeedbacksubmit)
permission.**
The values accepted for each field depend on the type of field that's
being filled
out:
|
- `Boolean` - A boolean value
- `Date` - A date string in the format YYYY-MM-DD
- `Email` - A valid email address
- `Number` - An integer
- `RichText` - We do not support submitting rich text documents via the
API but we do support submitting plain text values for these fields.
Plain text values must be submitted in the format `{ type: "PlainText",
value: "A plain text string" }`
- `Score` - An integer between 1 and 4 submitted in the format `{ score:
4 }`
- `Phone`, `String` A string
- `ValueSelect` - A string that matches the value of one of the
ValueSelect field's selectable options
- `MultiValueSelect` - An array of strings that exist in the
MultiValueSelect field's selectable options
The `submittedValues` field in the response contains the submitted
feedback in an object where the key is the path of the field and the
value is the value submitted for that field.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationFeedbackSubmitFeedbackRequest'
responses:
'200':
description: Responses from the applicationFeedback.submit endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationFeedbackSubmitFeedbackResponse'
/applicationForm.submit:
post:
tags:
- Application Form
summary: applicationForm.submit
operationId: ApplicationForm_submitForm
description: >
Submit an application for a job posting.
**Requires the
[`candidatesWrite`](authentication#permissions-applicationformsubmit)
permission.**
The Content-Type of this request must be `multipart/form-data`.
**Note: The requests generated from this documentation will not work for
this endpoint.**
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/ApplicationFormSubmitFormRequest'
responses:
'200':
description: Responses from the applicationFeedback.submit endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/ApplicationFormSubmitFormResponse'
/approvalDefinition.update:
post:
tags:
- Approval Definition
summary: approvalDefinition.update
operationId: ApprovalDefinition_updateEntityScope
description: >
Create or update an approval definition for a specific entity that
requires approval. The entity requiring approval must be within scope of
an approval in Ashby that is marked as being managed by the API.
**Requires the
[`approvalsWrite`](authentication#permissions-approvaldefinitionupdate)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ApprovalDefinitionUpdateEntityScopeRequest'
responses:
'200':
description: Responses from the approvalDefinition.update endpoint
content:
application/json:
schema:
$ref: >-
#/components/schemas/ApprovalDefinitionUpdateEntityScopeResponse
/archiveReason.list:
post:
tags:
- Archive Reason
summary: archiveReason.list
operationId: ArchiveReason_list
description: >
Lists archive reasons
**Requires the
[`hiringProcessMetadataRead`](authentication#permissions-archivereasonlist)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArchiveReasonListRequest'
responses:
'200':
description: Responses for the archiveReason.list endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/ArchiveReasonListResponse'
/assessment.addCompletedToCandidate:
post:
tags:
- Assessment
summary: assessment.addCompletedToCandidate
operationId: Assessment_addCompletedToCandidate
description: >
Add a completed assessment to a candidate
**Requires the
[`candidatesWrite`](authentication#permissions-assessmentaddcompletedtocandidate)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentAddCompletedToCandidateRequest'
responses:
'200':
description: Responses for the assessment.addCompletedToCandidate endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentAddCompletedToCandidateResponse'
/assessment.start:
post:
tags:
- Assessment
summary: assessment.start (Implemented by Partner)
operationId: Assessment_partnerStart
description: >
The API for starting an assessment—implemented by the partner, but
called by Ashby
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentPartnerStartRequest'
responses:
'200':
description: Responses for the assessment.start endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentPartnerStartResponse'
'409':
description: Responses for the assessment.start endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentPartnerStart409Response'
/assessment.list:
post:
tags:
- Assessment
summary: assessment.list (Implemented by Partner)
operationId: Assessment_listPartnerSupport
description: >
The API for listing assessments that the partner supports — implemented
by the partner, but called by Ashby
responses:
'200':
description: Responses for the assessment.list endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentListPartnerSupportResponse'
/assessment.update:
post:
tags:
- Assessment
summary: assessment.update
operationId: Assessment_updateStatus
description: >
Update Ashby about the status of a started assessment
**Requires the
[`candidatesWrite`](authentication#permissions-assessmentupdate)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentUpdateStatusRequest'
responses:
'200':
description: Responses for the assessment.update endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentUpdateStatusResponse'
/assessment.cancel:
post:
tags:
- Assessment
summary: assessment.cancel (Implemented by Partner)
operationId: Assessment_cancelPartnerAssessment
description: >
(Optional) Cancels an assessment— implemented by the partner, but called
by Ashby
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentCancelPartnerAssessmentRequest'
responses:
'200':
description: Responses for the assessment.cancel endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/AssessmentCancelPartnerAssessmentResponse'
/candidate.addTag:
post:
tags:
- Candidate
summary: candidate.addTag
operationId: Candidate_addTag
description: >
Adds a tag to a candidate
**Requires the
[`candidatesWrite`](authentication#permissions-candidateaddtag)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateAddTagRequest'
responses:
'200':
description: Responses for the candidate.addTag endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateAddTagResponse'
/canidate.anonymize:
post:
tags:
- Candidate
summary: candidate.anonymize
operationId: Candidate_anonymizeCandidate
description: >
Anonymizes a candidate.
**Requires the
[`candidatesWrite`](authentication#permissions-candidateanonymize)
permission.**
**Note**: this action cannot be reversed and requires all of a
candidate's applications to be in the archived or hired state.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateAnonymizeCandidateRequest'
responses:
'200':
description: Responses for the candidate.anonymize endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateAnonymizeCandidateResponse'
/candidate.create:
post:
tags:
- Candidate
summary: candidate.create
operationId: Candidate_createNewCandidate
description: >
Creates a new candidate
**Requires the
[`candidatesWrite`](authentication#permissions-candidatecreate)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateCreateNewCandidateRequest'
responses:
'200':
description: Responses for the candidate.create endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateCreateNewCandidateResponse'
/candidate.createNote:
post:
tags:
- Candidate
summary: candidate.createNote
operationId: Candidate_createNote
description: >
Creates a note on a candidate.
**Requires the
[`candidatesWrite`](authentication#permissions-candidatecreatenote)
permission.**
For notes submitted with a type of `text/html`, we support the elements
listed below. Any unsupported elements will be stripped out of the
note's content before posting.
- Bold `<b>`
- Italic `<i>`
- Underline `<u>`
- Links `<a>`
- Bulleted Lists - `<ul>`, `<li>`
- Ordered Lists - `<ol>`, `<li>`
- Code - `<code>`
- Code Block - `<pre>`
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateCreateNoteRequest'
responses:
'200':
description: Responses for the candidate.createNote endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateCreateNoteResponse'
/candidate.info:
post:
tags:
- Candidate
summary: candidate.info
operationId: Candidate_getById
description: >
Gets a single candidate by id.
**Requires the
[`candidatesRead`](authentication#permissions-candidateinfo)
permission.**
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateGetByIdRequest'
responses:
'200':
description: Responses from the candidate.info endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateGetByIdResponse'
/candidate.list:
post:
tags:
- Candidate
summary: candidate.list
operationId: Candidate_listAll
description: >
Lists all candidates in an organization
**Requires the
[`candidatesRead`](authentication#permissions-candidatelist)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateListAllRequest'
responses:
'200':
description: Responses for the candidate.list endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateListAllResponse'
/candidate.listNotes:
post:
tags:
- Candidate
summary: candidate.listNotes
operationId: Candidate_getAllNotes
description: >
Lists all notes on a candidate
**Requires the
[`candidatesRead`](authentication#permissions-candidatelistnotes)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateGetAllNotesRequest'
responses:
'200':
description: Responses for the candidate.listNotes endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateGetAllNotesResponse'
/candidate.search:
post:
tags:
- Candidate
summary: candidate.search
operationId: Candidate_searchByEmailAndName
description: >
Search for candidates by email and / or name.
**Requires the
[`candidatesRead`](authentication#permissions-candidatesearch)
permission.**
Responses are limited to 100 results. Consider refining your search or
using /candidate.list to paginate through all candidates, if you
approach this limit. This API is for use cases where you intend operate
on a final small set of candidates, like building a candidate
autocomplete.
Note: When multiple search parameters are provided, the parameters are
combined with the `AND` operator.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateSearchByEmailAndNameRequest'
responses:
'200':
description: Responses for the candidate.search endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateSearchByEmailAndNameResponse'
/candidate.update:
post:
tags:
- Candidate
summary: candidate.update
operationId: Candidate_updateExistingCandidate
description: >
Updates an existing candidate
**Requires the
[`candidatesWrite`](authentication#permissions-candidateupdate)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateUpdateExistingCandidateRequest'
responses:
'200':
description: Responses for the candidate.list endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateUpdateExistingCandidateResponse'
/candidate.uploadFile:
post:
tags:
- Candidate
summary: candidate.uploadFile
operationId: Candidate_attachFile
description: >
Uploads a file to attach to the candidate's profile.
**Requires the
[`candidatesWrite`](authentication#permissions-candidateuploadfile)
permission.**
The `Content-Type` of this request must be `multipart/form-data`.
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CandidateAttachFileRequest'
responses:
'200':
description: Responses from the candidate.uploadFile endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateAttachFileResponse'
/candidate.uploadResume:
post:
tags:
- Candidate
summary: candidate.uploadResume
operationId: Candidate_uploadResumeData
description: >
Uploads a candidate's resume, parses it, and updates their information.
**Requires the
[`candidatesWrite`](authentication#permissions-candidateuploadresume)
permission.**
The `Content-Type` of this request must be `multipart/form-data`.
Note: Existing candidate data always takes precedence over data found by
parsing the resume. Resume data only populates candidate data, if it's
data that was missing in the candidate model.
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/CandidateUploadResumeDataRequest'
responses:
'200':
description: Responses from the candidate.uploadResume endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateUploadResumeDataResponse'
/candidateTag.create:
post:
tags:
- Candidate Tag
summary: candidateTag.create
operationId: CandidateTag_createNewTag
description: >
Creates a candidate tag.
**Requires the
[`hiringProcessMetadataWrite`](authentication#permissions-candidatetagcreate)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateTagCreateNewTagRequest'
responses:
'200':
description: Responses for the location.create endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateTagCreateNewTagResponse'
/candidateTag.list:
post:
tags:
- Candidate Tag
summary: candidateTag.list
operationId: CandidateTag_listAll
description: >
Lists all candidate tags
**Requires the
[`hiringProcessMetadataRead`](authentication#permissions-candidatetaglist)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateTagListAllRequest'
responses:
'200':
description: Responses for the candidateTag.list endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CandidateTagListAllResponse'
/customField.create:
post:
tags:
- Custom Field
summary: customField.create
operationId: CustomField_createNewField
description: >
Create a new custom field
**Requires the
[`hiringProcessMetadataWrite`](authentication#permissions-customfieldcreate)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldCreateNewFieldRequest'
responses:
'200':
description: Responses for the customField.create endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldCreateNewFieldResponse'
/customField.list:
post:
tags:
- Custom Field
summary: customField.list
operationId: CustomField_getAll
description: >
Lists all custom fields
**Requires the
[`hiringProcessMetadataRead`](authentication#permissions-customfieldlist)
permission.**
requestBody:
content:
application/json:
schema:
$ref: >-
#/paths/~1candidate.list/post/requestBody/content/application~1json/schema
responses:
'200':
description: Responses for the customField.list endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldGetAllResponse'
/customField.setValue:
post:
tags:
- Custom Field
summary: customField.setValue
operationId: CustomField_setValue
description: >
Set the value of a custom field
**Requires the
[`candidatesWrite`](authentication#permissions-customfieldsetvalue)
permission.**
The values accepted in the `fieldValue` param depend on the type of
field that's being updated. See below for more details:
- Boolean - A boolean value
- Date - An ISO Date string
- Email, LongText, Phone, String - String
- ValueSelect - A string that matches the value of one of the ValueSelect field's options
- MultiValueSelect - An array of strings that exist in the MultiValueSelect field's options
- Number - A number
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldSetValueRequest'
responses:
'200':
description: Responses for the customField.create endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldSetValueResponse'
/department.create:
post:
tags:
- Department & Team
summary: department.create
operationId: DepartmentTeam_createNewDepartment
description: >
Creates a department
**Requires the
[`organizationWrite`](authentication#permissions-departmentcreate)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DepartmentTeamCreateNewDepartmentRequest'
responses:
'200':
description: Responses for the department.create endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/DepartmentTeamCreateNewDepartmentResponse'
/department.info:
post:
tags:
- Department
summary: department.info
operationId: Department_getById
description: >
Fetch department details by id
**Requires the
[`organizationRead`](authentication#permissions-departmentinfo)
permission.**
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DepartmentGetByIdRequest'
responses:
'200':
description: Responses from the department.info endpoint
content:
application/json:
schema:
$ref: '#/components/schemas/DepartmentGetByIdResponse'
/department.list:
post:
tags: