Jobs

Get jobs

GET/v2/jobs
Query parameters
Header parameters
Response

Success

Body
Resultsnullable array of Adopto.Common.Api.Dto.JobSimpleReadOnly (object)
Countinteger (int32)
Pageinteger (int32)
PerPageinteger (int32)
PagesAdopto.Common.Api.Dto.Paging.Pages (object)
IdResultsnullable array of Adopto.Common.Api.Dto.JobSimpleReadOnly (object)
OriginalCountnullable integer (int32)
Request
const response = await fetch('/v2/jobs', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "Results": [
    {
      "Id": 0,
      "Title": "text",
      "Department": {
        "Id": 0,
        "Name": "text",
        "ExternalId": "text",
        "ParentId": 0,
        "IsTranslated": false,
        "Translation": {
          "TranslationProperties": [
            "text"
          ],
          "TranslationRequiredProperties": [
            "text"
          ],
          "Translations": [
            {
              "Language": "text",
              "Property": "text",
              "TranslateValue": "text"
            }
          ]
        }
      },
      "Location": {
        "Id": 0,
        "Country": "text",
        "CountryCode": "text",
        "Region": "text",
        "RegionCode": "text",
        "DistrictId": 0,
        "City": "text",
        "ZipCode": "text",
        "Address": "text",
        "Latitude": 0,
        "Longitude": 0,
        "WorkLocationType": "OnSite",
        "CityCountry": "text"
      },
      "Status": "Draft",
      "AbsoluteUrl": "text",
      "RelativeUrl": "text",
      "ShortlinkUrl": "text",
      "FriendlyUrl": "text",
      "InternalCode": "text",
      "LastModified": "2024-12-21T13:19:23.382Z",
      "Schedule": {
        "PublishDate": "2024-12-21T13:19:23.382Z",
        "PublishStatus": "Draft",
        "CloseDate": "2024-12-21T13:19:23.382Z"
      },
      "Stages": [
        {
          "ActiveCandidates": 0,
          "DisqualifiedCandidates": 0,
          "Candidates": 0,
          "InterviewPlan": {
            "Id": 0,
            "Title": "text"
          },
          "Assessments": [
            {
              "Assessment": {
                "Id": 0,
                "ExternalId": "text",
                "Name": "text",
                "Description": "text",
                "LearnMore": "text",
                "Language": "text",
                "AssessmentType": "BehavioralAssessment",
                "Vendor": {
                  "Id": 0,
                  "Name": "text",
                  "Logo": "text"
                },
                "Price": [
                  {
                    "Currency": "text",
                    "Price": 0
                  }
                ]
              },
              "JobId": 0,
              "StageId": 0
            }
          ],
          "Actions": [
            {
              "Id": 0,
              "Type": "SendEmail"
            }
          ],
          "PartnerAppForExport": [
            {
              "Title": "text",
              "Slug": "text",
              "Logo": "text",
              "AutoExportEnabled": false
            }
          ],
          "Id": 0,
          "Name": "text",
          "Type": "text",
          "Position": 0
        }
      ],
      "Meta": {
        "Applications": 0,
        "ActiveApplications": 0,
        "UnreadNotification": 0,
        "LastApplication": "2024-12-21T13:19:23.382Z",
        "Following": false
      },
      "Pipeline": {
        "Id": 0,
        "Name": "text",
        "Type": "HiringPipeline",
        "Stages": [
          {
            "Id": 0,
            "Name": "text",
            "Type": "Sourced",
            "Ordinal": 0,
            "ActiveCandidates": 0,
            "DisqualifiedCandidates": 0,
            "Candidates": 0,
            "Actions": [
              {
                "Id": 0,
                "Type": "SendEmail"
              }
            ],
            "Evaluations": [
              {
                "Id": 0,
                "Type": "Scorecard"
              }
            ],
            "Integrations": [
              {
                "Type": "JobBoards"
              }
            ],
            "HasESignatureDocuments": false,
            "HasJobOfferDocuments": false
          }
        ],
        "IsActive": false
      },
      "Contract": {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": []
      },
      "IsTranslated": false,
      "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": "2024-12-21T13:19:23.382Z"
        },
        "Owner": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text",
          "Email": "text",
          "SenderEmail": "text",
          "Username": "text",
          "Headline": "text",
          "Avatar": "text",
          "Role": "Administrator",
          "InvitationSentTime": "2024-12-21T13:19:23.382Z"
        },
        "PlannedStartDate": "text",
        "JobRequisitionStatus": "Draft",
        "CanUserAccessJobRequisition": false
      },
      "AdditionalLocations": [
        {
          "Id": 0,
          "Country": "text",
          "CountryCode": "text",
          "Region": "text",
          "RegionCode": "text",
          "DistrictId": 0,
          "City": "text",
          "ZipCode": "text",
          "Address": "text",
          "Latitude": 0,
          "Longitude": 0,
          "WorkLocationType": "OnSite",
          "CityCountry": "text"
        }
      ]
    }
  ],
  "Count": 0,
  "Page": 0,
  "PerPage": 0,
  "Pages": {
    "First": "text",
    "Prev": "text",
    "Next": "text",
    "Last": "text"
  },
  "IdResults": [
    {
      "Id": 0,
      "Title": "text",
      "Department": {
        "Id": 0,
        "Name": "text",
        "ExternalId": "text",
        "ParentId": 0,
        "IsTranslated": false,
        "Translation": {
          "TranslationProperties": [
            "text"
          ],
          "TranslationRequiredProperties": [
            "text"
          ],
          "Translations": [
            {
              "Language": "text",
              "Property": "text",
              "TranslateValue": "text"
            }
          ]
        }
      },
      "Location": {
        "Id": 0,
        "Country": "text",
        "CountryCode": "text",
        "Region": "text",
        "RegionCode": "text",
        "DistrictId": 0,
        "City": "text",
        "ZipCode": "text",
        "Address": "text",
        "Latitude": 0,
        "Longitude": 0,
        "WorkLocationType": "OnSite",
        "CityCountry": "text"
      },
      "Status": "Draft",
      "AbsoluteUrl": "text",
      "RelativeUrl": "text",
      "ShortlinkUrl": "text",
      "FriendlyUrl": "text",
      "InternalCode": "text",
      "LastModified": "2024-12-21T13:19:23.382Z",
      "Schedule": {
        "PublishDate": "2024-12-21T13:19:23.382Z",
        "PublishStatus": "Draft",
        "CloseDate": "2024-12-21T13:19:23.382Z"
      },
      "Stages": [
        {
          "ActiveCandidates": 0,
          "DisqualifiedCandidates": 0,
          "Candidates": 0,
          "InterviewPlan": {
            "Id": 0,
            "Title": "text"
          },
          "Assessments": [
            {
              "Assessment": {
                "Id": 0,
                "ExternalId": "text",
                "Name": "text",
                "Description": "text",
                "LearnMore": "text",
                "Language": "text",
                "AssessmentType": "BehavioralAssessment",
                "Vendor": {
                  "Id": 0,
                  "Name": "text",
                  "Logo": "text"
                },
                "Price": [
                  {
                    "Currency": "text",
                    "Price": 0
                  }
                ]
              },
              "JobId": 0,
              "StageId": 0
            }
          ],
          "Actions": [
            {
              "Id": 0,
              "Type": "SendEmail"
            }
          ],
          "PartnerAppForExport": [
            {
              "Title": "text",
              "Slug": "text",
              "Logo": "text",
              "AutoExportEnabled": false
            }
          ],
          "Id": 0,
          "Name": "text",
          "Type": "text",
          "Position": 0
        }
      ],
      "Meta": {
        "Applications": 0,
        "ActiveApplications": 0,
        "UnreadNotification": 0,
        "LastApplication": "2024-12-21T13:19:23.382Z",
        "Following": false
      },
      "Pipeline": {
        "Id": 0,
        "Name": "text",
        "Type": "HiringPipeline",
        "Stages": [
          {
            "Id": 0,
            "Name": "text",
            "Type": "Sourced",
            "Ordinal": 0,
            "ActiveCandidates": 0,
            "DisqualifiedCandidates": 0,
            "Candidates": 0,
            "Actions": [
              {
                "Id": 0,
                "Type": "SendEmail"
              }
            ],
            "Evaluations": [
              {
                "Id": 0,
                "Type": "Scorecard"
              }
            ],
            "Integrations": [
              {
                "Type": "JobBoards"
              }
            ],
            "HasESignatureDocuments": false,
            "HasJobOfferDocuments": false
          }
        ],
        "IsActive": false
      },
      "Contract": {
        "Value": "text",
        "Text": "text",
        "Url": "text",
        "SecondaryText": "text",
        "Children": []
      },
      "IsTranslated": false,
      "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": "2024-12-21T13:19:23.382Z"
        },
        "Owner": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text",
          "Email": "text",
          "SenderEmail": "text",
          "Username": "text",
          "Headline": "text",
          "Avatar": "text",
          "Role": "Administrator",
          "InvitationSentTime": "2024-12-21T13:19:23.382Z"
        },
        "PlannedStartDate": "text",
        "JobRequisitionStatus": "Draft",
        "CanUserAccessJobRequisition": false
      },
      "AdditionalLocations": [
        {
          "Id": 0,
          "Country": "text",
          "CountryCode": "text",
          "Region": "text",
          "RegionCode": "text",
          "DistrictId": 0,
          "City": "text",
          "ZipCode": "text",
          "Address": "text",
          "Latitude": 0,
          "Longitude": 0,
          "WorkLocationType": "OnSite",
          "CityCountry": "text"
        }
      ]
    }
  ],
  "OriginalCount": 0
}

