Forms

Get forms

get

/v2/forms

Authorizations

Query parameters

pageinteger · int32 · default: 1

perPageinteger · int32 · default: 20

containsstring

Header parameters

X-TL-CompanyIdguid

Company Id

X-TL-Subdomainguid

Account subdomain

X-TL-UserIdguid

Team member id

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/forms' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

500

200

{
  "Results": [
    {
      "Id": 1,
      "Name": "text",
      "Created": "2025-03-15T11:31:40.622Z",
      "LastModified": "2025-03-15T11:31:40.622Z",
      "ModifiedBy": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "text",
        "Email": "text",
        "SenderEmail": "text",
        "Username": "text",
        "Headline": "text",
        "Avatar": "text",
        "Role": "Administrator",
        "InvitationSentTime": "2025-03-15T11:31:40.622Z"
      },
      "FormFields": "[Circular Reference]",
      "FormSubmitAction": "[Circular Reference]",
      "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-03-15T11:31:40.622Z",
      "LastModified": "2025-03-15T11:31:40.622Z",
      "ModifiedBy": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "text",
        "Email": "text",
        "SenderEmail": "text",
        "Username": "text",
        "Headline": "text",
        "Avatar": "text",
        "Role": "Administrator",
        "InvitationSentTime": "2025-03-15T11:31:40.622Z"
      },
      "FormFields": "[Circular Reference]",
      "FormSubmitAction": "[Circular Reference]",
      "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

Get form deatils

get

/v2/forms/{id}

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguid

Company Id

X-TL-Subdomainguid

Account subdomain

X-TL-UserIdguid

Team member id

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/forms/{id}' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

500

200

{
  "Id": 1,
  "Name": "text",
  "Created": "2025-03-15T11:31:40.622Z",
  "LastModified": "2025-03-15T11:31:40.622Z",
  "ModifiedBy": {
    "Id": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "Email": "text",
    "SenderEmail": "text",
    "Username": "text",
    "Headline": "text",
    "Avatar": "text",
    "Role": "Administrator",
    "InvitationSentTime": "2025-03-15T11:31:40.622Z"
  },
  "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": "[Circular Reference]"
    }
  ],
  "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-03-15T11:31:40.622Z",
      "LastModified": "2025-03-15T11:31:40.622Z",
      "ModifiedBy": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "text",
        "Email": "text",
        "SenderEmail": "text",
        "Username": "text",
        "Headline": "text",
        "Avatar": "text",
        "Role": "Administrator",
        "InvitationSentTime": "2025-03-15T11:31:40.622Z"
      },
      "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
        }
      ]
    },
    "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

Submit candidate

post

/v2/forms/{id}/candidate

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguid

Company Id

X-TL-Subdomainguid

Account subdomain

X-TL-UserIdguid

Team member id

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

FirstNamestring · max: 300required

LastNamestring | nullable

Titlestring | nullable

Companystring | nullable

Locationobject

Avatarobject

Emailsobject[] | nullable

PhoneNumbersobject[] | nullable

SocialNetworksobject[] | nullable

CustomFieldAnswersobject[] | nullable

Complianceobject

Sourceobject

Skillsstring[] | nullable

Interestsstring[] | nullable

ExternalIdstring | nullable

PreferredLanguagestring | nullable

Salutationstring · enum

Options: Other, Mr, Mrs, Miss

Resumeobject

UnstructuredDataobject

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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,
      "CityCountry": "text"
    },
    "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-03-15T11:31:40.622Z",
          "To": "2025-03-15T11:31:40.622Z",
          "Current": true
        }
      ],
      "Experiences": [
        {
          "Id": 1,
          "Title": "text",
          "Company": "text",
          "Description": "text",
          "From": "2025-03-15T11:31:40.622Z",
          "To": "2025-03-15T11:31:40.622Z",
          "Current": true
        }
      ],
      "Educations": [
        {
          "Id": 1,
          "Institution": "text",
          "Degree": "text",
          "Description": "text",
          "From": "2025-03-15T11:31:40.622Z",
          "To": "2025-03-15T11:31:40.622Z",
          "Current": true
        }
      ]
    }
  }'

200

401

403

404

500

200

{
  "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