Jobs | TalentLyft API

TalentLyft API

Help Login Register Go to App Go to TalentLyft Request a Demo

Get Job

get

Authorizations

Path parameters

idinteger · int32Required

Query parameters

languageCodestringOptional

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

application/json

objectOptional

application/json

get

GET /v2/jobs/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "Description": "text",
  "Requirements": "text",
  "InternalCode": "text",
  "MetatagTitle": "text",
  "MetatagDescription": "text",
  "MetatagImageUrl": "text",
  "JobRole": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "Value": "text",
            "Text": "text",
            "Url": "text",
            "SecondaryText": "text",
            "Children": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "CareerLevel": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "Value": "text",
            "Text": "text",
            "Url": "text",
            "SecondaryText": "text",
            "Children": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "Degree": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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",
    "CityCountry": "text"
  },
  "Status": "Draft",
  "AbsoluteUrl": "text",
  "RelativeUrl": "text",
  "ShortlinkUrl": "text",
  "FriendlyUrl": "text",
  "LastModified": "2025-04-24T05:19:33.229Z",
  "Schedule": {
    "PublishDate": "2025-04-24T05:19:33.229Z",
    "PublishStatus": "Draft",
    "CloseDate": "2025-04-24T05:19:33.229Z"
  },
  "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
              }
            ],
            "CanBeOrdered": true
          },
          "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-24T05:19:33.229Z",
    "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
          }
        ],
        "ActionsAfterDaysWaitingInStage": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ],
        "Evaluations": [
          {
            "Id": 1,
            "Type": "Scorecard",
            "Evaluation": null
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards",
            "App": null
          }
        ],
        "HasESignatureDocuments": true,
        "HasJobOfferDocuments": true,
        "DaysWaitingInStage": 1,
        "DontSkipStage": true
      }
    ],
    "IsActive": true
  },
  "Contract": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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-24T05:19:33.229Z"
    },
    "Owner": {
      "Id": "123e4567-e89b-12d3-a456-426614174000",
      "Name": "text",
      "Email": "text",
      "SenderEmail": "text",
      "Username": "text",
      "Headline": "text",
      "Avatar": "text",
      "Role": "Administrator",
      "InvitationSentTime": "2025-04-24T05:19:33.229Z"
    },
    "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"
    }
  ]
}

Delete job

delete

Authorizations

Path parameters

idinteger · int32Required

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

application/json

delete

DELETE /v2/jobs/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Returns a collection of the locations of the public jobs

get

Authorizations

Query parameters

subdomainstringOptional

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

application/json

any[]Optional

application/json

get

GET /v2/jobs/locations HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[]

Job status changes

get

Authorizations

Path parameters

idinteger · int32Required

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

application/json

object[]Optional

application/json

get

GET /v2/jobs/{id}/status_changes HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Status": "Draft",
    "Created": "2025-04-24T05:19:33.229Z",
    "CreatedBy": "text"
  }
]

Get job stages

get

Authorizations

Path parameters

idinteger · int32Required

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

application/json

object[]Optional

application/json

get

GET /v2/jobs/{id}/stages HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "Id": 1,
    "Name": "text",
    "Type": "text",
    "Position": 1
  }
]

Get Job Form

get

Authorizations

Path parameters

idinteger · int32Required

Query parameters

languageCodestringOptional

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

application/json

objectOptional

application/json

get

GET /v2/jobs/{id}/form HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "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": [
        {
          "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"
              }
            ]
          }
        }
      ],
      "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": [
        {
          "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"
              }
            ]
          }
        }
      ],
      "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": [
        {
          "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"
              }
            ]
          }
        }
      ],
      "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
    }
  }
}

Get jobs

get

Authorizations

Query parameters

statusstring · enum[]Optional

Returns jobs with the current status. Possible values (draft, published, closed, internal and archived).

locationsstring[]Optional

tagsstring[]Optional

departmentsinteger · int32[]Optional

Department ids

pageinteger · int32Optional

Page, default 1

Default: 1

perPageinteger · int32Optional

Per Page, default 20

Default: 20

sortstringOptional

az, za, modified_date

Default: az

languageCodestringOptional

Language

containsstringOptional

Title contains value