Create job

POST/v2/jobs
Header parameters
Body
Descriptionnullable string
Requirementsnullable string
InternalCodenullable string
MetatagTitlenullable string
MetatagDescriptionnullable string
MetatagImageUrlnullable string
JobRoleAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
CareerLevelAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
DegreeAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
SalaryAdopto.Common.Api.Dto.Salary (object)
IndustryAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
WebsiteIdnullable integer (int32)
UIdnullable string (uuid)
Idinteger (int32)
Titlenullable string
DepartmentAdopto.Common.Api.Dto.Settings.DepartmentWriteRead (object)
LocationAdopto.Common.Api.Dto.JobLocation (object)
StatusTalentLyft.Data.Enumerators.JobStatusTypes (enum)
DraftPublishedClosedArchivedDeletedGeneralInternal
AbsoluteUrlnullable string
RelativeUrlnullable string
ShortlinkUrlnullable string
FriendlyUrlnullable string
LastModifiedstring (date-time)
ScheduleAdopto.Common.Api.Dto.JobScheduleReadWrite (object)
Stagesnullable array of Adopto.Common.Api.Dto.StageWithCountReadonly (object)
MetaAdopto.Common.Api.Dto.JobSimpleMetaReadOnly (object)
PipelineAdopto.Common.Api.Dto.Pipeline (object)
ContractAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
IsTranslatedboolean
TranslationAdopto.Common.Api.Dto.Translation (object)
JobTagsnullable array of string
JobRequisitionIdnullable string (uuid)
JobRequisitionAdopto.Common.Api.Dto.JobRequisitionSimple (object)
AdditionalLocationsnullable array of Adopto.Common.Api.Dto.JobLocation (object)
Response

