Jobs
Last updated
Last updated
Company Id
Account subdomain
Team member id
curl -L \
--url '/v2/jobs/{id}' \
--header 'Authorization: YOUR_API_KEY'
{
"Description": "text",
"Requirements": "text",
"InternalCode": "text",
"MetatagTitle": "text",
"MetatagDescription": "text",
"MetatagImageUrl": "text",
"JobRole": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"CareerLevel": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"Degree": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"Salary": {
"AmountFrom": 1,
"AmountTo": 1,
"Currency": {
"Id": "text",
"Text": "text",
"Symbol": "text"
}
},
"Industry": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"WebsiteId": 1,
"UId": "123e4567-e89b-12d3-a456-426614174000",
"Id": 1,
"Title": "text",
"Department": {
"Id": 1,
"Name": "text",
"ExternalId": "text",
"ParentId": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
}
},
"Location": {
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite"
},
"Status": "Draft",
"AbsoluteUrl": "text",
"RelativeUrl": "text",
"ShortlinkUrl": "text",
"FriendlyUrl": "text",
"LastModified": "2025-04-02T08:16:48.109Z",
"Schedule": {
"PublishDate": "2025-04-02T08:16:48.109Z",
"PublishStatus": "Draft",
"CloseDate": "2025-04-02T08:16:48.109Z"
},
"Stages": [
{
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"InterviewPlan": {
"Id": 1,
"Title": "text"
},
"Assessments": [
{
"Assessment": {
"Id": 1,
"ExternalId": "text",
"Name": "text",
"Description": "text",
"LearnMore": "text",
"Language": "text",
"AssessmentType": "BehavioralAssessment",
"Vendor": {
"Id": 1,
"Name": "text",
"Logo": "text"
},
"Price": [
{
"Currency": "text",
"Price": 1
}
]
},
"JobId": 1,
"StageId": 1
}
],
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"PartnerAppForExport": [
{
"Title": "text",
"Slug": "text",
"Logo": "text",
"AutoExportEnabled": true
}
],
"Id": 1,
"Name": "text",
"Type": "text",
"Position": 1
}
],
"Meta": {
"Applications": 1,
"ActiveApplications": 1,
"UnreadNotification": 1,
"LastApplication": "2025-04-02T08:16:48.109Z",
"Following": true
},
"Pipeline": {
"Id": 1,
"Name": "text",
"Type": "HiringPipeline",
"Stages": [
{
"Id": 1,
"Name": "text",
"Type": "Sourced",
"Ordinal": 1,
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"Candidates": 1,
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"Evaluations": [
{
"Id": 1,
"Type": "Scorecard",
"Evaluation": null
}
],
"Integrations": [
{
"Type": "JobBoards",
"App": null
}
],
"HasESignatureDocuments": true,
"HasJobOfferDocuments": true
}
],
"IsActive": true
},
"Contract": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"JobTags": [
"text"
],
"JobRequisitionId": "123e4567-e89b-12d3-a456-426614174000",
"JobRequisition": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"HiringManager": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"Owner": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"PlannedStartDate": "text",
"JobRequisitionStatus": "Draft",
"CanUserAccessJobRequisition": true
},
"AdditionalLocations": [
{
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite"
}
]
}
Success
Company Id
Account subdomain
Team member id
curl -L \
--request DELETE \
--url '/v2/jobs/{id}' \
--header 'Authorization: YOUR_API_KEY'
No body
No Content
Company Id
Account subdomain
Team member id
curl -L \
--url '/v2/jobs/locations' \
--header 'Authorization: YOUR_API_KEY'
[]
Success
Company Id
Account subdomain
Team member id
curl -L \
--url '/v2/jobs/{id}/status_changes' \
--header 'Authorization: YOUR_API_KEY'
[
{
"Status": "Draft",
"Created": "2025-04-02T08:16:48.109Z",
"CreatedBy": "text"
}
]
Success
Company Id
Account subdomain
Team member id
curl -L \
--url '/v2/jobs/{id}/stages' \
--header 'Authorization: YOUR_API_KEY'
[
{
"Id": 1,
"Name": "text",
"Type": "text",
"Position": 1
}
]
Success
Company Id
Account subdomain
Team member id
curl -L \
--url '/v2/jobs/{id}/form' \
--header 'Authorization: YOUR_API_KEY'
{
"FormFields": [
{
"Id": 1,
"Key": "text",
"DisplayName": "text",
"Label": "text",
"Type": "text",
"Position": 1,
"FieldLocationType": "PersonalData",
"Required": true,
"Body": "text",
"SupportedTypes": [
"text"
],
"Choices": [
{
"Id": 1,
"Body": "text",
"Disqualify": true,
"Tag": "text",
"Value": 1,
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"DisplayName": "text"
}
],
"Fields": "[Circular Reference]",
"MaxSize": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
}
}
],
"Questions": [
{
"Id": 1,
"Key": "text",
"DisplayName": "text",
"Label": "text",
"Type": "text",
"Position": 1,
"FieldLocationType": "PersonalData",
"Required": true,
"Body": "text",
"SupportedTypes": [
"text"
],
"Choices": [
{
"Id": 1,
"Body": "text",
"Disqualify": true,
"Tag": "text",
"Value": 1,
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"DisplayName": "text"
}
],
"Fields": "[Circular Reference]",
"MaxSize": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
}
}
],
"CustomFields": [
{
"Id": 1,
"Key": "text",
"DisplayName": "text",
"Label": "text",
"Type": "text",
"Position": 1,
"FieldLocationType": "PersonalData",
"Required": true,
"Body": "text",
"SupportedTypes": [
"text"
],
"Choices": [
{
"Id": 1,
"Body": "text",
"Disqualify": true,
"Tag": "text",
"Value": 1,
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"DisplayName": "text"
}
],
"Fields": "[Circular Reference]",
"MaxSize": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
}
}
],
"Gdpr": {
"CompanyLegalName": "text",
"IsEnabled": true,
"RetentionPeriod": 1,
"RequirePrivacyPolicyConsent": true,
"RequireShareCompliance": true,
"ShareComplianceText": "text",
"PrivacyPolicy": "text",
"Email": "text"
},
"Eeoc": {
"EeoSurvey": true,
"OfccpSurvey": true
},
"Compliance": {
"Gdpr": {
"CompanyLegalName": "text",
"IsEnabled": true,
"RetentionPeriod": 1,
"RequirePrivacyPolicyConsent": true,
"RequireShareCompliance": true,
"ShareComplianceText": "text",
"PrivacyPolicy": "text",
"Email": "text"
},
"Eeoc": {
"EeoSurvey": true,
"OfccpSurvey": true
}
}
}
Success
Returns jobs with the current status. Possible values (draft, published, closed, internal and archived).
Department ids
Page, default 1
Per Page, default 20
az, za, modified_date
Language
Title contains value
Job details (description)
Include job stages
Include job requisition
Company Id
Account subdomain
Team member id
curl -L \
--url '/v2/jobs' \
--header 'Authorization: YOUR_API_KEY'
{
"Results": [
{
"Id": 1,
"Title": "text",
"Department": {
"Id": 1,
"Name": "text",
"ExternalId": "text",
"ParentId": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
}
},
"Location": {
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite",
"CityCountry": "text"
},
"Status": "Draft",
"AbsoluteUrl": "text",
"RelativeUrl": "text",
"ShortlinkUrl": "text",
"FriendlyUrl": "text",
"InternalCode": "text",
"LastModified": "2025-04-02T08:16:48.109Z",
"Schedule": {
"PublishDate": "2025-04-02T08:16:48.109Z",
"PublishStatus": "Draft",
"CloseDate": "2025-04-02T08:16:48.109Z"
},
"Stages": [
{
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"Candidates": 1,
"InterviewPlan": {
"Id": 1,
"Title": "text"
},
"Assessments": [
{
"Assessment": {
"Id": 1,
"ExternalId": "text",
"Name": "text",
"Description": "text",
"LearnMore": "text",
"Language": "text",
"AssessmentType": "BehavioralAssessment",
"Vendor": {
"Id": 1,
"Name": "text",
"Logo": "text"
},
"Price": [
{
"Currency": "text",
"Price": 1
}
]
},
"JobId": 1,
"StageId": 1
}
],
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"PartnerAppForExport": [
{
"Title": "text",
"Slug": "text",
"Logo": "text",
"AutoExportEnabled": true
}
],
"Id": 1,
"Name": "text",
"Type": "text",
"Position": 1
}
],
"Meta": {
"Applications": 1,
"ActiveApplications": 1,
"UnreadNotification": 1,
"LastApplication": "2025-04-02T08:16:48.109Z",
"Following": true
},
"Pipeline": {
"Id": 1,
"Name": "text",
"Type": "HiringPipeline",
"Stages": [
{
"Id": 1,
"Name": "text",
"Type": "Sourced",
"Ordinal": 1,
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"Candidates": 1,
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"Evaluations": [
{
"Id": 1,
"Type": "Scorecard",
"Evaluation": null
}
],
"Integrations": [
{
"Type": "JobBoards",
"App": null
}
],
"HasESignatureDocuments": true,
"HasJobOfferDocuments": true
}
],
"IsActive": true
},
"Contract": "[Circular Reference]",
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"JobTags": [
"text"
],
"JobRequisitionId": "123e4567-e89b-12d3-a456-426614174000",
"JobRequisition": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"HiringManager": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"Owner": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"PlannedStartDate": "text",
"JobRequisitionStatus": "Draft",
"CanUserAccessJobRequisition": true
},
"AdditionalLocations": [
{
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite",
"CityCountry": "text"
}
]
}
],
"Count": 1,
"Page": 1,
"PerPage": 1,
"Pages": {
"First": "text",
"Prev": "text",
"Next": "text",
"Last": "text"
},
"IdResults": [
{
"Id": 1,
"Title": "text",
"Department": {
"Id": 1,
"Name": "text",
"ExternalId": "text",
"ParentId": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
}
},
"Location": {
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite",
"CityCountry": "text"
},
"Status": "Draft",
"AbsoluteUrl": "text",
"RelativeUrl": "text",
"ShortlinkUrl": "text",
"FriendlyUrl": "text",
"InternalCode": "text",
"LastModified": "2025-04-02T08:16:48.109Z",
"Schedule": {
"PublishDate": "2025-04-02T08:16:48.109Z",
"PublishStatus": "Draft",
"CloseDate": "2025-04-02T08:16:48.109Z"
},
"Stages": [
{
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"Candidates": 1,
"InterviewPlan": {
"Id": 1,
"Title": "text"
},
"Assessments": [
{
"Assessment": {
"Id": 1,
"ExternalId": "text",
"Name": "text",
"Description": "text",
"LearnMore": "text",
"Language": "text",
"AssessmentType": "BehavioralAssessment",
"Vendor": {
"Id": 1,
"Name": "text",
"Logo": "text"
},
"Price": [
{
"Currency": "text",
"Price": 1
}
]
},
"JobId": 1,
"StageId": 1
}
],
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"PartnerAppForExport": [
{
"Title": "text",
"Slug": "text",
"Logo": "text",
"AutoExportEnabled": true
}
],
"Id": 1,
"Name": "text",
"Type": "text",
"Position": 1
}
],
"Meta": {
"Applications": 1,
"ActiveApplications": 1,
"UnreadNotification": 1,
"LastApplication": "2025-04-02T08:16:48.109Z",
"Following": true
},
"Pipeline": {
"Id": 1,
"Name": "text",
"Type": "HiringPipeline",
"Stages": [
{
"Id": 1,
"Name": "text",
"Type": "Sourced",
"Ordinal": 1,
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"Candidates": 1,
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"Evaluations": [
{
"Id": 1,
"Type": "Scorecard",
"Evaluation": null
}
],
"Integrations": [
{
"Type": "JobBoards",
"App": null
}
],
"HasESignatureDocuments": true,
"HasJobOfferDocuments": true
}
],
"IsActive": true
},
"Contract": "[Circular Reference]",
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"JobTags": [
"text"
],
"JobRequisitionId": "123e4567-e89b-12d3-a456-426614174000",
"JobRequisition": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"HiringManager": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"Owner": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"PlannedStartDate": "text",
"JobRequisitionStatus": "Draft",
"CanUserAccessJobRequisition": true
},
"AdditionalLocations": [
{
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite",
"CityCountry": "text"
}
]
}
],
"OriginalCount": 1
}
Success
Company Id
Account subdomain
Team member id
curl -L \
--request POST \
--url '/v2/jobs' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json-patch+json' \
--data '{
"Description": "text",
"Requirements": "text",
"InternalCode": "text",
"MetatagTitle": "text",
"MetatagDescription": "text",
"MetatagImageUrl": "text",
"JobRole": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"CareerLevel": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"Degree": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"Salary": {
"AmountFrom": 1,
"AmountTo": 1,
"Currency": {
"Id": "text",
"Text": "text",
"Symbol": "text"
}
},
"Industry": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"WebsiteId": 1,
"UId": "123e4567-e89b-12d3-a456-426614174000",
"Id": 1,
"Title": "text",
"Department": {
"Id": 1,
"Name": "text",
"ExternalId": "text",
"ParentId": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
}
},
"Location": {
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite"
},
"Status": "Draft",
"AbsoluteUrl": "text",
"RelativeUrl": "text",
"ShortlinkUrl": "text",
"FriendlyUrl": "text",
"LastModified": "2025-04-02T08:16:48.109Z",
"Schedule": {
"PublishDate": "2025-04-02T08:16:48.109Z",
"PublishStatus": "Draft",
"CloseDate": "2025-04-02T08:16:48.109Z"
},
"Stages": [
{
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"InterviewPlan": {
"Id": 1,
"Title": "text"
},
"Assessments": [
{
"Assessment": {
"Id": 1,
"ExternalId": "text",
"Name": "text",
"Description": "text",
"LearnMore": "text",
"Language": "text",
"AssessmentType": "BehavioralAssessment",
"Vendor": {
"Id": 1,
"Name": "text",
"Logo": "text"
},
"Price": [
{
"Currency": "text",
"Price": 1
}
]
},
"JobId": 1,
"StageId": 1
}
],
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"PartnerAppForExport": [
{
"Title": "text",
"Slug": "text",
"Logo": "text",
"AutoExportEnabled": true
}
],
"Id": 1,
"Name": "text",
"Type": "text",
"Position": 1
}
],
"Meta": {
"Applications": 1,
"ActiveApplications": 1,
"UnreadNotification": 1,
"LastApplication": "2025-04-02T08:16:48.109Z",
"Following": true
},
"Pipeline": {
"Id": 1,
"Name": "text",
"Type": "HiringPipeline",
"Stages": [
{
"Id": 1,
"Name": "text",
"Type": "Sourced",
"Ordinal": 1,
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"Candidates": 1,
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"Evaluations": [
{
"Id": 1,
"Type": "Scorecard",
"Evaluation": null
}
],
"Integrations": [
{
"Type": "JobBoards",
"App": null
}
],
"HasESignatureDocuments": true,
"HasJobOfferDocuments": true
}
],
"IsActive": true
},
"Contract": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"JobTags": [
"text"
],
"JobRequisitionId": "123e4567-e89b-12d3-a456-426614174000",
"JobRequisition": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"HiringManager": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"Owner": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"PlannedStartDate": "text",
"JobRequisitionStatus": "Draft",
"CanUserAccessJobRequisition": true
},
"AdditionalLocations": [
{
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite"
}
]
}'
{
"Description": "text",
"Requirements": "text",
"InternalCode": "text",
"MetatagTitle": "text",
"MetatagDescription": "text",
"MetatagImageUrl": "text",
"JobRole": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"CareerLevel": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"Degree": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"Salary": {
"AmountFrom": 1,
"AmountTo": 1,
"Currency": {
"Id": "text",
"Text": "text",
"Symbol": "text"
}
},
"Industry": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"WebsiteId": 1,
"UId": "123e4567-e89b-12d3-a456-426614174000",
"Id": 1,
"Title": "text",
"Department": {
"Id": 1,
"Name": "text",
"ExternalId": "text",
"ParentId": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
}
},
"Location": {
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite"
},
"Status": "Draft",
"AbsoluteUrl": "text",
"RelativeUrl": "text",
"ShortlinkUrl": "text",
"FriendlyUrl": "text",
"LastModified": "2025-04-02T08:16:48.109Z",
"Schedule": {
"PublishDate": "2025-04-02T08:16:48.109Z",
"PublishStatus": "Draft",
"CloseDate": "2025-04-02T08:16:48.109Z"
},
"Stages": [
{
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"InterviewPlan": {
"Id": 1,
"Title": "text"
},
"Assessments": [
{
"Assessment": {
"Id": 1,
"ExternalId": "text",
"Name": "text",
"Description": "text",
"LearnMore": "text",
"Language": "text",
"AssessmentType": "BehavioralAssessment",
"Vendor": {
"Id": 1,
"Name": "text",
"Logo": "text"
},
"Price": [
{
"Currency": "text",
"Price": 1
}
]
},
"JobId": 1,
"StageId": 1
}
],
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"PartnerAppForExport": [
{
"Title": "text",
"Slug": "text",
"Logo": "text",
"AutoExportEnabled": true
}
],
"Id": 1,
"Name": "text",
"Type": "text",
"Position": 1
}
],
"Meta": {
"Applications": 1,
"ActiveApplications": 1,
"UnreadNotification": 1,
"LastApplication": "2025-04-02T08:16:48.109Z",
"Following": true
},
"Pipeline": {
"Id": 1,
"Name": "text",
"Type": "HiringPipeline",
"Stages": [
{
"Id": 1,
"Name": "text",
"Type": "Sourced",
"Ordinal": 1,
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"Candidates": 1,
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"Evaluations": [
{
"Id": 1,
"Type": "Scorecard",
"Evaluation": null
}
],
"Integrations": [
{
"Type": "JobBoards",
"App": null
}
],
"HasESignatureDocuments": true,
"HasJobOfferDocuments": true
}
],
"IsActive": true
},
"Contract": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"JobTags": [
"text"
],
"JobRequisitionId": "123e4567-e89b-12d3-a456-426614174000",
"JobRequisition": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"HiringManager": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"Owner": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"PlannedStartDate": "text",
"JobRequisitionStatus": "Draft",
"CanUserAccessJobRequisition": true
},
"AdditionalLocations": [
{
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite"
}
]
}
Created
Company Id
Account subdomain
Team member id
curl -L \
--request PUT \
--url '/v2/jobs/{id}' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json-patch+json' \
--data '{
"Description": "text",
"Requirements": "text",
"InternalCode": "text",
"MetatagTitle": "text",
"MetatagDescription": "text",
"MetatagImageUrl": "text",
"JobRole": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"CareerLevel": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"Degree": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"Salary": {
"AmountFrom": 1,
"AmountTo": 1,
"Currency": {
"Id": "text",
"Text": "text",
"Symbol": "text"
}
},
"Industry": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"WebsiteId": 1,
"UId": "123e4567-e89b-12d3-a456-426614174000",
"Id": 1,
"Title": "text",
"Department": {
"Id": 1,
"Name": "text",
"ExternalId": "text",
"ParentId": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
}
},
"Location": {
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite"
},
"Status": "Draft",
"AbsoluteUrl": "text",
"RelativeUrl": "text",
"ShortlinkUrl": "text",
"FriendlyUrl": "text",
"LastModified": "2025-04-02T08:16:48.109Z",
"Schedule": {
"PublishDate": "2025-04-02T08:16:48.109Z",
"PublishStatus": "Draft",
"CloseDate": "2025-04-02T08:16:48.109Z"
},
"Stages": [
{
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"InterviewPlan": {
"Id": 1,
"Title": "text"
},
"Assessments": [
{
"Assessment": {
"Id": 1,
"ExternalId": "text",
"Name": "text",
"Description": "text",
"LearnMore": "text",
"Language": "text",
"AssessmentType": "BehavioralAssessment",
"Vendor": {
"Id": 1,
"Name": "text",
"Logo": "text"
},
"Price": [
{
"Currency": "text",
"Price": 1
}
]
},
"JobId": 1,
"StageId": 1
}
],
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"PartnerAppForExport": [
{
"Title": "text",
"Slug": "text",
"Logo": "text",
"AutoExportEnabled": true
}
],
"Id": 1,
"Name": "text",
"Type": "text",
"Position": 1
}
],
"Meta": {
"Applications": 1,
"ActiveApplications": 1,
"UnreadNotification": 1,
"LastApplication": "2025-04-02T08:16:48.109Z",
"Following": true
},
"Pipeline": {
"Id": 1,
"Name": "text",
"Type": "HiringPipeline",
"Stages": [
{
"Id": 1,
"Name": "text",
"Type": "Sourced",
"Ordinal": 1,
"ActiveCandidates": 1,
"DisqualifiedCandidates": 1,
"Candidates": 1,
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
],
"Evaluations": [
{
"Id": 1,
"Type": "Scorecard",
"Evaluation": null
}
],
"Integrations": [
{
"Type": "JobBoards",
"App": null
}
],
"HasESignatureDocuments": true,
"HasJobOfferDocuments": true
}
],
"IsActive": true
},
"Contract": {
"Value": "text",
"Text": "text",
"Url": "text",
"SecondaryText": "text",
"Children": [
"[Circular Reference]"
]
},
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"JobTags": [
"text"
],
"JobRequisitionId": "123e4567-e89b-12d3-a456-426614174000",
"JobRequisition": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"HiringManager": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"Owner": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T08:16:48.109Z"
},
"PlannedStartDate": "text",
"JobRequisitionStatus": "Draft",
"CanUserAccessJobRequisition": true
},
"AdditionalLocations": [
{
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1,
"WorkLocationType": "OnSite"
}
]
}'
No body
No Content
Company Id
Account subdomain
Team member id
curl -L \
--request PUT \
--url '/v2/jobs/{id}/form' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json-patch+json' \
--data '{
"QuestionRequiredness": {
"Name": "Mandatory",
"FirstName": "Mandatory",
"LastName": "Mandatory",
"Email": "Mandatory",
"Phone": "Mandatory",
"Headline": "Mandatory",
"Address": "Mandatory",
"Photo": "Mandatory",
"SocialProfiles": "Mandatory",
"CoverLetter": "Mandatory",
"Summary": "Mandatory",
"Resume": "Mandatory",
"Education": "Mandatory",
"Experience": "Mandatory",
"Projects": "Mandatory",
"Language": "Mandatory",
"Salutation": "Mandatory",
"Company": "Mandatory",
"KeepSetup": true
},
"Questions": [
{
"Id": 1,
"Key": "text",
"DisplayName": "text",
"Label": "text",
"Type": "text",
"Position": 1,
"FieldLocationType": "PersonalData",
"Required": true,
"Body": "text",
"SupportedTypes": [
"text"
],
"Choices": [
{
"Id": 1,
"Body": "text",
"Disqualify": true,
"Tag": "text",
"Value": 1,
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"DisplayName": "text"
}
],
"Fields": "[Circular Reference]",
"MaxSize": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
}
}
]
}'
No body
No Content