detailsbooleanOptional

Job details (description)

Default: false

includeStagesbooleanOptional

Include job stages

Default: false

includeJobRequisitionbooleanOptional

Include job requisition

Default: false

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Responses

application/json

objectOptional

application/json

get

GET /v2/jobs HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "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-24T05:19:33.229Z",
      "Schedule": {
        "PublishDate": "2025-04-24T05:19:33.229Z",
        "PublishStatus": "Draft",
        "CloseDate": "2025-04-24T05:19:33.229Z"
      },
      "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
                  }
                ],
                "CanBeOrdered": true
              },
              "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-24T05:19:33.229Z",
        "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
              }
            ],
            "ActionsAfterDaysWaitingInStage": [
              {
                "Id": 1,
                "Type": "SendEmail",
                "Action": null
              }
            ],
            "Evaluations": [
              {
                "Id": 1,
                "Type": "Scorecard",
                "Evaluation": null
              }
            ],
            "Integrations": [
              {
                "Type": "JobBoards",
                "App": null
              }
            ],
            "HasESignatureDocuments": true,
            "HasJobOfferDocuments": true,
            "DaysWaitingInStage": 1,
            "DontSkipStage": true
          }
        ],
        "IsActive": true
      },
      "Contract": {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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-24T05:19:33.229Z"
        },
        "Owner": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text",
          "Email": "text",
          "SenderEmail": "text",
          "Username": "text",
          "Headline": "text",
          "Avatar": "text",
          "Role": "Administrator",
          "InvitationSentTime": "2025-04-24T05:19:33.229Z"
        },
        "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-24T05:19:33.229Z",
      "Schedule": {
        "PublishDate": "2025-04-24T05:19:33.229Z",
        "PublishStatus": "Draft",
        "CloseDate": "2025-04-24T05:19:33.229Z"
      },
      "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
                  }
                ],
                "CanBeOrdered": true
              },
              "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-24T05:19:33.229Z",
        "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
              }
            ],
            "ActionsAfterDaysWaitingInStage": [
              {
                "Id": 1,
                "Type": "SendEmail",
                "Action": null
              }
            ],
            "Evaluations": [
              {
                "Id": 1,
                "Type": "Scorecard",
                "Evaluation": null
              }
            ],
            "Integrations": [
              {
                "Type": "JobBoards",
                "App": null
              }
            ],
            "HasESignatureDocuments": true,
            "HasJobOfferDocuments": true,
            "DaysWaitingInStage": 1,
            "DontSkipStage": true
          }
        ],
        "IsActive": true
      },
      "Contract": {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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-24T05:19:33.229Z"
        },
        "Owner": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text",
          "Email": "text",
          "SenderEmail": "text",
          "Username": "text",
          "Headline": "text",
          "Avatar": "text",
          "Role": "Administrator",
          "InvitationSentTime": "2025-04-24T05:19:33.229Z"
        },
        "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
}

Create job

post

Authorizations

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Body

Descriptionstring | nullableOptional

Requirementsstring | nullableOptional

InternalCodestring | nullableOptional

MetatagTitlestring | nullableOptional

MetatagDescriptionstring | nullableOptional

MetatagImageUrlstring | nullableOptional

JobRoleobjectOptional

CareerLevelobjectOptional

DegreeobjectOptional

SalaryobjectOptional

IndustryobjectOptional

WebsiteIdinteger · int32 | nullableOptional

UIdstring · uuid | nullableOptional

Idinteger · int32Optional

Titlestring | nullableOptional

DepartmentobjectOptional

LocationobjectOptional

Statusstring · enumOptionalAvailable options:

AbsoluteUrlstring | nullableOptional

RelativeUrlstring | nullableOptional

ShortlinkUrlstring | nullableOptional

FriendlyUrlstring | nullableOptional

LastModifiedstring · date-timeOptional

ScheduleobjectOptional

Stagesobject[] | nullableOptional

MetaobjectOptional

PipelineobjectOptional

ContractobjectOptional

IsTranslatedbooleanOptional

TranslationobjectOptional

JobTagsstring[] | nullableOptional

JobRequisitionIdstring · uuid | nullableOptional

JobRequisitionobjectOptional