Created

Body
Descriptionnullable string
Requirementsnullable string
InternalCodenullable string
MetatagTitlenullable string
MetatagDescriptionnullable string
MetatagImageUrlnullable string
JobRoleAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
CareerLevelAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
DegreeAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
SalaryAdopto.Common.Api.Dto.Salary (object)
IndustryAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
WebsiteIdnullable integer (int32)
UIdnullable string (uuid)
Idinteger (int32)
Titlenullable string
DepartmentAdopto.Common.Api.Dto.Settings.DepartmentWriteRead (object)
LocationAdopto.Common.Api.Dto.JobLocation (object)
StatusTalentLyft.Data.Enumerators.JobStatusTypes (enum)
DraftPublishedClosedArchivedDeletedGeneralInternal
AbsoluteUrlnullable string
RelativeUrlnullable string
ShortlinkUrlnullable string
FriendlyUrlnullable string
LastModifiedstring (date-time)
ScheduleAdopto.Common.Api.Dto.JobScheduleReadWrite (object)
Stagesnullable array of Adopto.Common.Api.Dto.StageWithCountReadonly (object)
MetaAdopto.Common.Api.Dto.JobSimpleMetaReadOnly (object)
PipelineAdopto.Common.Api.Dto.Pipeline (object)
ContractAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
IsTranslatedboolean
TranslationAdopto.Common.Api.Dto.Translation (object)
JobTagsnullable array of string
JobRequisitionIdnullable string (uuid)
JobRequisitionAdopto.Common.Api.Dto.JobRequisitionSimple (object)
AdditionalLocationsnullable array of Adopto.Common.Api.Dto.JobLocation (object)
Request
const response = await fetch('/v2/jobs', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "Description": "text",
  "Requirements": "text",
  "InternalCode": "text",
  "MetatagTitle": "text",
  "MetatagDescription": "text",
  "MetatagImageUrl": "text",
  "JobRole": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": []
  },
  "CareerLevel": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": []
  },
  "Degree": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": []
  },
  "Salary": {
    "AmountFrom": 0,
    "AmountTo": 0,
    "Currency": {
      "Id": "text",
      "Text": "text",
      "Symbol": "text"
    }
  },
  "Industry": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": []
  },
  "WebsiteId": 0,
  "UId": "123e4567-e89b-12d3-a456-426614174000",
  "Id": 0,
  "Title": "text",
  "Department": {
    "Id": 0,
    "Name": "text",
    "ExternalId": "text",
    "ParentId": 0,
    "IsTranslated": false,
    "Translation": {
      "TranslationProperties": [
        "text"
      ],
      "TranslationRequiredProperties": [
        "text"
      ],
      "Translations": [
        {
          "Language": "text",
          "Property": "text",
          "TranslateValue": "text"
        }
      ]
    }
  },
  "Location": {
    "Id": 0,
    "Country": "text",
    "CountryCode": "text",
    "Region": "text",
    "RegionCode": "text",
    "DistrictId": 0,
    "City": "text",
    "ZipCode": "text",
    "Address": "text",
    "Latitude": 0,
    "Longitude": 0,
    "WorkLocationType": "OnSite",
    "CityCountry": "text"
  },
  "Status": "Draft",
  "AbsoluteUrl": "text",
  "RelativeUrl": "text",
  "ShortlinkUrl": "text",
  "FriendlyUrl": "text",
  "LastModified": "2024-12-21T13:19:23.382Z",
  "Schedule": {
    "PublishDate": "2024-12-21T13:19:23.382Z",
    "PublishStatus": "Draft",
    "CloseDate": "2024-12-21T13:19:23.382Z"
  },
  "Stages": [
    {
      "ActiveCandidates": 0,
      "DisqualifiedCandidates": 0,
      "Candidates": 0,
      "InterviewPlan": {
        "Id": 0,
        "Title": "text"
      },
      "Assessments": [
        {
          "Assessment": {
            "Id": 0,
            "ExternalId": "text",
            "Name": "text",
            "Description": "text",
            "LearnMore": "text",
            "Language": "text",
            "AssessmentType": "BehavioralAssessment",
            "Vendor": {
              "Id": 0,
              "Name": "text",
              "Logo": "text"
            },
            "Price": [
              {
                "Currency": "text",
                "Price": 0
              }
            ]
          },
          "JobId": 0,
          "StageId": 0
        }
      ],
      "Actions": [
        {
          "Id": 0,
          "Type": "SendEmail"
        }
      ],
      "PartnerAppForExport": [
        {
          "Title": "text",
          "Slug": "text",
          "Logo": "text",
          "AutoExportEnabled": false
        }
      ],
      "Id": 0,
      "Name": "text",
      "Type": "text",
      "Position": 0
    }
  ],
  "Meta": {
    "Applications": 0,
    "ActiveApplications": 0,
    "UnreadNotification": 0,
    "LastApplication": "2024-12-21T13:19:23.382Z",
    "Following": false
  },
  "Pipeline": {
    "Id": 0,
    "Name": "text",
    "Type": "HiringPipeline",
    "Stages": [
      {
        "Id": 0,
        "Name": "text",
        "Type": "Sourced",
        "Ordinal": 0,
        "ActiveCandidates": 0,
        "DisqualifiedCandidates": 0,
        "Candidates": 0,
        "Actions": [
          {
            "Id": 0,
            "Type": "SendEmail"
          }
        ],
        "Evaluations": [
          {
            "Id": 0,
            "Type": "Scorecard"
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards"
          }
        ],
        "HasESignatureDocuments": false,
        "HasJobOfferDocuments": false
      }
    ],
    "IsActive": false
  },
  "Contract": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": []
  },
  "IsTranslated": false,
  "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": "2024-12-21T13:19:23.382Z"
    },
    "Owner": {
      "Id": "123e4567-e89b-12d3-a456-426614174000",
      "Name": "text",
      "Email": "text",
      "SenderEmail": "text",
      "Username": "text",
      "Headline": "text",
      "Avatar": "text",
      "Role": "Administrator",
      "InvitationSentTime": "2024-12-21T13:19:23.382Z"
    },
    "PlannedStartDate": "text",
    "JobRequisitionStatus": "Draft",
    "CanUserAccessJobRequisition": false
  },
  "AdditionalLocations": [
    {
      "Id": 0,
      "Country": "text",
      "CountryCode": "text",
      "Region": "text",
      "RegionCode": "text",
      "DistrictId": 0,
      "City": "text",
      "ZipCode": "text",
      "Address": "text",
      "Latitude": 0,
      "Longitude": 0,
      "WorkLocationType": "OnSite",
      "CityCountry": "text"
    }
  ]
}

