Forms
Last updated
Last updated
Company Id
Account subdomain
Team member id
curl -L \
--url '/v2/forms' \
--header 'Authorization: YOUR_API_KEY'{
"Results": [
{
"Id": 1,
"Name": "text",
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"FormFields": [
{
"Id": 1,
"Position": 1,
"AllowOrdering": true,
"RequirednessStatus": "Mandatory",
"AllowedRequirednessStatuses": [
"Mandatory"
],
"CustomField": {
"Id": 1,
"Text": "text",
"InternalDescription": "text",
"ProviderType": "CandidateOrRecruiter",
"QuestionType": "Text",
"VisibilityType": "Everyone",
"FieldType": "Candidate",
"FieldLocationType": "PersonalData",
"IsConfidential": true,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Id": 1,
"Text": "text",
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": true
}
],
"ElasticMeta": "text",
"OrdinalNumber": 1,
"IsNeogov": true
},
"ScreeningQuestion": {
"Id": 1,
"Text": "text",
"QuestionType": "Text",
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Id": 1,
"Text": "text",
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": true
}
]
},
"DefaultField": {
"Id": 1,
"QuestionType": "text",
"Text": "text",
"ResourceKey": "text",
"DisplayName": "text",
"Options": [
{
"DisplayName": "text",
"Id": 1,
"Text": "text",
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": true
}
],
"Fields": "[Circular Reference]",
"FieldLocation": "PersonalData",
"Position": 1
}
}
],
"FormSubmitAction": {
"Type": "Redirect",
"Message": "text",
"PageId": 1,
"Page": {
"Id": 1,
"Name": "text",
"Title": "text",
"Type": "Page",
"MetaTitle": "text",
"MetaDescription": "text",
"MetaUrl": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"Language": "text",
"Views": 1,
"UniqueViews": 1,
"Status": "Draft",
"IsPrimary": true,
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"Website": {
"Id": 1,
"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": true,
"CareerSiteAddress": "text"
},
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"IsPrimary": true,
"Theme": {
"Id": 1,
"Name": "text",
"IsPrivate": true,
"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": "[Circular Reference]",
"Compliance": {
"GdprIsEnabled": true,
"EeoIsEnabled": true,
"CompanyLegalName": "text"
},
"Pages": "[Circular Reference]",
"NotLinkedPages": "[Circular Reference]",
"SystemPages": "[Circular Reference]"
},
"Analytics": {
"Albacross": {
"ClientId": "text"
},
"FacebookPixel": {
"PixelId": "text",
"MetatagVerification": "text"
},
"GoogleAnalytics": {
"TrackingId": "text"
},
"Hotjar": {
"SiteId": 1
},
"GoogleTagManager": {
"TrackingId": "text"
},
"LinkedInInsightTag": {
"PartnerId": "text"
}
},
"LocalPageMenu": null,
"Sections": [
{
"Id": 1,
"Header": "text",
"Subheader": "text",
"Position": 1,
"Type": "Header",
"Layout": "text",
"Data": null,
"MenuTitle": "text",
"MenuShowFlag": true
}
]
},
"EmailSubject": "text",
"EmailBody": "text"
},
"ExternalUrl": "text",
"Status": "Draft",
"Views": 1,
"Submissions": 1,
"SubmissionRate": 1,
"AppearsOn": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
]
}
],
"Count": 1,
"Page": 1,
"PerPage": 1,
"Pages": {
"First": "text",
"Prev": "text",
"Next": "text",
"Last": "text"
},
"IdResults": [
{
"Id": 1,
"Name": "text",
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"FormFields": [
{
"Id": 1,
"Position": 1,
"AllowOrdering": true,
"RequirednessStatus": "Mandatory",
"AllowedRequirednessStatuses": [
"Mandatory"
],
"CustomField": {
"Id": 1,
"Text": "text",
"InternalDescription": "text",
"ProviderType": "CandidateOrRecruiter",
"QuestionType": "Text",
"VisibilityType": "Everyone",
"FieldType": "Candidate",
"FieldLocationType": "PersonalData",
"IsConfidential": true,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Id": 1,
"Text": "text",
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": true
}
],
"ElasticMeta": "text",
"OrdinalNumber": 1,
"IsNeogov": true
},
"ScreeningQuestion": {
"Id": 1,
"Text": "text",
"QuestionType": "Text",
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Id": 1,
"Text": "text",
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": true
}
]
},
"DefaultField": {
"Id": 1,
"QuestionType": "text",
"Text": "text",
"ResourceKey": "text",
"DisplayName": "text",
"Options": [
{
"DisplayName": "text",
"Id": 1,
"Text": "text",
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": true
}
],
"Fields": "[Circular Reference]",
"FieldLocation": "PersonalData",
"Position": 1
}
}
],
"FormSubmitAction": {
"Type": "Redirect",
"Message": "text",
"PageId": 1,
"Page": {
"Id": 1,
"Name": "text",
"Title": "text",
"Type": "Page",
"MetaTitle": "text",
"MetaDescription": "text",
"MetaUrl": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"Language": "text",
"Views": 1,
"UniqueViews": 1,
"Status": "Draft",
"IsPrimary": true,
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"Website": {
"Id": 1,
"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": true,
"CareerSiteAddress": "text"
},
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"IsPrimary": true,
"Theme": {
"Id": 1,
"Name": "text",
"IsPrivate": true,
"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": "[Circular Reference]",
"Compliance": {
"GdprIsEnabled": true,
"EeoIsEnabled": true,
"CompanyLegalName": "text"
},
"Pages": "[Circular Reference]",
"NotLinkedPages": "[Circular Reference]",
"SystemPages": "[Circular Reference]"
},
"Analytics": {
"Albacross": {
"ClientId": "text"
},
"FacebookPixel": {
"PixelId": "text",
"MetatagVerification": "text"
},
"GoogleAnalytics": {
"TrackingId": "text"
},
"Hotjar": {
"SiteId": 1
},
"GoogleTagManager": {
"TrackingId": "text"
},
"LinkedInInsightTag": {
"PartnerId": "text"
}
},
"LocalPageMenu": null,
"Sections": [
{
"Id": 1,
"Header": "text",
"Subheader": "text",
"Position": 1,
"Type": "Header",
"Layout": "text",
"Data": null,
"MenuTitle": "text",
"MenuShowFlag": true
}
]
},
"EmailSubject": "text",
"EmailBody": "text"
},
"ExternalUrl": "text",
"Status": "Draft",
"Views": 1,
"Submissions": 1,
"SubmissionRate": 1,
"AppearsOn": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
]
}
],
"OriginalCount": 1
}Success
Company Id
Account subdomain
Team member id
curl -L \
--url '/v2/forms/{id}' \
--header 'Authorization: YOUR_API_KEY'{
"Id": 1,
"Name": "text",
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"FormFields": [
{
"Id": 1,
"Position": 1,
"AllowOrdering": true,
"RequirednessStatus": "Mandatory",
"AllowedRequirednessStatuses": [
"Mandatory"
],
"CustomField": {
"Id": 1,
"Text": "text",
"InternalDescription": "text",
"ProviderType": "CandidateOrRecruiter",
"QuestionType": "Text",
"VisibilityType": "Everyone",
"FieldType": "Candidate",
"FieldLocationType": "PersonalData",
"IsConfidential": true,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Id": 1,
"Text": "text",
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": true
}
],
"ElasticMeta": "text",
"OrdinalNumber": 1,
"IsNeogov": true
},
"ScreeningQuestion": {
"Id": 1,
"Text": "text",
"QuestionType": "Text",
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Options": [
{
"Id": 1,
"Text": "text",
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": true
}
]
},
"DefaultField": {
"Id": 1,
"QuestionType": "text",
"Text": "text",
"ResourceKey": "text",
"DisplayName": "text",
"Options": [
{
"DisplayName": "text",
"Id": 1,
"Text": "text",
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": true
}
],
"Fields": [
{
"Id": 1,
"QuestionType": "text",
"Text": "text",
"ResourceKey": "text",
"DisplayName": "text",
"Options": [
{
"DisplayName": "text",
"Id": 1,
"Text": "text",
"Ordinal": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Disqualify": true
}
],
"Fields": "[Circular Reference]",
"FieldLocation": "PersonalData",
"Position": 1
}
],
"FieldLocation": "PersonalData",
"Position": 1
}
}
],
"FormSubmitAction": {
"Type": "Redirect",
"Message": "text",
"PageId": 1,
"Page": {
"Id": 1,
"Name": "text",
"Title": "text",
"Type": "Page",
"MetaTitle": "text",
"MetaDescription": "text",
"MetaUrl": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"Language": "text",
"Views": 1,
"UniqueViews": 1,
"Status": "Draft",
"IsPrimary": true,
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"Website": {
"Id": 1,
"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": true,
"CareerSiteAddress": "text"
},
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"IsPrimary": true,
"Theme": {
"Id": 1,
"Name": "text",
"IsPrivate": true,
"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": [
{
"Id": 1,
"ParentId": 1,
"Children": "[Circular Reference]",
"Label": "text",
"IsInternal": true,
"Page": "[Circular Reference]",
"ExternalUrl": "text",
"IsHighlighted": true,
"Order": 1,
"ResolvedUrl": "text"
}
],
"Compliance": {
"GdprIsEnabled": true,
"EeoIsEnabled": true,
"CompanyLegalName": "text"
},
"Pages": [
{
"Id": 1,
"Name": "text",
"Title": "text",
"Type": "Page",
"MetaTitle": "text",
"MetaDescription": "text",
"MetaUrl": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"Language": "text",
"Views": 1,
"UniqueViews": 1,
"Status": "Draft",
"IsPrimary": true,
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"Website": "[Circular Reference]",
"Analytics": {
"Albacross": {
"ClientId": "text"
},
"FacebookPixel": {
"PixelId": "text",
"MetatagVerification": "text"
},
"GoogleAnalytics": {
"TrackingId": "text"
},
"Hotjar": {
"SiteId": 1
},
"GoogleTagManager": {
"TrackingId": "text"
},
"LinkedInInsightTag": {
"PartnerId": "text"
}
},
"LocalPageMenu": null,
"Sections": [
{
"Id": 1,
"Header": "text",
"Subheader": "text",
"Position": 1,
"Type": "Header",
"Layout": "text",
"Data": null,
"MenuTitle": "text",
"MenuShowFlag": true
}
]
}
],
"NotLinkedPages": [
{
"Id": 1,
"Name": "text",
"Title": "text",
"Type": "Page",
"MetaTitle": "text",
"MetaDescription": "text",
"MetaUrl": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"Language": "text",
"Views": 1,
"UniqueViews": 1,
"Status": "Draft",
"IsPrimary": true,
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"Website": "[Circular Reference]",
"Analytics": {
"Albacross": {
"ClientId": "text"
},
"FacebookPixel": {
"PixelId": "text",
"MetatagVerification": "text"
},
"GoogleAnalytics": {
"TrackingId": "text"
},
"Hotjar": {
"SiteId": 1
},
"GoogleTagManager": {
"TrackingId": "text"
},
"LinkedInInsightTag": {
"PartnerId": "text"
}
},
"LocalPageMenu": null,
"Sections": [
{
"Id": 1,
"Header": "text",
"Subheader": "text",
"Position": 1,
"Type": "Header",
"Layout": "text",
"Data": null,
"MenuTitle": "text",
"MenuShowFlag": true
}
]
}
],
"SystemPages": [
{
"Id": 1,
"Name": "text",
"Title": "text",
"Type": "Page",
"MetaTitle": "text",
"MetaDescription": "text",
"MetaUrl": "text",
"Slug": "text",
"RelativeUrl": "text",
"ResolvedUrl": "text",
"Language": "text",
"Views": 1,
"UniqueViews": 1,
"Status": "Draft",
"IsPrimary": true,
"Created": "2025-04-02T15:40:45.491Z",
"LastModified": "2025-04-02T15:40:45.491Z",
"ModifiedBy": {
"Id": "123e4567-e89b-12d3-a456-426614174000",
"Name": "text",
"Email": "text",
"SenderEmail": "text",
"Username": "text",
"Headline": "text",
"Avatar": "text",
"Role": "Administrator",
"InvitationSentTime": "2025-04-02T15:40:45.491Z"
},
"Website": "[Circular Reference]",
"Analytics": {
"Albacross": {
"ClientId": "text"
},
"FacebookPixel": {
"PixelId": "text",
"MetatagVerification": "text"
},
"GoogleAnalytics": {
"TrackingId": "text"
},
"Hotjar": {
"SiteId": 1
},
"GoogleTagManager": {
"TrackingId": "text"
},
"LinkedInInsightTag": {
"PartnerId": "text"
}
},
"LocalPageMenu": null,
"Sections": [
{
"Id": 1,
"Header": "text",
"Subheader": "text",
"Position": 1,
"Type": "Header",
"Layout": "text",
"Data": null,
"MenuTitle": "text",
"MenuShowFlag": true
}
]
}
]
},
"Analytics": {
"Albacross": {
"ClientId": "text"
},
"FacebookPixel": {
"PixelId": "text",
"MetatagVerification": "text"
},
"GoogleAnalytics": {
"TrackingId": "text"
},
"Hotjar": {
"SiteId": 1
},
"GoogleTagManager": {
"TrackingId": "text"
},
"LinkedInInsightTag": {
"PartnerId": "text"
}
},
"LocalPageMenu": null,
"Sections": [
{
"Id": 1,
"Header": "text",
"Subheader": "text",
"Position": 1,
"Type": "Header",
"Layout": "text",
"Data": null,
"MenuTitle": "text",
"MenuShowFlag": true
}
]
},
"EmailSubject": "text",
"EmailBody": "text"
},
"ExternalUrl": "text",
"Status": "Draft",
"Views": 1,
"Submissions": 1,
"SubmissionRate": 1,
"AppearsOn": 1,
"IsTranslated": true,
"Translation": {
"TranslationProperties": [
"text"
],
"TranslationRequiredProperties": [
"text"
],
"Translations": [
{
"Language": "text",
"Property": "text",
"TranslateValue": "text"
}
]
},
"Actions": [
{
"Id": 1,
"Type": "SendEmail",
"Action": null
}
]
}Success
Company Id
Account subdomain
Team member id
curl -L \
--request POST \
--url '/v2/forms/{id}/candidate' \
--header 'Authorization: YOUR_API_KEY' \
--header 'Content-Type: application/json-patch+json' \
--data '{
"FirstName": "text",
"LastName": "text",
"Title": "text",
"Company": "text",
"Location": {
"Id": 1,
"Country": "text",
"CountryCode": "text",
"Region": "text",
"RegionCode": "text",
"DistrictId": 1,
"City": "text",
"ZipCode": "text",
"Address": "text",
"Latitude": 1,
"Longitude": 1
},
"Avatar": {
"FileName": "text",
"Content": "text",
"Url": "text",
"ConvertedUrl": "text",
"ContentType": "text"
},
"Emails": [
{
"Value": "text",
"Type": "text"
}
],
"PhoneNumbers": [
{
"Value": "text",
"Type": "text"
}
],
"SocialNetworks": [
{
"Value": "text",
"Type": "text"
}
],
"CustomFieldAnswers": [
{
"Id": 1,
"Choices": [
1
],
"Body": "text",
"File": {
"FileName": "text",
"Content": "text",
"Url": "text",
"ConvertedUrl": "text",
"ContentType": "text"
}
}
],
"Compliance": {
"Gdpr": {
"RetentionConsent": true,
"PrivacyPolicyConsent": true,
"ShareConsent": true
},
"Eeoc": {
"Gender": "NotIdentified",
"Disability": "NotIdentified",
"Race": "NotIdentified",
"Veteran": "NotIdentified"
}
},
"Source": {
"SourceType": "JobBoard",
"SourceBy": "123e4567-e89b-12d3-a456-426614174000",
"SourceFrom": "text",
"SourceChanel": "Manual",
"VisitorId": "123e4567-e89b-12d3-a456-426614174000",
"SessionId": "123e4567-e89b-12d3-a456-426614174000"
},
"Skills": [
"text"
],
"Interests": [
"text"
],
"ExternalId": "text",
"PreferredLanguage": "text",
"Salutation": "Other",
"Resume": {
"FileName": "text",
"Content": "text",
"Url": "text",
"ConvertedUrl": "text",
"ContentType": "text"
},
"UnstructuredData": {
"Summary": "text",
"Projects": [
{
"Id": 1,
"ProjectName": "text",
"ProjectUrl": "text",
"Description": "text",
"From": "2025-04-02T15:40:45.491Z",
"To": "2025-04-02T15:40:45.491Z",
"Current": true
}
],
"Experiences": [
{
"Id": 1,
"Title": "text",
"Company": "text",
"Description": "text",
"From": "2025-04-02T15:40:45.491Z",
"To": "2025-04-02T15:40:45.491Z",
"Current": true
}
],
"Educations": [
{
"Id": 1,
"Institution": "text",
"Degree": "text",
"Description": "text",
"From": "2025-04-02T15:40:45.491Z",
"To": "2025-04-02T15:40:45.491Z",
"Current": true
}
]
}
}'{
"CandidateId": 1,
"CandidateUid": "123e4567-e89b-12d3-a456-426614174000",
"FirstName": "text",
"LastName": "text",
"CurrentJobTitle": "text",
"CurrentCompany": "text",
"Email": "text",
"PreferredLanguage": "text",
"ApplicationId": 1,
"ExternalId": "text",
"CandidateUrl": "text",
"ApplicationUrl": "text",
"HasAccess": true,
"IsDuplicate": true,
"StageId": 1,
"JobId": 1,
"IsDisqualified": true,
"IsCandidateDuplicate": true
}Success