AdditionalLocationsobject[] | nullableOptional

Responses

application/json

objectOptional

application/json

post

POST /v2/jobs HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 4775

{
  "Description": "text",
  "Requirements": "text",
  "InternalCode": "text",
  "MetatagTitle": "text",
  "MetatagDescription": "text",
  "MetatagImageUrl": "text",
  "JobRole": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "Value": "text",
            "Text": "text",
            "Url": "text",
            "SecondaryText": "text",
            "Children": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "CareerLevel": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "Value": "text",
            "Text": "text",
            "Url": "text",
            "SecondaryText": "text",
            "Children": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "Degree": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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-24T05:19:33.229Z",
  "Schedule": {
    "PublishDate": "2025-04-24T05:19:33.229Z",
    "PublishStatus": "Draft",
    "CloseDate": "2025-04-24T05:19:33.229Z"
  },
  "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
              }
            ],
            "CanBeOrdered": true
          },
          "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-24T05:19:33.229Z",
    "Following": true
  },
  "Pipeline": {
    "Id": 1,
    "Name": "text",
    "Type": "HiringPipeline",
    "Stages": [
      {
        "Id": 1,
        "Name": "text",
        "Type": "Sourced",
        "Ordinal": 1,
        "ActiveCandidates": 1,
        "DisqualifiedCandidates": 1,
        "Actions": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ],
        "ActionsAfterDaysWaitingInStage": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ],
        "Evaluations": [
          {
            "Id": 1,
            "Type": "Scorecard",
            "Evaluation": null
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards",
            "App": null
          }
        ],
        "HasESignatureDocuments": true,
        "HasJobOfferDocuments": true,
        "DaysWaitingInStage": 1,
        "DontSkipStage": true
      }
    ],
    "IsActive": true
  },
  "Contract": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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-24T05:19:33.229Z"
    },
    "Owner": {
      "Id": "123e4567-e89b-12d3-a456-426614174000",
      "Name": "text",
      "Email": "text",
      "SenderEmail": "text",
      "Username": "text",
      "Headline": "text",
      "Avatar": "text",
      "Role": "Administrator",
      "InvitationSentTime": "2025-04-24T05:19:33.229Z"
    },
    "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": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "Value": "text",
            "Text": "text",
            "Url": "text",
            "SecondaryText": "text",
            "Children": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "CareerLevel": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "Value": "text",
            "Text": "text",
            "Url": "text",
            "SecondaryText": "text",
            "Children": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "Degree": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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",
    "CityCountry": "text"
  },
  "Status": "Draft",
  "AbsoluteUrl": "text",
  "RelativeUrl": "text",
  "ShortlinkUrl": "text",
  "FriendlyUrl": "text",
  "LastModified": "2025-04-24T05:19:33.229Z",
  "Schedule": {
    "PublishDate": "2025-04-24T05:19:33.229Z",
    "PublishStatus": "Draft",
    "CloseDate": "2025-04-24T05:19:33.229Z"
  },
  "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
              }
            ],
            "CanBeOrdered": true
          },
          "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-24T05:19:33.229Z",
    "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
          }
        ],
        "ActionsAfterDaysWaitingInStage": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ],
        "Evaluations": [
          {
            "Id": 1,
            "Type": "Scorecard",
            "Evaluation": null
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards",
            "App": null
          }
        ],
        "HasESignatureDocuments": true,
        "HasJobOfferDocuments": true,
        "DaysWaitingInStage": 1,
        "DontSkipStage": true
      }
    ],
    "IsActive": true
  },
  "Contract": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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-24T05:19:33.229Z"
    },
    "Owner": {
      "Id": "123e4567-e89b-12d3-a456-426614174000",
      "Name": "text",
      "Email": "text",
      "SenderEmail": "text",
      "Username": "text",
      "Headline": "text",
      "Avatar": "text",
      "Role": "Administrator",
      "InvitationSentTime": "2025-04-24T05:19:33.229Z"
    },
    "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"
    }
  ]
}

Update job

put

Authorizations

Path parameters

idinteger · int32Required

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Body

Descriptionstring | nullableOptional

Requirementsstring | nullableOptional

InternalCodestring | nullableOptional

MetatagTitlestring | nullableOptional