Get Job

GET/v2/jobs/{id}
Path parameters
id*integer (int32)
Query parameters
Header parameters
Response

Success

Body
Descriptionnullable string
Requirementsnullable string
InternalCodenullable string
MetatagTitlenullable string
MetatagDescriptionnullable string
MetatagImageUrlnullable string
JobRoleAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
CareerLevelAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
DegreeAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
SalaryAdopto.Common.Api.Dto.Salary (object)
IndustryAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
WebsiteIdnullable integer (int32)
UIdnullable string (uuid)
Idinteger (int32)
Titlenullable string
DepartmentAdopto.Common.Api.Dto.Settings.DepartmentWriteRead (object)
LocationAdopto.Common.Api.Dto.JobLocation (object)
StatusTalentLyft.Data.Enumerators.JobStatusTypes (enum)
DraftPublishedClosedArchivedDeletedGeneralInternal
AbsoluteUrlnullable string
RelativeUrlnullable string
ShortlinkUrlnullable string
FriendlyUrlnullable string
LastModifiedstring (date-time)
ScheduleAdopto.Common.Api.Dto.JobScheduleReadWrite (object)
Stagesnullable array of Adopto.Common.Api.Dto.StageWithCountReadonly (object)
MetaAdopto.Common.Api.Dto.JobSimpleMetaReadOnly (object)
PipelineAdopto.Common.Api.Dto.Pipeline (object)
ContractAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
IsTranslatedboolean
TranslationAdopto.Common.Api.Dto.Translation (object)
JobTagsnullable array of string
JobRequisitionIdnullable string (uuid)
JobRequisitionAdopto.Common.Api.Dto.JobRequisitionSimple (object)
AdditionalLocationsnullable array of Adopto.Common.Api.Dto.JobLocation (object)
Request
const response = await fetch('/v2/jobs/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "Description": "text",
  "Requirements": "text",
  "InternalCode": "text",
  "MetatagTitle": "text",
  "MetatagDescription": "text",
  "MetatagImageUrl": "text",
  "JobRole": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": []
  },
  "CareerLevel": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": []
  },
  "Degree": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": []
  },
  "Salary": {
    "AmountFrom": 0,
    "AmountTo": 0,
    "Currency": {
      "Id": "text",
      "Text": "text",
      "Symbol": "text"
    }
  },
  "Industry": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": []
  },
  "WebsiteId": 0,
  "UId": "123e4567-e89b-12d3-a456-426614174000",
  "Id": 0,
  "Title": "text",
  "Department": {
    "Id": 0,
    "Name": "text",
    "ExternalId": "text",
    "ParentId": 0,
    "IsTranslated": false,
    "Translation": {
      "TranslationProperties": [
        "text"
      ],
      "TranslationRequiredProperties": [
        "text"
      ],
      "Translations": [
        {
          "Language": "text",
          "Property": "text",
          "TranslateValue": "text"
        }
      ]
    }
  },
  "Location": {
    "Id": 0,
    "Country": "text",
    "CountryCode": "text",
    "Region": "text",
    "RegionCode": "text",
    "DistrictId": 0,
    "City": "text",
    "ZipCode": "text",
    "Address": "text",
    "Latitude": 0,
    "Longitude": 0,
    "WorkLocationType": "OnSite",
    "CityCountry": "text"
  },
  "Status": "Draft",
  "AbsoluteUrl": "text",
  "RelativeUrl": "text",
  "ShortlinkUrl": "text",
  "FriendlyUrl": "text",
  "LastModified": "2024-12-21T13:19:23.382Z",
  "Schedule": {
    "PublishDate": "2024-12-21T13:19:23.382Z",
    "PublishStatus": "Draft",
    "CloseDate": "2024-12-21T13:19:23.382Z"
  },
  "Stages": [
    {
      "ActiveCandidates": 0,
      "DisqualifiedCandidates": 0,
      "Candidates": 0,
      "InterviewPlan": {
        "Id": 0,
        "Title": "text"
      },
      "Assessments": [
        {
          "Assessment": {
            "Id": 0,
            "ExternalId": "text",
            "Name": "text",
            "Description": "text",
            "LearnMore": "text",
            "Language": "text",
            "AssessmentType": "BehavioralAssessment",
            "Vendor": {
              "Id": 0,
              "Name": "text",
              "Logo": "text"
            },
            "Price": [
              {
                "Currency": "text",
                "Price": 0
              }
            ]
          },
          "JobId": 0,
          "StageId": 0
        }
      ],
      "Actions": [
        {
          "Id": 0,
          "Type": "SendEmail"
        }
      ],
      "PartnerAppForExport": [
        {
          "Title": "text",
          "Slug": "text",
          "Logo": "text",
          "AutoExportEnabled": false
        }
      ],
      "Id": 0,
      "Name": "text",
      "Type": "text",
      "Position": 0
    }
  ],
  "Meta": {
    "Applications": 0,
    "ActiveApplications": 0,
    "UnreadNotification": 0,
    "LastApplication": "2024-12-21T13:19:23.382Z",
    "Following": false
  },
  "Pipeline": {
    "Id": 0,
    "Name": "text",
    "Type": "HiringPipeline",
    "Stages": [
      {
        "Id": 0,
        "Name": "text",
        "Type": "Sourced",
        "Ordinal": 0,
        "ActiveCandidates": 0,
        "DisqualifiedCandidates": 0,
        "Candidates": 0,
        "Actions": [
          {
            "Id": 0,
            "Type": "SendEmail"
          }
        ],
        "Evaluations": [
          {
            "Id": 0,
            "Type": "Scorecard"
          }
        ],
        "Integrations": [
          {
            "Type": "JobBoards"
          }
        ],
        "HasESignatureDocuments": false,
        "HasJobOfferDocuments": false
      }
    ],
    "IsActive": false
  },
  "Contract": {
    "Value": "text",
    "Text": "text",
    "Url": "text",
    "SecondaryText": "text",
    "Children": []
  },
  "IsTranslated": false,
  "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": "2024-12-21T13:19:23.382Z"
    },
    "Owner": {
      "Id": "123e4567-e89b-12d3-a456-426614174000",
      "Name": "text",
      "Email": "text",
      "SenderEmail": "text",
      "Username": "text",
      "Headline": "text",
      "Avatar": "text",
      "Role": "Administrator",
      "InvitationSentTime": "2024-12-21T13:19:23.382Z"
    },
    "PlannedStartDate": "text",
    "JobRequisitionStatus": "Draft",
    "CanUserAccessJobRequisition": false
  },
  "AdditionalLocations": [
    {
      "Id": 0,
      "Country": "text",
      "CountryCode": "text",
      "Region": "text",
      "RegionCode": "text",
      "DistrictId": 0,
      "City": "text",
      "ZipCode": "text",
      "Address": "text",
      "Latitude": 0,
      "Longitude": 0,
      "WorkLocationType": "OnSite",
      "CityCountry": "text"
    }
  ]
}

