Forms
Get forms
GET/v2/forms
Query parameters
Header parameters
Response
Success
Body
Resultsnullable array of Adopto.Common.Api.Dto.Convert.ConvertForm (object)
Countinteger (int32)
Pageinteger (int32)
PerPageinteger (int32)
PagesAdopto.Common.Api.Dto.Paging.Pages (object)
IdResultsnullable array of Adopto.Common.Api.Dto.Convert.ConvertForm (object)
OriginalCountnullable integer (int32)
Request
const response = await fetch('/v2/forms', {
method: 'GET',
headers: {},
});
const data = await response.json();Response
{
"Results": [
{
"Name": "text",
"Created": "2024-07-26T18:23:52.447Z",
"LastModified": "2024-07-26T18:23:52.447Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2024-07-26T18:23:52.447Z"
},
"FormFields": [
{
"AllowOrdering": false,
"RequirednessStatus": "Mandatory",
"AllowedRequirednessStatuses": [
"Mandatory"
],
"CustomField": {
"Text": "text",
"InternalDescription": "text",
"ProviderType": "CandidateOrRecruiter",
"QuestionType": "Text",
"VisibilityType": "Everyone",
"FieldType": "Candidate",
"FieldLocationType": "PersonalData",
"IsConfidential": false,
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Text": "text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": false
}
],
"ElasticMeta": "text",
"IsNeogov": false
},
"ScreeningQuestion": {
"Text": "text",
"QuestionType": "Text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Text": "text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": false
}
]
},
"DefaultField": {
"QuestionType": "text",
"Text": "text",
"ResourceKey": "text",
"DisplayName": "text",
"Options": [
{
"DisplayName": "text",
"Text": "text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": false
}
],
"Fields": [],
"FieldLocation": "PersonalData"
}
}
],
"FormSubmitAction": {
"Type": "Redirect",
"Message": "text",
"Page": {
"Name": "text",
"Title": "text",
"Type": "Page",
"BrandType": "TalentLyft",
"NeoBrandLogo": "TalentLyft",
"MetaTitle": "text",
"MetaDescription": "text",
"MetaUrl": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"Language": "text",
"Status": "Draft",
"IsPrimary": false,
"Created": "2024-07-26T18:23:52.447Z",
"LastModified": "2024-07-26T18:23:52.447Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2024-07-26T18:23:52.447Z"
},
"Website": {
"Name": "text",
"Subdomain": "text",
"CustomDomain": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"FaviconUrl": "text",
"LogoUrl": "text",
"BrandingSettings": {
"FontFamily": "text",
"MainBrandColor": "text",
"TextColor": "text",
"HeaderColor": "text",
"SubHeaderColor": "text",
"CustomCss": "text",
"CustomJs": "text"
},
"SocialSettings": {
"Facebook": "text",
"Twitter": "text",
"Instagram": "text",
"LinkedIn": "text",
"CompanyWebsite": "text"
},
"AdvancedSettings": {
"Language": "text",
"Subdomain": "text",
"CustomDomain": "text",
"AllowIndexing": false,
"CareerSiteAddress": "text"
},
"Created": "2024-07-26T18:23:52.447Z",
"LastModified": "2024-07-26T18:23:52.447Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2024-07-26T18:23:52.447Z"
},
"IsPrimary": false,
"Theme": {
"Name": "text",
"IsPrivate": false,
"Meta": {
"Css": "text",
"CssUrls": [
"text"
],
"HeaderJavascript": "text",
"HeaderJavascriptUrls": [
"text"
],
"BodyJavascript": "text",
"BodyJavascriptUrls": [
"text"
],
"SectionLayouts": [
{
"Type": "Header",
"Layouts": [
{
"Key": "text",
"Html": "text",
"ImageUrl": "text",
"Availability": "All"
}
]
}
]
}
},
"MenuItems": [
{
"Children": [],
"Label": "text",
"IsInternal": false,
"ExternalUrl": "text",
"IsHighlighted": false,
"ResolvedUrl": "text"
}
],
"Compliance": {
"GdprIsEnabled": false,
"EeoIsEnabled": false,
"CompanyLegalName": "text"
},
"Pages": [],
"NotLinkedPages": [],
"SystemPages": []
},
"Analytics": {
"Albacross": {
"ClientId": "text"
},
"FacebookPixel": {
"PixelId": "text",
"MetatagVerification": "text"
},
"GoogleAnalytics": {
"TrackingId": "text"
},
"Hotjar": {},
"GoogleTagManager": {
"TrackingId": "text"
},
"LinkedInInsightTag": {
"PartnerId": "text"
}
},
"Sections": [
{
"Header": "text",
"Subheader": "text",
"Type": "Header",
"Layout": "text",
"MenuTitle": "text",
"MenuShowFlag": false
}
]
},
"EmailSubject": "text",
"EmailBody": "text"
},
"ExternalUrl": "text",
"Status": "Draft",
"SubmissionRate": 0,
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Actions": [
{
"Type": "SendEmail"
}
]
}
],
"Pages": {
"First": "text",
"Prev": "text",
"Next": "text",
"Last": "text"
},
"IdResults": [
{
"Name": "text",
"Created": "2024-07-26T18:23:52.447Z",
"LastModified": "2024-07-26T18:23:52.447Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2024-07-26T18:23:52.447Z"
},
"FormFields": [
{
"AllowOrdering": false,
"RequirednessStatus": "Mandatory",
"AllowedRequirednessStatuses": [
"Mandatory"
],
"CustomField": {
"Text": "text",
"InternalDescription": "text",
"ProviderType": "CandidateOrRecruiter",
"QuestionType": "Text",
"VisibilityType": "Everyone",
"FieldType": "Candidate",
"FieldLocationType": "PersonalData",
"IsConfidential": false,
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Text": "text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": false
}
],
"ElasticMeta": "text",
"IsNeogov": false
},
"ScreeningQuestion": {
"Text": "text",
"QuestionType": "Text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Text": "text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": false
}
]
},
"DefaultField": {
"QuestionType": "text",
"Text": "text",
"ResourceKey": "text",
"DisplayName": "text",
"Options": [
{
"DisplayName": "text",
"Text": "text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": false
}
],
"Fields": [],
"FieldLocation": "PersonalData"
}
}
],
"FormSubmitAction": {
"Type": "Redirect",
"Message": "text",
"Page": {
"Name": "text",
"Title": "text",
"Type": "Page",
"BrandType": "TalentLyft",
"NeoBrandLogo": "TalentLyft",
"MetaTitle": "text",
"MetaDescription": "text",
"MetaUrl": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"Language": "text",
"Status": "Draft",
"IsPrimary": false,
"Created": "2024-07-26T18:23:52.447Z",
"LastModified": "2024-07-26T18:23:52.447Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2024-07-26T18:23:52.447Z"
},
"Website": {
"Name": "text",
"Subdomain": "text",
"CustomDomain": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"FaviconUrl": "text",
"LogoUrl": "text",
"BrandingSettings": {
"FontFamily": "text",
"MainBrandColor": "text",
"TextColor": "text",
"HeaderColor": "text",
"SubHeaderColor": "text",
"CustomCss": "text",
"CustomJs": "text"
},
"SocialSettings": {
"Facebook": "text",
"Twitter": "text",
"Instagram": "text",
"LinkedIn": "text",
"CompanyWebsite": "text"
},
"AdvancedSettings": {
"Language": "text",
"Subdomain": "text",
"CustomDomain": "text",
"AllowIndexing": false,
"CareerSiteAddress": "text"
},
"Created": "2024-07-26T18:23:52.447Z",
"LastModified": "2024-07-26T18:23:52.447Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2024-07-26T18:23:52.447Z"
},
"IsPrimary": false,
"Theme": {
"Name": "text",
"IsPrivate": false,
"Meta": {
"Css": "text",
"CssUrls": [
"text"
],
"HeaderJavascript": "text",
"HeaderJavascriptUrls": [
"text"
],
"BodyJavascript": "text",
"BodyJavascriptUrls": [
"text"
],
"SectionLayouts": [
{
"Type": "Header",
"Layouts": [
{
"Key": "text",
"Html": "text",
"ImageUrl": "text",
"Availability": "All"
}
]
}
]
}
},
"MenuItems": [
{
"Children": [],
"Label": "text",
"IsInternal": false,
"ExternalUrl": "text",
"IsHighlighted": false,
"ResolvedUrl": "text"
}
],
"Compliance": {
"GdprIsEnabled": false,
"EeoIsEnabled": false,
"CompanyLegalName": "text"
},
"Pages": [],
"NotLinkedPages": [],
"SystemPages": []
},
"Analytics": {
"Albacross": {
"ClientId": "text"
},
"FacebookPixel": {
"PixelId": "text",
"MetatagVerification": "text"
},
"GoogleAnalytics": {
"TrackingId": "text"
},
"Hotjar": {},
"GoogleTagManager": {
"TrackingId": "text"
},
"LinkedInInsightTag": {
"PartnerId": "text"
}
},
"Sections": [
{
"Header": "text",
"Subheader": "text",
"Type": "Header",
"Layout": "text",
"MenuTitle": "text",
"MenuShowFlag": false
}
]
},
"EmailSubject": "text",
"EmailBody": "text"
},
"ExternalUrl": "text",
"Status": "Draft",
"SubmissionRate": 0,
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Actions": [
{
"Type": "SendEmail"
}
]
}
]
}Get form deatils
GET/v2/forms/{id}
Path parameters
id*integer (int32)
Header parameters
Response
Success
Body
Idinteger (int32)
Name*string
Creatednullable string (date-time)
LastModifiednullable string (date-time)
ModifiedByAdopto.Common.Dto.Common.MemberDto (object)
FormFieldsnullable array of Adopto.Common.Api.Dto.Forms.FormField (object)
FormSubmitAction*Adopto.Common.Api.Dto.Convert.ConvertFormSubmitAction (object)
ExternalUrlnullable string
StatusTalentLyft.Data.Enumerators.ConvertStatusTypes (enum)
DraftPublishedArchived
Viewsinteger (int32)
Submissionsinteger (int32)
SubmissionRatenumber (double)
AppearsOninteger (int32)
IsTranslatedboolean
TranslationAdopto.Common.Api.Dto.Translation (object)
Actionsnullable array of Adopto.Common.Api.Dto.AutomatedAction (object)
Request
const response = await fetch('/v2/forms/{id}', {
method: 'GET',
headers: {},
});
const data = await response.json();Response
{
"Name": "text",
"Created": "2024-07-26T18:23:52.447Z",
"LastModified": "2024-07-26T18:23:52.447Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2024-07-26T18:23:52.447Z"
},
"FormFields": [
{
"AllowOrdering": false,
"RequirednessStatus": "Mandatory",
"AllowedRequirednessStatuses": [
"Mandatory"
],
"CustomField": {
"Text": "text",
"InternalDescription": "text",
"ProviderType": "CandidateOrRecruiter",
"QuestionType": "Text",
"VisibilityType": "Everyone",
"FieldType": "Candidate",
"FieldLocationType": "PersonalData",
"IsConfidential": false,
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Text": "text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": false
}
],
"ElasticMeta": "text",
"IsNeogov": false
},
"ScreeningQuestion": {
"Text": "text",
"QuestionType": "Text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Text": "text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": false
}
]
},
"DefaultField": {
"QuestionType": "text",
"Text": "text",
"ResourceKey": "text",
"DisplayName": "text",
"Options": [
{
"DisplayName": "text",
"Text": "text",
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": false
}
],
"Fields": [],
"FieldLocation": "PersonalData"
}
}
],
"FormSubmitAction": {
"Type": "Redirect",
"Message": "text",
"Page": {
"Name": "text",
"Title": "text",
"Type": "Page",
"BrandType": "TalentLyft",
"NeoBrandLogo": "TalentLyft",
"MetaTitle": "text",
"MetaDescription": "text",
"MetaUrl": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"Language": "text",
"Status": "Draft",
"IsPrimary": false,
"Created": "2024-07-26T18:23:52.447Z",
"LastModified": "2024-07-26T18:23:52.447Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2024-07-26T18:23:52.447Z"
},
"Website": {
"Name": "text",
"Subdomain": "text",
"CustomDomain": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"FaviconUrl": "text",
"LogoUrl": "text",
"BrandingSettings": {
"FontFamily": "text",
"MainBrandColor": "text",
"TextColor": "text",
"HeaderColor": "text",
"SubHeaderColor": "text",
"CustomCss": "text",
"CustomJs": "text"
},
"SocialSettings": {
"Facebook": "text",
"Twitter": "text",
"Instagram": "text",
"LinkedIn": "text",
"CompanyWebsite": "text"
},
"AdvancedSettings": {
"Language": "text",
"Subdomain": "text",
"CustomDomain": "text",
"AllowIndexing": false,
"CareerSiteAddress": "text"
},
"Created": "2024-07-26T18:23:52.447Z",
"LastModified": "2024-07-26T18:23:52.447Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2024-07-26T18:23:52.447Z"
},
"IsPrimary": false,
"Theme": {
"Name": "text",
"IsPrivate": false,
"Meta": {
"Css": "text",
"CssUrls": [
"text"
],
"HeaderJavascript": "text",
"HeaderJavascriptUrls": [
"text"
],
"BodyJavascript": "text",
"BodyJavascriptUrls": [
"text"
],
"SectionLayouts": [
{
"Type": "Header",
"Layouts": [
{
"Key": "text",
"Html": "text",
"ImageUrl": "text",
"Availability": "All"
}
]
}
]
}
},
"MenuItems": [
{
"Children": [],
"Label": "text",
"IsInternal": false,
"ExternalUrl": "text",
"IsHighlighted": false,
"ResolvedUrl": "text"
}
],
"Compliance": {
"GdprIsEnabled": false,
"EeoIsEnabled": false,
"CompanyLegalName": "text"
},
"Pages": [],
"NotLinkedPages": [],
"SystemPages": []
},
"Analytics": {
"Albacross": {
"ClientId": "text"
},
"FacebookPixel": {
"PixelId": "text",
"MetatagVerification": "text"
},
"GoogleAnalytics": {
"TrackingId": "text"
},
"Hotjar": {},
"GoogleTagManager": {
"TrackingId": "text"
},
"LinkedInInsightTag": {
"PartnerId": "text"
}
},
"Sections": [
{
"Header": "text",
"Subheader": "text",
"Type": "Header",
"Layout": "text",
"MenuTitle": "text",
"MenuShowFlag": false
}
]
},
"EmailSubject": "text",
"EmailBody": "text"
},
"ExternalUrl": "text",
"Status": "Draft",
"SubmissionRate": 0,
"IsTranslated": false,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Actions": [
{
"Type": "SendEmail"
}
]
}Submit candidate
POST/v2/forms/{id}/candidate
Path parameters
id*integer (int32)
Header parameters
Body
FirstName*string
LastNamenullable string
Titlenullable string
Companynullable string
LocationAdopto.Common.Api.Dto.LocationWriteRead (object)
AvatarAdopto.Common.Api.Dto.Admin.FileDto (object)
Emailsnullable array of Adopto.Common.Api.Dto.ContactWrite (object)
PhoneNumbersnullable array of Adopto.Common.Api.Dto.ContactWrite (object)
SocialNetworksnullable array of Adopto.Common.Api.Dto.ContactWrite (object)
CustomFieldAnswersnullable array of Adopto.Common.Api.Dto.App.AnswerWrite (object)
ComplianceAdopto.Common.Api.Dto.ComplianceWrite (object)
SourceAdopto.Common.Api.Dto.SourceWrite (object)
Skillsnullable array of string
Interestsnullable array of string
ExternalIdnullable string
PreferredLanguagenullable string
SalutationTalentLyft.Data.Enumerators.Candidate.SalutationTypes (enum)
OtherMrMrsMiss
ResumeAdopto.Common.Api.Dto.Admin.FileDto (object)
UnstructuredDataAdopto.Common.Api.Dto.App.UnstructuredCandidateData (object)
Response
Success
Body
CandidateIdinteger (int32)
CandidateUidstring (uuid)
FirstNamenullable string
LastNamenullable string
CurrentJobTitlenullable string
CurrentCompanynullable string
Emailnullable string
PreferredLanguagenullable string
ApplicationIdnullable integer (int32)
ExternalIdnullable string
CandidateUrlnullable string
ApplicationUrlnullable string
HasAccessboolean
IsDuplicatenullable boolean
StageIdnullable integer (int32)
JobIdnullable integer (int32)
IsDisqualifiednullable boolean
Request
const response = await fetch('/v2/forms/{id}/candidate', {
method: 'POST',
headers: {
"Content-Type": "application/json-patch+json"
},
body: JSON.stringify({
"FirstName": "text"
}),
});
const data = await response.json();Response
{
"CandidateUid": "123e4567-e89b-12d3-a456-426614174000",
"FirstName": "text",
"LastName": "text",
"CurrentJobTitle": "text",
"CurrentCompany": "text",
"Email": "text",
"PreferredLanguage": "text",
"ExternalId": "text",
"CandidateUrl": "text",
"ApplicationUrl": "text",
"HasAccess": false,
"IsDuplicate": false,
"IsDisqualified": false
}Last updated