MetatagDescriptionstring | nullableOptional

MetatagImageUrlstring | nullableOptional

JobRoleobjectOptional

CareerLevelobjectOptional

DegreeobjectOptional

SalaryobjectOptional

IndustryobjectOptional

WebsiteIdinteger · int32 | nullableOptional

UIdstring · uuid | nullableOptional

Idinteger · int32Optional

Titlestring | nullableOptional

DepartmentobjectOptional

LocationobjectOptional

Statusstring · enumOptionalAvailable options:

AbsoluteUrlstring | nullableOptional

RelativeUrlstring | nullableOptional

ShortlinkUrlstring | nullableOptional

FriendlyUrlstring | nullableOptional

LastModifiedstring · date-timeOptional

ScheduleobjectOptional

Stagesobject[] | nullableOptional

MetaobjectOptional

PipelineobjectOptional

ContractobjectOptional

IsTranslatedbooleanOptional

TranslationobjectOptional

JobTagsstring[] | nullableOptional

JobRequisitionIdstring · uuid | nullableOptional

JobRequisitionobjectOptional

AdditionalLocationsobject[] | nullableOptional

Responses

application/json

put

PUT /v2/jobs/{id} HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 4775

{
  "Description": "text",
  "Requirements": "text",
  "InternalCode": "text",
  "MetatagTitle": "text",
  "MetatagDescription": "text",
  "MetatagImageUrl": "text",
  "JobRole": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "Value": "text",
            "Text": "text",
            "Url": "text",
            "SecondaryText": "text",
            "Children": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "CareerLevel": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "Value": "text",
            "Text": "text",
            "Url": "text",
            "SecondaryText": "text",
            "Children": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "Degree": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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-24T05:19:33.229Z",
  "Schedule": {
    "PublishDate": "2025-04-24T05:19:33.229Z",
    "PublishStatus": "Draft",
    "CloseDate": "2025-04-24T05:19:33.229Z"
  },
  "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
              }
            ],
            "CanBeOrdered": true
          },
          "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-24T05:19:33.229Z",
    "Following": true
  },
  "Pipeline": {
    "Id": 1,
    "Name": "text",
    "Type": "HiringPipeline",
    "Stages": [
      {
        "Id": 1,
        "Name": "text",
        "Type": "Sourced",
        "Ordinal": 1,
        "ActiveCandidates": 1,
        "DisqualifiedCandidates": 1,
        "Actions": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ],
        "ActionsAfterDaysWaitingInStage": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ],
        "Evaluations": [
          {
            "Id": 1,
            "Type": "Scorecard",
            "Evaluation": null
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards",
            "App": null
          }
        ],
        "HasESignatureDocuments": true,
        "HasJobOfferDocuments": true,
        "DaysWaitingInStage": 1,
        "DontSkipStage": true
      }
    ],
    "IsActive": true
  },
  "Contract": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": [
      {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": [
          {
            "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-24T05:19:33.229Z"
    },
    "Owner": {
      "Id": "123e4567-e89b-12d3-a456-426614174000",
      "Name": "text",
      "Email": "text",
      "SenderEmail": "text",
      "Username": "text",
      "Headline": "text",
      "Avatar": "text",
      "Role": "Administrator",
      "InvitationSentTime": "2025-04-24T05:19:33.229Z"
    },
    "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 content

Update job's form

put

Authorizations

Path parameters

idinteger · int32Required

Header parameters

X-TL-CompanyIdguidOptional

Company Id

X-TL-SubdomainguidOptional

Account subdomain

X-TL-UserIdguidOptional

Team member id

Body

QuestionRequirednessobjectOptional

Questionsobject[] | nullableOptional

Responses

application/json

put

PUT /v2/jobs/{id}/form HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 1863

{
  "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": [
        {
          "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"
              }
            ]
          }
        }
      ],
      "MaxSize": 1,
      "IsTranslated": true,
      "Translation": {
        "TranslationProperties": [
          "text"
        ],
        "TranslationRequiredProperties": [
          "text"
        ],
        "Translations": [
          {
            "Language": "text",
            "Property": "text",
            "TranslateValue": "text"
          }
        ]
      }
    }
  ]
}

No content