Update job

PUT/v2/jobs/{id}
Path parameters
id*integer (int32)
Header parameters
Body
Descriptionnullable string
Requirementsnullable string
InternalCodenullable string
MetatagTitlenullable string
MetatagDescriptionnullable string
MetatagImageUrlnullable string
JobRoleAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
CareerLevelAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
DegreeAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
SalaryAdopto.Common.Api.Dto.Salary (object)
IndustryAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
WebsiteIdnullable integer (int32)
UIdnullable string (uuid)
Idinteger (int32)
Titlenullable string
DepartmentAdopto.Common.Api.Dto.Settings.DepartmentWriteRead (object)
LocationAdopto.Common.Api.Dto.JobLocation (object)
StatusTalentLyft.Data.Enumerators.JobStatusTypes (enum)
DraftPublishedClosedArchivedDeletedGeneralInternal
AbsoluteUrlnullable string
RelativeUrlnullable string
ShortlinkUrlnullable string
FriendlyUrlnullable string
LastModifiedstring (date-time)
ScheduleAdopto.Common.Api.Dto.JobScheduleReadWrite (object)
Stagesnullable array of Adopto.Common.Api.Dto.StageWithCountReadonly (object)
MetaAdopto.Common.Api.Dto.JobSimpleMetaReadOnly (object)
PipelineAdopto.Common.Api.Dto.Pipeline (object)
ContractAdopto.Common.Api.Dto.Infrastructure.CodeReadonly (object)
IsTranslatedboolean
TranslationAdopto.Common.Api.Dto.Translation (object)
JobTagsnullable array of string
JobRequisitionIdnullable string (uuid)
JobRequisitionAdopto.Common.Api.Dto.JobRequisitionSimple (object)
AdditionalLocationsnullable array of Adopto.Common.Api.Dto.JobLocation (object)
Response

No Content

Request
const response = await fetch('/v2/jobs/{id}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "Message": "text",
  "Errors": [
    {
      "Field": "text",
      "Message": "text"
    }
  ],
  "ErrorCode": 0
}

Delete job

DELETE/v2/jobs/{id}
Path parameters
id*integer (int32)
Header parameters
Response

No Content

Request
const response = await fetch('/v2/jobs/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();
Response
{
  "Message": "text",
  "Errors": [
    {
      "Field": "text",
      "Message": "text"
    }
  ],
  "ErrorCode": 0
}

Returns a collection of the locations of the public jobs

GET/v2/jobs/locations
Query parameters
Header parameters
Response

Success

Body
itemsany
Request
const response = await fetch('/v2/jobs/locations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[]

Job status changes

GET/v2/jobs/{id}/status_changes
Path parameters
id*integer (int32)
Header parameters
Response

Success

Body
StatusTalentLyft.Data.Enumerators.JobStatusTypes (enum)
DraftPublishedClosedArchivedDeletedGeneralInternal
Createdstring (date-time)
CreatedBynullable string
Request
const response = await fetch('/v2/jobs/{id}/status_changes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "Status": "Draft",
    "Created": "2024-12-21T13:19:23.382Z",
    "CreatedBy": "text"
  }
]

Get job stages

GET/v2/jobs/{id}/stages
Path parameters
id*integer (int32)
Header parameters
Response

Success

Body
Idinteger (int32)
Namenullable string
Typenullable string
Positioninteger (int32)
Request
const response = await fetch('/v2/jobs/{id}/stages', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
[
  {
    "Id": 0,
    "Name": "text",
    "Type": "text",
    "Position": 0
  }
]

Get Job Form

GET/v2/jobs/{id}/form
Path parameters
id*integer (int32)
Query parameters
Header parameters
Response

Success

Body
FormFieldsnullable array of Adopto.Common.Api.Dto.ApplicationFormFieldReadonly (object)
Questionsnullable array of Adopto.Common.Api.Dto.ApplicationFormFieldReadonly (object)
CustomFieldsnullable array of Adopto.Common.Api.Dto.ApplicationFormFieldReadonly (object)
GdprAdopto.Common.Api.Dto.GdprReadonly (object)
EeocAdopto.Common.Api.Dto.EeoReadWrite (object)
ComplianceAdopto.Common.Api.Dto.Compliance (object)
Request
const response = await fetch('/v2/jobs/{id}/form', {
    method: 'GET',
    headers: {},
});
const data = await response.json();
Response
{
  "FormFields": [
    {
      "Id": 0,
      "Key": "text",
      "DisplayName": "text",
      "Label": "text",
      "Type": "text",
      "Position": 0,
      "FieldLocationType": "PersonalData",
      "Required": false,
      "Body": "text",
      "SupportedTypes": [
        "text"
      ],
      "Choices": [
        {
          "Id": 0,
          "Body": "text",
          "Disqualify": false,
          "Tag": "text",
          "Value": 0,
          "Ordinal": 0,
          "IsTranslated": false,
          "Translation": {
            "TranslationProperties": [
              "text"
            ],
            "TranslationRequiredProperties": [
              "text"
            ],
            "Translations": [
              {
                "Language": "text",
                "Property": "text",
                "TranslateValue": "text"
              }
            ]
          },
          "DisplayName": "text"
        }
      ],
      "Fields": [],
      "MaxSize": 0,
      "IsTranslated": false,
      "Translation": {
        "TranslationProperties": [
          "text"
        ],
        "TranslationRequiredProperties": [
          "text"
        ],
        "Translations": [
          {
            "Language": "text",
            "Property": "text",
            "TranslateValue": "text"
          }
        ]
      }
    }
  ],
  "Questions": [
    {
      "Id": 0,
      "Key": "text",
      "DisplayName": "text",
      "Label": "text",
      "Type": "text",
      "Position": 0,
      "FieldLocationType": "PersonalData",
      "Required": false,
      "Body": "text",
      "SupportedTypes": [
        "text"
      ],
      "Choices": [
        {
          "Id": 0,
          "Body": "text",
          "Disqualify": false,
          "Tag": "text",
          "Value": 0,
          "Ordinal": 0,
          "IsTranslated": false,
          "Translation": {
            "TranslationProperties": [
              "text"
            ],
            "TranslationRequiredProperties": [
              "text"
            ],
            "Translations": [
              {
                "Language": "text",
                "Property": "text",
                "TranslateValue": "text"
              }
            ]
          },
          "DisplayName": "text"
        }
      ],
      "Fields": [],
      "MaxSize": 0,
      "IsTranslated": false,
      "Translation": {
        "TranslationProperties": [
          "text"
        ],
        "TranslationRequiredProperties": [
          "text"
        ],
        "Translations": [
          {
            "Language": "text",
            "Property": "text",
            "TranslateValue": "text"
          }
        ]
      }
    }
  ],
  "CustomFields": [
    {
      "Id": 0,
      "Key": "text",
      "DisplayName": "text",
      "Label": "text",
      "Type": "text",
      "Position": 0,
      "FieldLocationType": "PersonalData",
      "Required": false,
      "Body": "text",
      "SupportedTypes": [
        "text"
      ],
      "Choices": [
        {
          "Id": 0,
          "Body": "text",
          "Disqualify": false,
          "Tag": "text",
          "Value": 0,
          "Ordinal": 0,
          "IsTranslated": false,
          "Translation": {
            "TranslationProperties": [
              "text"
            ],
            "TranslationRequiredProperties": [
              "text"
            ],
            "Translations": [
              {
                "Language": "text",
                "Property": "text",
                "TranslateValue": "text"
              }
            ]
          },
          "DisplayName": "text"
        }
      ],
      "Fields": [],
      "MaxSize": 0,
      "IsTranslated": false,
      "Translation": {
        "TranslationProperties": [
          "text"
        ],
        "TranslationRequiredProperties": [
          "text"
        ],
        "Translations": [
          {
            "Language": "text",
            "Property": "text",
            "TranslateValue": "text"
          }
        ]
      }
    }
  ],
  "Gdpr": {
    "CompanyLegalName": "text",
    "IsEnabled": false,
    "RetentionPeriod": 0,
    "RequirePrivacyPolicyConsent": false,
    "RequireShareCompliance": false,
    "ShareComplianceText": "text",
    "PrivacyPolicy": "text",
    "Email": "text"
  },
  "Eeoc": {
    "EeoSurvey": false,
    "OfccpSurvey": false
  },
  "Compliance": {
    "Gdpr": {
      "CompanyLegalName": "text",
      "IsEnabled": false,
      "RetentionPeriod": 0,
      "RequirePrivacyPolicyConsent": false,
      "RequireShareCompliance": false,
      "ShareComplianceText": "text",
      "PrivacyPolicy": "text",
      "Email": "text"
    },
    "Eeoc": {
      "EeoSurvey": false,
      "OfccpSurvey": false
    }
  }
}

Update job's form

PUT/v2/jobs/{id}/form
Path parameters
id*integer (int32)
Header parameters
Body
QuestionRequirednessAdopto.Common.Api.Dto.QuestionRequiredness (object)
Questionsnullable array of Adopto.Common.Api.Dto.ApplicationFormFieldReadonly (object)
Response

No Content

Request
const response = await fetch('/v2/jobs/{id}/form', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "Message": "text",
  "Errors": [
    {
      "Field": "text",
      "Message": "text"
    }
  ],
  "ErrorCode": 0
}

Last updated