Candidates

Get candidates

get

Authorizations

Query parameters

jobsinteger · int32[]optional

pageinteger · int32 · default: 1optional

perPageinteger · int32 · default: 100optional

createAfterDatestring · date-timeoptional

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

401

403

500

200

{
  "Results": [
    {
      "Id": 1,
      "FirstName": "text",
      "LastName": "text",
      "Name": "text",
      "PossibleDuplicates": true,
      "Title": "text",
      "Avatar": "text",
      "Company": "text",
      "Created": "2025-04-02T15:04:57.067Z",
      "LastModified": "2025-04-02T15:04:57.067Z",
      "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"
      },
      "Tags": [
        "text"
      ],
      "Emails": [
        {
          "Id": 1,
          "Value": "text",
          "Type": "text",
          "IsPrimary": true
        }
      ],
      "PhoneNumbers": [
        {
          "Id": 1,
          "Value": "text",
          "Type": "text",
          "IsPrimary": true
        }
      ],
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "SnoozedUntil": "2025-04-02T15:04:57.067Z",
      "Unsubscribed": true,
      "UnsubscribedAt": "2025-04-02T15:04:57.067Z",
      "PreferredLanguage": "text",
      "Salutation": "Other",
      "Applications": [
        {
          "Id": 1,
          "CandidateId": 1,
          "ProfileUrl": "text",
          "Created": "2025-04-02T15:04:57.067Z",
          "Disqualified": true,
          "DisqualifiedAt": "2025-04-02T15:04:57.067Z",
          "DisqualificationReason": "text",
          "Stage": {
            "Id": 1,
            "Name": "text",
            "Type": "text",
            "Position": 1
          },
          "Job": {
            "Id": 1,
            "Title": "text",
            "FriendlyUrl": "text",
            "Department": "text",
            "RequisitionCode": "text",
            "DepartmentId": 1,
            "Location": "text",
            "Status": "Draft",
            "PipelineId": 1,
            "JobNumber": "text",
            "SecondaryText": "text"
          },
          "ExternalId": "text",
          "Source": {
            "SourceType": "JobBoard",
            "SourceBy": "123e4567-e89b-12d3-a456-426614174000",
            "SourceFrom": "text",
            "SourceChanel": "Manual",
            "SourceFormatted": "text"
          },
          "Evaluation": {
            "DefinitelyNo": 1,
            "No": 1,
            "Yes": 1,
            "DefinitelyYes": 1
          },
          "PreviousEvaluation": {
            "DefinitelyNo": 1,
            "No": 1,
            "Yes": 1,
            "DefinitelyYes": 1
          },
          "DisqualificationType": "NoneSpecified"
        }
      ]
    }
  ],
  "Count": 1,
  "Page": 1,
  "PerPage": 1,
  "Pages": {
    "First": "text",
    "Prev": "text",
    "Next": "text",
    "Last": "text"
  },
  "IdResults": [
    {
      "Id": 1,
      "FirstName": "text",
      "LastName": "text",
      "Name": "text",
      "PossibleDuplicates": true,
      "Title": "text",
      "Avatar": "text",
      "Company": "text",
      "Created": "2025-04-02T15:04:57.067Z",
      "LastModified": "2025-04-02T15:04:57.067Z",
      "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"
      },
      "Tags": [
        "text"
      ],
      "Emails": [
        {
          "Id": 1,
          "Value": "text",
          "Type": "text",
          "IsPrimary": true
        }
      ],
      "PhoneNumbers": [
        {
          "Id": 1,
          "Value": "text",
          "Type": "text",
          "IsPrimary": true
        }
      ],
      "Uid": "123e4567-e89b-12d3-a456-426614174000",
      "SnoozedUntil": "2025-04-02T15:04:57.067Z",
      "Unsubscribed": true,
      "UnsubscribedAt": "2025-04-02T15:04:57.067Z",
      "PreferredLanguage": "text",
      "Salutation": "Other",
      "Applications": [
        {
          "Id": 1,
          "CandidateId": 1,
          "ProfileUrl": "text",
          "Created": "2025-04-02T15:04:57.067Z",
          "Disqualified": true,
          "DisqualifiedAt": "2025-04-02T15:04:57.067Z",
          "DisqualificationReason": "text",
          "Stage": {
            "Id": 1,
            "Name": "text",
            "Type": "text",
            "Position": 1
          },
          "Job": {
            "Id": 1,
            "Title": "text",
            "FriendlyUrl": "text",
            "Department": "text",
            "RequisitionCode": "text",
            "DepartmentId": 1,
            "Location": "text",
            "Status": "Draft",
            "PipelineId": 1,
            "JobNumber": "text",
            "SecondaryText": "text"
          },
          "ExternalId": "text",
          "Source": {
            "SourceType": "JobBoard",
            "SourceBy": "123e4567-e89b-12d3-a456-426614174000",
            "SourceFrom": "text",
            "SourceChanel": "Manual",
            "SourceFormatted": "text"
          },
          "Evaluation": {
            "DefinitelyNo": 1,
            "No": 1,
            "Yes": 1,
            "DefinitelyYes": 1
          },
          "PreviousEvaluation": {
            "DefinitelyNo": 1,
            "No": 1,
            "Yes": 1,
            "DefinitelyYes": 1
          },
          "DisqualificationType": "NoneSpecified"
        }
      ]
    }
  ],
  "OriginalCount": 1
}

Success

Create Candidate

post

Authorizations

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

FirstNamestring · max: 300required

LastNamestring | nullableoptional

CoverLetterstring | nullableoptional

Summarystring | nullableoptional

Titlestring | nullableoptional

Companystring | nullableoptional

ExternalIdstring | nullableoptional

StageIdinteger · int32 | nullableoptional

JobIdinteger · int32 | nullableoptional

PoolIdinteger · int32 | nullableoptional

Appliedbooleanoptional

IsProspectbooleanoptional

Disqualifiedbooleanoptional

DisqualifiedAtstring · date-time | nullableoptional

DisqualificationReasoninteger · int32 | nullableoptional

Createdstring · date-timeoptional

Locationobjectoptional

JobApplicationLocationIdinteger · int32 | nullableoptional

Avatarobjectoptional

Tagsstring[] | nullableoptional

Skillsstring[] | nullableoptional

Resumeobjectoptional

UnstructuredDataobjectoptional

Attachmentsobject[] | nullableoptional

Notesstring | nullableoptional

Emailsobject[] | nullableoptional

PhoneNumbersobject[] | nullableoptional

SocialNetworksobject[] | nullableoptional

Emailstring | nullableoptional

Phonestring | nullableoptional

Answersobject[] | nullableoptional

CustomFieldAnswersobject[] | nullableoptional

Projectsobject[] | nullableoptional

Experiencesobject[] | nullableoptional

Educationsobject[] | nullableoptional

Languagesobject[] | nullableoptional

Sourceobjectoptional

Complianceobjectoptional

PreferredLanguagestring | nullableoptional

Salutationstring · enumoptional

Available options:

GJobsCandidateIdinteger · int32 | nullableoptional

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/candidates' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "FirstName": "text",
    "LastName": "text",
    "CoverLetter": "text",
    "Summary": "text",
    "Title": "text",
    "Company": "text",
    "ExternalId": "text",
    "StageId": 1,
    "JobId": 1,
    "PoolId": 1,
    "Applied": true,
    "IsProspect": true,
    "Disqualified": true,
    "DisqualifiedAt": "2025-04-02T15:04:57.067Z",
    "DisqualificationReason": 1,
    "Created": "2025-04-02T15:04:57.067Z",
    "Location": {
      "Id": 1,
      "Country": "text",
      "CountryCode": "text",
      "Region": "text",
      "RegionCode": "text",
      "DistrictId": 1,
      "City": "text",
      "ZipCode": "text",
      "Address": "text",
      "Latitude": 1,
      "Longitude": 1
    },
    "JobApplicationLocationId": 1,
    "Avatar": {
      "FileName": "text",
      "Content": "text",
      "Url": "text",
      "ConvertedUrl": "text",
      "ContentType": "text"
    },
    "Tags": [
      "text"
    ],
    "Skills": [
      "text"
    ],
    "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:04:57.067Z",
          "To": "2025-04-02T15:04:57.067Z",
          "Current": true
        }
      ],
      "Experiences": [
        {
          "Id": 1,
          "Title": "text",
          "Company": "text",
          "Description": "text",
          "From": "2025-04-02T15:04:57.067Z",
          "To": "2025-04-02T15:04:57.067Z",
          "Current": true
        }
      ],
      "Educations": [
        {
          "Id": 1,
          "Institution": "text",
          "Degree": "text",
          "Description": "text",
          "From": "2025-04-02T15:04:57.067Z",
          "To": "2025-04-02T15:04:57.067Z",
          "Current": true
        }
      ]
    },
    "Attachments": [
      {
        "FileName": "text",
        "Content": "text",
        "Url": "text",
        "ConvertedUrl": "text",
        "ContentType": "text"
      }
    ],
    "Notes": "text",
    "Emails": [
      {
        "Value": "text",
        "Type": "text"
      }
    ],
    "PhoneNumbers": [
      {
        "Value": "text",
        "Type": "text"
      }
    ],
    "SocialNetworks": [
      {
        "Value": "text",
        "Type": "text"
      }
    ],
    "Email": "text",
    "Phone": "text",
    "Answers": [
      {
        "Id": 1,
        "Choices": [
          1
        ],
        "Body": "text",
        "File": {
          "FileName": "text",
          "Content": "text",
          "Url": "text",
          "ConvertedUrl": "text",
          "ContentType": "text"
        }
      }
    ],
    "CustomFieldAnswers": [
      {
        "Id": 1,
        "Choices": [
          1
        ],
        "Body": "text",
        "File": {
          "FileName": "text",
          "Content": "text",
          "Url": "text",
          "ConvertedUrl": "text",
          "ContentType": "text"
        }
      }
    ],
    "Projects": [
      {
        "Id": 1,
        "ProjectName": "text",
        "ProjectUrl": "text",
        "Description": "text",
        "From": "2025-04-02T15:04:57.067Z",
        "To": "2025-04-02T15:04:57.067Z",
        "Current": true
      }
    ],
    "Experiences": [
      {
        "Id": 1,
        "Title": "text",
        "Company": "text",
        "Description": "text",
        "From": "2025-04-02T15:04:57.067Z",
        "To": "2025-04-02T15:04:57.067Z",
        "Current": true
      }
    ],
    "Educations": [
      {
        "Id": 1,
        "Institution": "text",
        "Degree": "text",
        "Description": "text",
        "From": "2025-04-02T15:04:57.067Z",
        "To": "2025-04-02T15:04:57.067Z",
        "Current": true
      }
    ],
    "Languages": [
      {
        "LanguageIso": "text",
        "LanguageProficiency": "text"
      }
    ],
    "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"
    },
    "Compliance": {
      "Gdpr": {
        "RetentionConsent": true,
        "PrivacyPolicyConsent": true,
        "ShareConsent": true
      },
      "Eeoc": {
        "Gender": "NotIdentified",
        "Disability": "NotIdentified",
        "Race": "NotIdentified",
        "Veteran": "NotIdentified"
      }
    },
    "PreferredLanguage": "text",
    "Salutation": "Other",
    "GJobsCandidateId": 1
  }'

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

201

401

403

422

500

201

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

Created

This endpoint allows for the creation of candidate profiles directly within TalentLyft, either associated with a specific job or without being linked to any job. This functionality can be particularly useful in several scenarios:

Using Your Custom Application Form: If your website hosts a custom job application form that you prefer to continue using, you can enable candidates to apply through your form. Subsequently, you can utilize this API to seamlessly import the candidate details into your TalentLyft account.

Migrating Existing Candidates: For those who already have a candidate database, whether in a spreadsheet or another system, this API provides an efficient method to transfer all those candidate profiles into TalentLyft.

Integrating with Other Systems: This API facilitates the integration of TalentLyft with any other system that maintains people profiles, allowing for a smooth transfer of these profiles into TalentLyft.

By leveraging this API, you can ensure a streamlined process of managing and creating candidate profiles, enhancing your recruitment workflow.

Request Body

Name	Type	Description
FirstName	string	The candidate’s first name
LastName	string	The candidate’s last name
JobId	integer	Job id
StageId	integer	Stage id, if not provided applied
Applied	boolean	Candidates are considered as applied and receiving the "thank you for applying" email.
IsProspect	boolean	Candidates are considered as sourced and not receiving the "thank you for applying" email.
Disqualified	boolean	If true, it will mark the candidate as diqualified
DisqualifiedAt	string	If you leave this field empty, we will use the current timestamp
DisqualificationReason	integer	The candidate’s disqualification reason id
Created	string	ISO 8601
CoverLetter	string	The candidate’s cover letter
Summary	string	The candidate’s summary
Title	string	The candidate’s job title
Company	string	The candidate’s company
Location	object	Explained below
Avatar	object	Explained below
Tags	array	Array of tags as strings
Skills	array	Array of skills as strings
Resume	object	Candidate’s resume. Explained below.
Attachments	array	Explained below
Emails	array	Array of emails. Explained below
PhoneNumbers	array	Array of phone numbers. Explained below
SocialNetworks	array	Array of website/social network addresses. Explained below
Answers	array	Explained below
Projects	array	Explained below
Experiences	array	Explained below
Educations	array	Explained below
Languages	array	Explained below
Source	object	Explained below
Compliance	object	Explained below

Candidate's avatar

Candidate’s avatar is a object.

Parameter	Required	Type	Description
FileName	no	string	Name of the image file with extension (resume.pdf, cv.docx)
Content	yes*	string	Base64 encoded content of the attachment (if you are providing content, you do not need to provide url). String must be UTF-8 encoded.
Url	yes*	string	Url of the image (if you are providing the url, you do not need to provide the content).
ContentType	no	string	MIME type, one of the following types: image/jpeg, image/png

Candidate's resume

Candidate’s resume is a object.

Parameter	Required	Type	Description
FileName	yes	string	Name of the file with extension (resume.pdf, cv.docx)
Content	yes*	string	Base64 encoded content of the attachment (if you are providing content, you do not need to provide url). String must be UTF-8 encoded.
Url	yes*	string	Url of the resume (if you are providing the url, you do not need to provide the content).
ContentType	no	string	MIME type, one of the following types: text/html, text/plain, application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document

Candidate's attachments

Candidate’s attachment is a list of entries. Each entry containing the following fields:

Parameter	Required	Type	Description
FileName	yes	string	Name of the file with extension (resume.pdf, cv.docx)
Content	yes*	string	Base64 encoded content of the attachment (if you are providing content, you do not need to provide url). String must be UTF-8 encoded.
Url	yes*	string	Url of the attachment (if you are providing the url, you do not need to provide the content).
ContentType	no	string	MIME type, one of the following types: text/html, text/plain, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, application/zip, application/x-7z-compressed

Candidate's location

Candidate’s location is a object.

Parameter	Required	Type	Description
CountryCode	yes	string	ISO 3166-1
City	yes*	string	City
ZipCode	yes*	string	Zip code
Address	no	string	Full address

Candidate's emails

Candidate’s email is a list of entries. Each entry containing the following fields:

Parameter	Required	Type	Description
Value	yes	string	The candidate's email
Type	no	string	One of the following types: email, email_personal or email_work.

Candidate's phones

Candidate’s phone is a list of entries. Each entry containing the following fields:

Parameter	Required	Type	Description
Value	yes	string	Name of the file with extension (resume.pdf, cv.docx)
Type	no	string	One of the following types: phone, phone_mobile, phone_home and phone_work

Candidate's social networks

Candidate’s social networks is a list of entries. Each entry containing the following fields:

Parameter	Required	Type	Description
Value	yes	string	The candidate's URL
Type	yes*	string	One of the following types: angellist, aboutme, crunchbase, behance, bitbucket, dribble, facebook, github, googleplus, linkedin, meetup, mixcloud, pinterest, quora, reddit, slideshare, soundcloud, stackexchange, stackoverflow, stumbleupon, tumblr, twitter, vimeo, vk, xing, youtube, instagram, klout, codeproject, other

Candidate's answers

Each talentlyft job can have a list of associated questions that can be retrieved from the /jobs/:id/form endpoint. For each question, an answer can be provided by adding the answers list in the posted data. For each question, add to the answers list the following attributes based on question’s type.

Questions types: text, textarea, address, date, url

Parameter	Required	Type	Description
Id	yes	int	The question key
Body	yes	string	One of the following types

Questions types: checkbox, radio, select, yesNo

Parameter	Required	Type	Description
Id	yes	int	The question key
Choices	yes	array	Choices ids, for single answer questions (radio, select, yesNo) provide only one selected choice

Questions types: file

Required	Type	Description
Id	yes	string	The question key
File.FileName	yes	string	Name of the file with extension (resume.pdf, cv.docx)
File.Content	yes*	string	Base64 encoded content of the attachment (if you are providing content, you do not need to provide url). String must be UTF-8 encoded.
File.Url	yes*	string	Url of the answer (if you are providing the url, you do not need to provide the content).
File.ContentType	no	string	MIME type, one of the following types: text/html, text/plain, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, application/zip, application/x-7z-compressed

Candidate's projects

Candidate’s project is a list of entries. Each entry containing the following fields:

Parameter	Required	Type	Description
ProjectName	yes	string
ProjectUrl	no	string
Description	no	string
From	no	date	ISO 8601
To	no	date	ISO 8601

Candidate's experiences

Candidate’s experience is a list of entries. Each entry containing the following fields:

Parameter	Required	Type	Description
Title	yes	string
Company	yes	string
Description	no	string
From	no	date	ISO 8601
To	no	date	ISO 8601

Candidate's education

Candidate’s education is a list of entries. Each entry containing the following fields:

Parameter	Required	Type	Description
Institution	yes	string
Degree	yes	string
Description	no	string
From	no	date	ISO 8601
To	no	date	ISO 8601

Candidate's languages

Candidate’s language is a list of entries. Each entry containing the following fields:

Parameter	Required	Type	Description
LanguageIso	yes	string	ISO 3166-1 alpha-2 code
LanguageProficiency	yes	string	One of the following types: elementary, limited_working, professional_working, full_professional and native

Candidate's source

Parameter	Required	Type	Description
SourceType	no	string	One of the following types: JobBoard - job board Recruiter - external recruiter Referral - employee referral CareersPage - organic, direct traffic, referral url, JsWidget and other Sourced - sourced or manually uploaded Social - social network shares or FacebookTab App Campaigns - email or sms campaigns Paid - paid search, paid social... CandidateRediscovery - TalentLyft smart assistant
SourceBy	no	string	If SourceType is one of the following types: Recruiter orSourcedSourcBy must be Id of the team members. If SourceTypeis Referral SourceBy must be Employee uid
SourceFrom	no	string	Job board name: Indeed, ZipRecruiter or social media: facebook, twitter.

Compliance

Parameter	Required	Type	Description
Gdpr.RetentionConsent	no	boolean
Gdpr.PrivacyPolicyConsent	no	boolean
Gdpr.ShareConsent	no	boolean

Get candidate

get

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

401

403

404

500

200

[
  {
    "Id": 1,
    "FirstName": "text",
    "LastName": "text",
    "Name": "text",
    "PossibleDuplicates": true,
    "Title": "text",
    "Avatar": "text",
    "Company": "text",
    "Created": "2025-04-02T15:04:57.067Z",
    "LastModified": "2025-04-02T15:04:57.067Z",
    "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"
    },
    "Tags": [
      "text"
    ],
    "Emails": [
      {
        "Id": 1,
        "Value": "text",
        "Type": "text",
        "IsPrimary": true
      }
    ],
    "PhoneNumbers": [
      {
        "Id": 1,
        "Value": "text",
        "Type": "text",
        "IsPrimary": true
      }
    ],
    "Uid": "123e4567-e89b-12d3-a456-426614174000",
    "SnoozedUntil": "2025-04-02T15:04:57.067Z",
    "Unsubscribed": true,
    "UnsubscribedAt": "2025-04-02T15:04:57.067Z",
    "PreferredLanguage": "text",
    "Salutation": "Other",
    "Skills": [
      "text"
    ],
    "SocialNetworks": [
      {
        "Id": 1,
        "Value": "text",
        "Type": "text",
        "IsPrimary": true
      }
    ],
    "Pools": [
      {
        "Id": 1,
        "Name": "text",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "LastSize": 1,
        "Pipeline": {
          "Id": 1,
          "Name": "text",
          "Type": "HiringPipeline",
          "Stages": [
            {
              "Id": 1,
              "Name": "text",
              "Type": "Sourced",
              "Ordinal": 1,
              "ActiveCandidates": 1,
              "DisqualifiedCandidates": 1,
              "Candidates": 1,
              "Actions": [
                {
                  "Id": 1,
                  "Type": "SendEmail",
                  "Action": null
                }
              ],
              "Evaluations": [
                {
                  "Id": 1,
                  "Type": "Scorecard",
                  "Evaluation": null
                }
              ],
              "Integrations": [
                {
                  "Type": "JobBoards",
                  "App": null
                }
              ],
              "HasESignatureDocuments": true,
              "HasJobOfferDocuments": true
            }
          ],
          "IsActive": true
        },
        "CurrentStage": {
          "Id": 1,
          "Name": "text",
          "Type": "Sourced",
          "Ordinal": 1,
          "ActiveCandidates": 1,
          "DisqualifiedCandidates": 1,
          "Candidates": 1,
          "Actions": [
            {
              "Id": 1,
              "Type": "SendEmail",
              "Action": null
            }
          ],
          "Evaluations": [
            {
              "Id": 1,
              "Type": "Scorecard",
              "Evaluation": null
            }
          ],
          "Integrations": [
            {
              "Type": "JobBoards",
              "App": null
            }
          ],
          "HasESignatureDocuments": true,
          "HasJobOfferDocuments": true
        }
      }
    ],
    "Analytics": {
      "NumberOfPageViews": 1,
      "NumberOfSessions": 1,
      "TimeFirstSeen": "2025-04-02T15:04:57.067Z",
      "TimeLastSeen": "2025-04-02T15:04:57.067Z"
    },
    "Interaction": {
      "LastActivity": "2025-04-02T15:04:57.067Z",
      "LastContacted": "2025-04-02T15:04:57.067Z",
      "LastMeeting": "2025-04-02T15:04:57.067Z",
      "LastCall": "2025-04-02T15:04:57.067Z",
      "LastEmail": "2025-04-02T15:04:57.067Z",
      "LastHeardFrom": "2025-04-02T15:04:57.067Z",
      "PageViews": 1,
      "MessagesSent": 1,
      "MessagesReceived": 1
    },
    "Source": {
      "SourceType": "JobBoard",
      "SourceBy": "123e4567-e89b-12d3-a456-426614174000",
      "SourceFrom": "text",
      "SourceChanel": "Manual",
      "SourceFormatted": "text"
    },
    "CustomFields": [
      {
        "Field": {
          "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
        },
        "Answer": {
          "Choices": [
            1
          ],
          "File": {
            "Id": 1,
            "FileName": "text",
            "Url": "text",
            "ContentType": "text",
            "ConvertedUrl": "text",
            "DocumentType": 1,
            "Created": "2025-04-02T15:04:57.067Z",
            "CreatedBy": "text",
            "MalwareScanStatus": "InProgress",
            "MalwareScanResult": "Safe"
          },
          "Value": "text"
        }
      }
    ],
    "CandidateCompliance": {
      "Gdpr": {
        "Created": "2025-04-02T15:04:57.067Z",
        "RetentionPeriodConsent": true,
        "RetentionPeriod": "2025-04-02T15:04:57.067Z",
        "ShareConsent": true,
        "ShareComplianceText": "text",
        "PrivacyPolicy": "text"
      }
    },
    "UnstructuredData": {
      "Summary": "text",
      "Projects": [
        {
          "Id": 1,
          "ProjectName": "text",
          "ProjectUrl": "text",
          "Description": "text",
          "From": "2025-04-02T15:04:57.067Z",
          "To": "2025-04-02T15:04:57.067Z",
          "Current": true
        }
      ],
      "Experiences": [
        {
          "Id": 1,
          "Title": "text",
          "Company": "text",
          "Description": "text",
          "From": "2025-04-02T15:04:57.067Z",
          "To": "2025-04-02T15:04:57.067Z",
          "Current": true
        }
      ],
      "Educations": [
        {
          "Id": 1,
          "Institution": "text",
          "Degree": "text",
          "Description": "text",
          "From": "2025-04-02T15:04:57.067Z",
          "To": "2025-04-02T15:04:57.067Z",
          "Current": true
        }
      ]
    },
    "Resume": {
      "Id": 1,
      "FileName": "text",
      "Url": "text",
      "ContentType": "text",
      "ConvertedUrl": "text",
      "DocumentType": 1,
      "Created": "2025-04-02T15:04:57.067Z",
      "CreatedBy": "text",
      "MalwareScanStatus": "InProgress",
      "MalwareScanResult": "Safe"
    },
    "Applications": [
      {
        "Id": 1,
        "CandidateId": 1,
        "ProfileUrl": "text",
        "Created": "2025-04-02T15:04:57.067Z",
        "Disqualified": true,
        "DisqualifiedAt": "2025-04-02T15:04:57.067Z",
        "DisqualificationReason": "text",
        "Stage": {
          "Id": 1,
          "Name": "text",
          "Type": "text",
          "Position": 1
        },
        "Job": {
          "Id": 1,
          "Title": "text",
          "FriendlyUrl": "text",
          "Department": "text",
          "RequisitionCode": "text",
          "DepartmentId": 1,
          "Location": "text",
          "Status": "Draft",
          "PipelineId": 1,
          "JobNumber": "text",
          "SecondaryText": "text"
        },
        "ExternalId": "text",
        "Source": {
          "SourceType": "JobBoard",
          "SourceBy": "123e4567-e89b-12d3-a456-426614174000",
          "SourceFrom": "text",
          "SourceChanel": "Manual",
          "SourceFormatted": "text"
        },
        "Evaluation": {
          "DefinitelyNo": 1,
          "No": 1,
          "Yes": 1,
          "DefinitelyYes": 1
        },
        "PreviousEvaluation": {
          "DefinitelyNo": 1,
          "No": 1,
          "Yes": 1,
          "DefinitelyYes": 1
        },
        "DisqualificationType": "NoneSpecified"
      }
    ]
  }
]

Success

Edit candidate

put

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Idinteger · int32optional

FirstNamestring · max: 300required

LastNamestring | nullableoptional

Titlestring | nullableoptional

Companystring | nullableoptional

Avatarstring | nullableoptional

PreferredLanguagestring | nullableoptional

Salutationstring · enumoptional

Available options:

Locationobjectoptional

Sourceobjectoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v2/candidates/{id}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "FirstName": "text",
    "LastName": "text",
    "Title": "text",
    "Company": "text",
    "Avatar": "text",
    "PreferredLanguage": "text",
    "Salutation": "Other",
    "Location": {
      "Id": 1,
      "Country": "text",
      "CountryCode": "text",
      "Region": "text",
      "RegionCode": "text",
      "DistrictId": 1,
      "City": "text",
      "ZipCode": "text",
      "Address": "text",
      "Latitude": 1,
      "Longitude": 1
    },
    "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"
    }
  }'

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

204

401

403

404

500

204

No body

No Content

Updates candidate's tags

put

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Tagsstring[] | nullableoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v2/candidates/{id}/tags' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Tags": [
      "text"
    ]
  }'

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

204

401

403

500

204

[
  "text"
]

No Content

Updates candidate's skills

put

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Skillsstring[] | nullableoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v2/candidates/{id}/skills' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Skills": [
      "text"
    ]
  }'

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

204

401

403

500

204

[
  "text"
]

No Content

Creates a note on the candidate's timeline

post

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

MemberIdstring · uuid | nullableoptional

Noteobjectoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/candidates/{id}/note' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "MemberId": "123e4567-e89b-12d3-a456-426614174000",
    "Note": {
      "Id": 1,
      "Message": "text",
      "Attachments": [
        1
      ],
      "Mentions": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "Tags": [
        "text"
      ],
      "ApplicationId": 1,
      "CandidateId": 1,
      "Files": [
        {
          "FileName": "text",
          "Content": "text",
          "Url": "text",
          "ConvertedUrl": "text",
          "ContentType": "text"
        }
      ],
      "Visibility": "Everyone"
    }
  }'

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

401

403

404

500

401

{
  "Message": "text",
  "Errors": [
    {
      "Field": "text",
      "Message": "text"
    }
  ],
  "ErrorCode": 1
}

Unauthorized

Log activity on the candidate's timeline

post

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Idinteger · int32optional

Typestring · enumoptional

Available options:

Bodystring | nullableoptional

Createdstring · date-timeoptional

CallOutcomestring · enumoptional

Available options:

Directionstring · enumoptional

Available options:

ApplicationIdinteger · int32 | nullableoptional

CandidateIdinteger · int32optional

PartnerIdstring | nullableoptional

Visibilitystring · enumoptional

Available options:

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/candidates/{id}/log_activity' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Type": "Call",
    "Body": "text",
    "Created": "2025-04-02T15:04:57.067Z",
    "CallOutcome": "NoAnswer",
    "Direction": "Sent",
    "ApplicationId": 1,
    "CandidateId": 1,
    "PartnerId": "text",
    "Visibility": "Everyone"
  }'

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

204

401

403

422

500

204

{
  "Id": 1,
  "Type": "Call",
  "Body": "text",
  "Created": "2025-04-02T15:04:57.067Z",
  "CallOutcome": "NoAnswer",
  "Direction": "Sent",
  "ApplicationId": 1,
  "CandidateId": 1,
  "PartnerId": "text",
  "Visibility": "Everyone"
}

No Content

Log evaluation

post

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Rateinteger · int32optional

Notestring | nullableoptional

EvaluatedByIdstring · uuidoptional

StageIdinteger · int32optional

JobIdinteger · int32optional

ApplicationIdinteger · int32optional

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/candidates/{id}/evaluations' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Rate": 1,
    "Note": "text",
    "EvaluatedById": "123e4567-e89b-12d3-a456-426614174000",
    "StageId": 1,
    "JobId": 1,
    "ApplicationId": 1
  }'

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

204

401

403

422

500

204

{
  "Id": 1,
  "Created": "2025-04-02T15:04:57.067Z",
  "LastModified": "2025-04-02T15:04:57.067Z",
  "EvaluatedBy": {
    "Id": "123e4567-e89b-12d3-a456-426614174000",
    "Name": "text",
    "Email": "text",
    "SenderEmail": "text",
    "Username": "text",
    "Headline": "text",
    "Avatar": "text",
    "Role": "Administrator",
    "InvitationSentTime": "2025-04-02T15:04:57.067Z"
  },
  "Stage": {
    "Id": 1,
    "Name": "text",
    "Type": "text",
    "Position": 1
  },
  "Job": {
    "Id": 1,
    "Title": "text",
    "FriendlyUrl": "text",
    "Department": "text",
    "RequisitionCode": "text",
    "DepartmentId": 1,
    "Location": "text",
    "Status": "Draft",
    "PipelineId": 1,
    "JobNumber": "text",
    "SecondaryText": "text"
  },
  "ApplicationId": 1,
  "HasAttachment": true,
  "Scorecards": [
    {
      "Name": "text",
      "Purpose": "text",
      "Position": 1,
      "Traits": [
        {
          "Name": "text",
          "Position": 1,
          "Questions": [
            {
              "Question": "text",
              "Position": 1,
              "Rate": 1,
              "Note": "text"
            }
          ],
          "Rate": 1,
          "Note": "text"
        }
      ]
    }
  ],
  "Rate": 1,
  "Note": "text"
}

No Content

Get candidate activities

get

Authorizations

Path parameters

idinteger · int32required

Query parameters

pageinteger · int32 · default: 1optional

perPageinteger · int32 · default: 50optional

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

401

403

404

500

200

{
  "Results": [
    {
      "Id": 1,
      "Created": "2025-04-02T15:04:57.067Z",
      "Scheduled": true,
      "LastModified": "2025-04-02T15:04:57.067Z",
      "ActivityType": 1,
      "ActivityTypeEnum": "Published",
      "Job": {
        "Id": 1,
        "Title": "text",
        "FriendlyUrl": "text",
        "Department": "text",
        "RequisitionCode": "text",
        "DepartmentId": 1,
        "Location": "text",
        "Status": "Draft",
        "PipelineId": 1,
        "JobNumber": "text",
        "SecondaryText": "text"
      },
      "Member": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "text"
      },
      "Meeting": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Type": "Call",
        "StartTime": "2025-04-02T15:04:57.067Z",
        "EndTime": "2025-04-02T15:04:57.067Z",
        "TimeZone": "text",
        "TimeZoneIANA": "text",
        "Subject": "text",
        "Notes": "text",
        "Sequence": 1,
        "Location": {
          "Id": 1,
          "Address": "text",
          "Latitude": 1,
          "Longitude": 1,
          "ConferenceRoom": "text",
          "LocationFormatted": "text"
        },
        "Job": {
          "Id": 1,
          "Title": "text",
          "FriendlyUrl": "text",
          "Department": "text",
          "RequisitionCode": "text",
          "DepartmentId": 1,
          "Location": "text",
          "Status": "Draft",
          "PipelineId": 1,
          "JobNumber": "text",
          "SecondaryText": "text"
        },
        "Attendees": [
          {
            "Id": 1,
            "Status": "Accepted",
            "Type": "Member",
            "Organizer": true,
            "Email": "text",
            "Candidate": {
              "Id": 1,
              "FirstName": "text",
              "LastName": "text",
              "Name": "text",
              "Avatar": "text"
            },
            "Member": {
              "Id": "123e4567-e89b-12d3-a456-426614174000",
              "Name": "text",
              "Email": "text",
              "SenderEmail": "text",
              "Username": "text",
              "Headline": "text",
              "Avatar": "text",
              "Role": "Administrator",
              "InvitationSentTime": "2025-04-02T15:04:57.067Z"
            },
            "ExternalAttendee": {
              "Id": 1,
              "Email": "text",
              "Name": "text"
            }
          }
        ]
      },
      "Employee": {
        "Id": 1,
        "Name": "text"
      },
      "Stage": {
        "Id": 1,
        "Name": "text",
        "Type": "text",
        "Position": 1
      },
      "Article": {
        "Id": 1,
        "Title": "text"
      },
      "Application": {
        "Id": 1,
        "CandidateId": 1,
        "ProfileUrl": "text",
        "Created": "2025-04-02T15:04:57.067Z",
        "Disqualified": true,
        "DisqualifiedAt": "2025-04-02T15:04:57.067Z",
        "DisqualificationReason": "text",
        "Stage": {
          "Id": 1,
          "Name": "text",
          "Type": "text",
          "Position": 1
        },
        "Job": {
          "Id": 1,
          "Title": "text",
          "FriendlyUrl": "text",
          "Department": "text",
          "RequisitionCode": "text",
          "DepartmentId": 1,
          "Location": "text",
          "Status": "Draft",
          "PipelineId": 1,
          "JobNumber": "text",
          "SecondaryText": "text"
        },
        "ExternalId": "text",
        "Source": {
          "SourceType": "JobBoard",
          "SourceBy": "123e4567-e89b-12d3-a456-426614174000",
          "SourceFrom": "text",
          "SourceChanel": "Manual",
          "SourceFormatted": "text"
        },
        "Evaluation": {
          "DefinitelyNo": 1,
          "No": 1,
          "Yes": 1,
          "DefinitelyYes": 1
        },
        "PreviousEvaluation": {
          "DefinitelyNo": 1,
          "No": 1,
          "Yes": 1,
          "DefinitelyYes": 1
        },
        "DisqualificationType": "NoneSpecified"
      },
      "Note": {
        "ActivityId": 1,
        "Message": "text",
        "Visibility": "Everyone",
        "IsNeogovActivity": true,
        "Attachments": [
          {
            "Id": 1,
            "FileName": "text",
            "Url": "text",
            "ContentType": "text",
            "ConvertedUrl": "text",
            "DocumentType": 1,
            "Created": "2025-04-02T15:04:57.067Z",
            "CreatedBy": "text",
            "MalwareScanStatus": "InProgress",
            "MalwareScanResult": "Safe"
          }
        ]
      },
      "Email": {
        "Id": 1,
        "ActivityId": 1,
        "Subject": "text",
        "Message": "text",
        "Attachments": [
          {
            "Id": 1,
            "FileName": "text",
            "Url": "text",
            "ContentType": "text",
            "ConvertedUrl": "text",
            "DocumentType": 1,
            "Created": "2025-04-02T15:04:57.067Z",
            "CreatedBy": "text",
            "MalwareScanStatus": "InProgress",
            "MalwareScanResult": "Safe"
          }
        ],
        "Opens": 1,
        "Clicks": 1,
        "Status": "Sent",
        "To": [
          "text"
        ],
        "Cc": [
          "text"
        ],
        "Bcc": [
          "text"
        ],
        "SubscriptionType": "JobOffersAndCompanyUpdates",
        "ThreadId": "123e4567-e89b-12d3-a456-426614174000",
        "ConversationId": "123e4567-e89b-12d3-a456-426614174000",
        "NumberOfEmails": 1,
        "ReplyEmailId": 1,
        "RawUrl": "text",
        "EmailSender": {
          "MemberId": "123e4567-e89b-12d3-a456-426614174000",
          "Email": "text",
          "Name": "text",
          "Type": "Member"
        },
        "EmailReceivers": [
          {
            "MemberId": "123e4567-e89b-12d3-a456-426614174000",
            "Email": "text",
            "Name": "text",
            "Type": "Member"
          }
        ],
        "Visibility": "Everyone",
        "EmailReceiver": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text"
        }
      },
      "ExternalCommenter": {
        "Id": 1,
        "Name": "text",
        "Email": "text"
      },
      "Candidate": {
        "Id": 1,
        "FirstName": "text",
        "LastName": "text",
        "Name": "text",
        "Avatar": "text"
      },
      "RejectionReason": {
        "Id": 1,
        "Name": "text",
        "Type": "NoneSpecified",
        "Actions": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ]
      },
      "Evaluation": {
        "Id": 1,
        "Created": "2025-04-02T15:04:57.067Z",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "EvaluatedBy": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text",
          "Email": "text",
          "SenderEmail": "text",
          "Username": "text",
          "Headline": "text",
          "Avatar": "text",
          "Role": "Administrator",
          "InvitationSentTime": "2025-04-02T15:04:57.067Z"
        },
        "Stage": {
          "Id": 1,
          "Name": "text",
          "Type": "text",
          "Position": 1
        },
        "Job": {
          "Id": 1,
          "Title": "text",
          "FriendlyUrl": "text",
          "Department": "text",
          "RequisitionCode": "text",
          "DepartmentId": 1,
          "Location": "text",
          "Status": "Draft",
          "PipelineId": 1,
          "JobNumber": "text",
          "SecondaryText": "text"
        },
        "ApplicationId": 1,
        "HasAttachment": true,
        "Scorecards": [
          {
            "Name": "text",
            "Purpose": "text",
            "Position": 1,
            "Traits": [
              {
                "Name": "text",
                "Position": 1,
                "Questions": [
                  {
                    "Question": "text",
                    "Position": 1,
                    "Rate": 1,
                    "Note": "text"
                  }
                ],
                "Rate": 1,
                "Note": "text"
              }
            ]
          }
        ],
        "Rate": 1,
        "Note": "text"
      },
      "ComplianceConsent": {
        "Id": 1,
        "Created": "2025-04-02T15:04:57.067Z",
        "RetentionPeriodConsent": true,
        "RetentionPeriod": "2025-04-02T15:04:57.067Z",
        "ShareConsent": true,
        "ShareComplianceText": "text",
        "PrivacyPolicy": "text"
      },
      "AssessmentOrder": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Status": "Pending",
        "Assessment": {
          "Id": 1,
          "ExternalId": "text",
          "Name": "text",
          "Description": "text",
          "LearnMore": "text",
          "Language": "text",
          "AssessmentType": "BehavioralAssessment",
          "Vendor": {
            "Id": 1,
            "Name": "text",
            "Logo": "text"
          },
          "Price": [
            {
              "Currency": "text",
              "Price": 1
            }
          ]
        },
        "Created": "2025-04-02T15:04:57.067Z",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "Requestor": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text"
        },
        "Stage": {
          "Id": 1,
          "Name": "text",
          "Type": "text",
          "Position": 1
        },
        "Job": {
          "Id": 1,
          "Title": "text",
          "FriendlyUrl": "text",
          "Department": "text",
          "RequisitionCode": "text",
          "DepartmentId": 1,
          "Location": "text",
          "Status": "Draft",
          "PipelineId": 1,
          "JobNumber": "text",
          "SecondaryText": "text"
        },
        "ApplicationId": 1,
        "Result": {
          "Score": "text",
          "ResultUrl": "text",
          "Summary": "text",
          "Duration": 1,
          "Details": null,
          "Grade": "Average",
          "Attachments": [
            {
              "FileName": "text",
              "Url": "text",
              "ContentType": "text",
              "ConvertedUrl": "text",
              "MalwareScanStatus": "InProgress",
              "MalwareScanResult": "Safe"
            }
          ]
        },
        "Anonymized": true
      },
      "Tag": {
        "Id": 1,
        "Value": "text",
        "Count": 1
      },
      "LoggedActivity": {
        "Id": 1,
        "Type": "Call",
        "Body": "text",
        "Created": "2025-04-02T15:04:57.067Z",
        "CallOutcome": "NoAnswer",
        "Direction": "Sent",
        "ApplicationId": 1,
        "CandidateId": 1,
        "PartnerId": "text",
        "Visibility": "Everyone"
      },
      "Task": {
        "Id": 1,
        "Title": "text",
        "PersonalId": "123e4567-e89b-12d3-a456-426614174000",
        "Notes": "text",
        "Status": "Open",
        "DueDate": "2025-04-02T15:04:57.067Z",
        "Reminder": "2025-04-02T15:04:57.067Z",
        "Type": "Todo",
        "ApplicationId": 1,
        "TimelineId": 1,
        "AssignedTo": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text"
        },
        "Candidate": {
          "Id": 1,
          "FirstName": "text",
          "LastName": "text",
          "Name": "text",
          "Avatar": "text"
        },
        "Application": {
          "Id": 1,
          "CandidateId": 1,
          "ProfileUrl": "text",
          "Created": "2025-04-02T15:04:57.067Z",
          "Disqualified": true,
          "DisqualifiedAt": "2025-04-02T15:04:57.067Z",
          "DisqualificationReason": "text",
          "Stage": {
            "Id": 1,
            "Name": "text",
            "Type": "text",
            "Position": 1
          },
          "Job": {
            "Id": 1,
            "Title": "text",
            "FriendlyUrl": "text",
            "Department": "text",
            "RequisitionCode": "text",
            "DepartmentId": 1,
            "Location": "text",
            "Status": "Draft",
            "PipelineId": 1,
            "JobNumber": "text",
            "SecondaryText": "text"
          },
          "ExternalId": "text",
          "Source": {
            "SourceType": "JobBoard",
            "SourceBy": "123e4567-e89b-12d3-a456-426614174000",
            "SourceFrom": "text",
            "SourceChanel": "Manual",
            "SourceFormatted": "text"
          },
          "Evaluation": {
            "DefinitelyNo": 1,
            "No": 1,
            "Yes": 1,
            "DefinitelyYes": 1
          },
          "PreviousEvaluation": {
            "DefinitelyNo": 1,
            "No": 1,
            "Yes": 1,
            "DefinitelyYes": 1
          },
          "DisqualificationType": "NoneSpecified"
        }
      },
      "Pool": {
        "Id": 1,
        "Name": "text",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "LastSize": 1,
        "Pipeline": {
          "Id": 1,
          "Name": "text",
          "Type": "HiringPipeline",
          "Stages": [
            {
              "Id": 1,
              "Name": "text",
              "Type": "Sourced",
              "Ordinal": 1,
              "ActiveCandidates": 1,
              "DisqualifiedCandidates": 1,
              "Candidates": 1,
              "Actions": [
                {
                  "Id": 1,
                  "Type": "SendEmail",
                  "Action": null
                }
              ],
              "Evaluations": [
                {
                  "Id": 1,
                  "Type": "Scorecard",
                  "Evaluation": null
                }
              ],
              "Integrations": [
                {
                  "Type": "JobBoards",
                  "App": null
                }
              ],
              "HasESignatureDocuments": true,
              "HasJobOfferDocuments": true
            }
          ],
          "IsActive": true
        },
        "CurrentStage": {
          "Id": 1,
          "Name": "text",
          "Type": "Sourced",
          "Ordinal": 1,
          "ActiveCandidates": 1,
          "DisqualifiedCandidates": 1,
          "Candidates": 1,
          "Actions": [
            {
              "Id": 1,
              "Type": "SendEmail",
              "Action": null
            }
          ],
          "Evaluations": [
            {
              "Id": 1,
              "Type": "Scorecard",
              "Evaluation": null
            }
          ],
          "Integrations": [
            {
              "Type": "JobBoards",
              "App": null
            }
          ],
          "HasESignatureDocuments": true,
          "HasJobOfferDocuments": true
        }
      },
      "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:04:57.067Z",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "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:04:57.067Z"
        },
        "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:04:57.067Z",
          "LastModified": "2025-04-02T15:04:57.067Z",
          "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:04:57.067Z"
          },
          "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
          }
        ]
      },
      "Session": {
        "PageViewCount": 1,
        "JobViewCount": 1,
        "BlogViewCount": 1,
        "SearchCount": 1,
        "CategoryClickCount": 1,
        "CtaViewCount": 1,
        "CtaClickedCount": 1,
        "JobApplicationStartedCount": 1,
        "JobApplicationCompletedCount": 1,
        "FormViewCount": 1,
        "FormSubmissionCount": 1,
        "SourceType": "JobBoard"
      },
      "Vendor": {
        "Title": "text",
        "Slug": "text",
        "Logo": "text",
        "DocumentationUrl": "text",
        "IsIntegrated": true,
        "Type": "JobBoards"
      },
      "Sms": {
        "Id": 1,
        "Status": "Sent",
        "Service": "Sms",
        "Provider": "TalentLyft",
        "Direction": "Sent",
        "Message": "text",
        "ToPhone": "text",
        "FromPhone": "text",
        "ThreadId": "123e4567-e89b-12d3-a456-426614174000",
        "CampaignId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "Form": {
        "Id": 1,
        "Name": "text",
        "Created": "2025-04-02T15:04:57.067Z",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "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:04:57.067Z"
        },
        "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-04-02T15:04:57.067Z",
            "LastModified": "2025-04-02T15:04:57.067Z",
            "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:04:57.067Z"
            },
            "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:04:57.067Z",
              "LastModified": "2025-04-02T15:04:57.067Z",
              "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:04:57.067Z"
              },
              "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
          }
        ]
      },
      "Action": {
        "Id": 1,
        "Type": "SendEmail",
        "Action": null
      },
      "JobOffer": {
        "Id": 1,
        "Status": "Pending",
        "Type": "Offer",
        "ApprovalSteps": [
          {
            "Id": "123e4567-e89b-12d3-a456-426614174000",
            "Type": "Anyone",
            "Step": 1,
            "Approvers": [
              {
                "Id": 1,
                "AnonymousEmail": "text",
                "User": {
                  "Id": "123e4567-e89b-12d3-a456-426614174000",
                  "Name": "text",
                  "Email": "text",
                  "SenderEmail": "text",
                  "Username": "text",
                  "Headline": "text",
                  "Avatar": "text",
                  "Role": "Administrator",
                  "InvitationSentTime": "2025-04-02T15:04:57.067Z"
                },
                "IsCurrentUser": true,
                "ApprovalStatus": "Approved",
                "RejectionMessage": "text",
                "SkipedBy": {
                  "Id": "123e4567-e89b-12d3-a456-426614174000",
                  "Name": "text",
                  "Email": "text",
                  "SenderEmail": "text",
                  "Username": "text",
                  "Headline": "text",
                  "Avatar": "text",
                  "Role": "Administrator",
                  "InvitationSentTime": "2025-04-02T15:04:57.067Z"
                },
                "SkipedReason": "text",
                "StatusChangeAt": "2025-04-02T15:04:57.067Z"
              }
            ],
            "IsActive": true,
            "ApprovalStatus": "Approved"
          }
        ],
        "Offer": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text",
          "Url": "text",
          "Variables": [
            "text"
          ]
        },
        "AdditionalDocuments": [
          {
            "Id": "123e4567-e89b-12d3-a456-426614174000",
            "Name": "text",
            "Url": "text",
            "Variables": [
              "text"
            ]
          }
        ],
        "InternalVariables": null,
        "Variables": null,
        "ConversationId": "123e4567-e89b-12d3-a456-426614174000",
        "ShowApproveRejectActions": true,
        "CandidateId": 1,
        "ApplicationId": 1,
        "JobId": 1,
        "ConversationCount": 1,
        "OfferTemplateId": 1,
        "Email": {
          "To": [
            {
              "Email": "text",
              "CandidateId": 1,
              "MemberId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "ExcludedTo": [
            {
              "Email": "text",
              "CandidateId": 1,
              "MemberId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "Cc": [
            {
              "Email": "text",
              "CandidateId": 1,
              "MemberId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "Bcc": [
            {
              "Email": "text",
              "CandidateId": 1,
              "MemberId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "Body": "text",
          "Subject": "text",
          "Attachments": [
            1
          ],
          "Tags": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "EmailCredentials": {
            "EmailProvider": "TalentLyft",
            "Credentials": [
              {
                "Key": 1,
                "Value": "text"
              }
            ],
            "Name": "text",
            "Email": "text"
          },
          "SenderId": "123e4567-e89b-12d3-a456-426614174000",
          "JobId": 1,
          "StageId": 1,
          "TemplateId": 1,
          "ReplyEmailId": 1,
          "ThreadId": "123e4567-e89b-12d3-a456-426614174000",
          "SubscriptionType": "JobOffersAndCompanyUpdates",
          "SendAt": "2025-04-02T15:04:57.067Z",
          "LanguageCode": "text",
          "Visibility": "Everyone",
          "CampaignId": "123e4567-e89b-12d3-a456-426614174000",
          "SendingType": "CompanyMail",
          "TriggeredBy": "VirtualRecruiter",
          "Audience": {
            "JobSearchFilter": {
              "Query": "text",
              "Job": 1,
              "Stage": 1,
              "Disqualified": true,
              "Tags": [
                "text"
              ],
              "Answers": [
                1
              ],
              "JobApplicationLocations": [
                1
              ],
              "SourceTypes": [
                "JobBoard"
              ],
              "DisqualificationReasons": [
                1
              ],
              "CustomFields": [
                1
              ],
              "Pools": [
                1
              ],
              "ApplicantId": 1
            },
            "Query": [
              {
                "Key": "text",
                "Value": "text",
                "Operator": "Eq"
              }
            ],
            "Campaigns": {
              "CampaignId": "123e4567-e89b-12d3-a456-426614174000",
              "EmailStatus": "Sent"
            }
          },
          "IsBulkAction": true
        },
        "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
        "TimelineId": 1,
        "Meta": {
          "Company": "text",
          "CandidateName": "text",
          "JobTitle": "text",
          "JobLocation": "text",
          "JobDepartment": "text",
          "Budget": {
            "Frequency": "Yearly",
            "AmountFrom": 1,
            "AmountTo": 1,
            "CurrencyId": "text",
            "CurrencyText": "text",
            "CurrencySymbol": "text"
          }
        }
      },
      "JobRequisitionHiredApplicant": {
        "IsActivityEditable": true,
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "SalaryFrequency": "Yearly",
        "SalaryCurrency": "text",
        "SalaryAmount": 1,
        "PlannedStartDate": "text",
        "JobRequisition": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "JobRequisitionStatus": "Draft",
          "TempJobName": "text"
        }
      },
      "IsPrivate": true,
      "HasAttachment": true,
      "ExternalCommentName": "text"
    }
  ],
  "Count": 1,
  "Page": 1,
  "PerPage": 1,
  "Pages": {
    "First": "text",
    "Prev": "text",
    "Next": "text",
    "Last": "text"
  },
  "IdResults": [
    {
      "Id": 1,
      "Created": "2025-04-02T15:04:57.067Z",
      "Scheduled": true,
      "LastModified": "2025-04-02T15:04:57.067Z",
      "ActivityType": 1,
      "ActivityTypeEnum": "Published",
      "Job": {
        "Id": 1,
        "Title": "text",
        "FriendlyUrl": "text",
        "Department": "text",
        "RequisitionCode": "text",
        "DepartmentId": 1,
        "Location": "text",
        "Status": "Draft",
        "PipelineId": 1,
        "JobNumber": "text",
        "SecondaryText": "text"
      },
      "Member": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Name": "text"
      },
      "Meeting": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Type": "Call",
        "StartTime": "2025-04-02T15:04:57.067Z",
        "EndTime": "2025-04-02T15:04:57.067Z",
        "TimeZone": "text",
        "TimeZoneIANA": "text",
        "Subject": "text",
        "Notes": "text",
        "Sequence": 1,
        "Location": {
          "Id": 1,
          "Address": "text",
          "Latitude": 1,
          "Longitude": 1,
          "ConferenceRoom": "text",
          "LocationFormatted": "text"
        },
        "Job": {
          "Id": 1,
          "Title": "text",
          "FriendlyUrl": "text",
          "Department": "text",
          "RequisitionCode": "text",
          "DepartmentId": 1,
          "Location": "text",
          "Status": "Draft",
          "PipelineId": 1,
          "JobNumber": "text",
          "SecondaryText": "text"
        },
        "Attendees": [
          {
            "Id": 1,
            "Status": "Accepted",
            "Type": "Member",
            "Organizer": true,
            "Email": "text",
            "Candidate": {
              "Id": 1,
              "FirstName": "text",
              "LastName": "text",
              "Name": "text",
              "Avatar": "text"
            },
            "Member": {
              "Id": "123e4567-e89b-12d3-a456-426614174000",
              "Name": "text",
              "Email": "text",
              "SenderEmail": "text",
              "Username": "text",
              "Headline": "text",
              "Avatar": "text",
              "Role": "Administrator",
              "InvitationSentTime": "2025-04-02T15:04:57.067Z"
            },
            "ExternalAttendee": {
              "Id": 1,
              "Email": "text",
              "Name": "text"
            }
          }
        ]
      },
      "Employee": {
        "Id": 1,
        "Name": "text"
      },
      "Stage": {
        "Id": 1,
        "Name": "text",
        "Type": "text",
        "Position": 1
      },
      "Article": {
        "Id": 1,
        "Title": "text"
      },
      "Application": {
        "Id": 1,
        "CandidateId": 1,
        "ProfileUrl": "text",
        "Created": "2025-04-02T15:04:57.067Z",
        "Disqualified": true,
        "DisqualifiedAt": "2025-04-02T15:04:57.067Z",
        "DisqualificationReason": "text",
        "Stage": {
          "Id": 1,
          "Name": "text",
          "Type": "text",
          "Position": 1
        },
        "Job": {
          "Id": 1,
          "Title": "text",
          "FriendlyUrl": "text",
          "Department": "text",
          "RequisitionCode": "text",
          "DepartmentId": 1,
          "Location": "text",
          "Status": "Draft",
          "PipelineId": 1,
          "JobNumber": "text",
          "SecondaryText": "text"
        },
        "ExternalId": "text",
        "Source": {
          "SourceType": "JobBoard",
          "SourceBy": "123e4567-e89b-12d3-a456-426614174000",
          "SourceFrom": "text",
          "SourceChanel": "Manual",
          "SourceFormatted": "text"
        },
        "Evaluation": {
          "DefinitelyNo": 1,
          "No": 1,
          "Yes": 1,
          "DefinitelyYes": 1
        },
        "PreviousEvaluation": {
          "DefinitelyNo": 1,
          "No": 1,
          "Yes": 1,
          "DefinitelyYes": 1
        },
        "DisqualificationType": "NoneSpecified"
      },
      "Note": {
        "ActivityId": 1,
        "Message": "text",
        "Visibility": "Everyone",
        "IsNeogovActivity": true,
        "Attachments": [
          {
            "Id": 1,
            "FileName": "text",
            "Url": "text",
            "ContentType": "text",
            "ConvertedUrl": "text",
            "DocumentType": 1,
            "Created": "2025-04-02T15:04:57.067Z",
            "CreatedBy": "text",
            "MalwareScanStatus": "InProgress",
            "MalwareScanResult": "Safe"
          }
        ]
      },
      "Email": {
        "Id": 1,
        "ActivityId": 1,
        "Subject": "text",
        "Message": "text",
        "Attachments": [
          {
            "Id": 1,
            "FileName": "text",
            "Url": "text",
            "ContentType": "text",
            "ConvertedUrl": "text",
            "DocumentType": 1,
            "Created": "2025-04-02T15:04:57.067Z",
            "CreatedBy": "text",
            "MalwareScanStatus": "InProgress",
            "MalwareScanResult": "Safe"
          }
        ],
        "Opens": 1,
        "Clicks": 1,
        "Status": "Sent",
        "To": [
          "text"
        ],
        "Cc": [
          "text"
        ],
        "Bcc": [
          "text"
        ],
        "SubscriptionType": "JobOffersAndCompanyUpdates",
        "ThreadId": "123e4567-e89b-12d3-a456-426614174000",
        "ConversationId": "123e4567-e89b-12d3-a456-426614174000",
        "NumberOfEmails": 1,
        "ReplyEmailId": 1,
        "RawUrl": "text",
        "EmailSender": {
          "MemberId": "123e4567-e89b-12d3-a456-426614174000",
          "Email": "text",
          "Name": "text",
          "Type": "Member"
        },
        "EmailReceivers": [
          {
            "MemberId": "123e4567-e89b-12d3-a456-426614174000",
            "Email": "text",
            "Name": "text",
            "Type": "Member"
          }
        ],
        "Visibility": "Everyone",
        "EmailReceiver": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text"
        }
      },
      "ExternalCommenter": {
        "Id": 1,
        "Name": "text",
        "Email": "text"
      },
      "Candidate": {
        "Id": 1,
        "FirstName": "text",
        "LastName": "text",
        "Name": "text",
        "Avatar": "text"
      },
      "RejectionReason": {
        "Id": 1,
        "Name": "text",
        "Type": "NoneSpecified",
        "Actions": [
          {
            "Id": 1,
            "Type": "SendEmail",
            "Action": null
          }
        ]
      },
      "Evaluation": {
        "Id": 1,
        "Created": "2025-04-02T15:04:57.067Z",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "EvaluatedBy": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text",
          "Email": "text",
          "SenderEmail": "text",
          "Username": "text",
          "Headline": "text",
          "Avatar": "text",
          "Role": "Administrator",
          "InvitationSentTime": "2025-04-02T15:04:57.067Z"
        },
        "Stage": {
          "Id": 1,
          "Name": "text",
          "Type": "text",
          "Position": 1
        },
        "Job": {
          "Id": 1,
          "Title": "text",
          "FriendlyUrl": "text",
          "Department": "text",
          "RequisitionCode": "text",
          "DepartmentId": 1,
          "Location": "text",
          "Status": "Draft",
          "PipelineId": 1,
          "JobNumber": "text",
          "SecondaryText": "text"
        },
        "ApplicationId": 1,
        "HasAttachment": true,
        "Scorecards": [
          {
            "Name": "text",
            "Purpose": "text",
            "Position": 1,
            "Traits": [
              {
                "Name": "text",
                "Position": 1,
                "Questions": [
                  {
                    "Question": "text",
                    "Position": 1,
                    "Rate": 1,
                    "Note": "text"
                  }
                ],
                "Rate": 1,
                "Note": "text"
              }
            ]
          }
        ],
        "Rate": 1,
        "Note": "text"
      },
      "ComplianceConsent": {
        "Id": 1,
        "Created": "2025-04-02T15:04:57.067Z",
        "RetentionPeriodConsent": true,
        "RetentionPeriod": "2025-04-02T15:04:57.067Z",
        "ShareConsent": true,
        "ShareComplianceText": "text",
        "PrivacyPolicy": "text"
      },
      "AssessmentOrder": {
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "Status": "Pending",
        "Assessment": {
          "Id": 1,
          "ExternalId": "text",
          "Name": "text",
          "Description": "text",
          "LearnMore": "text",
          "Language": "text",
          "AssessmentType": "BehavioralAssessment",
          "Vendor": {
            "Id": 1,
            "Name": "text",
            "Logo": "text"
          },
          "Price": [
            {
              "Currency": "text",
              "Price": 1
            }
          ]
        },
        "Created": "2025-04-02T15:04:57.067Z",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "Requestor": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text"
        },
        "Stage": {
          "Id": 1,
          "Name": "text",
          "Type": "text",
          "Position": 1
        },
        "Job": {
          "Id": 1,
          "Title": "text",
          "FriendlyUrl": "text",
          "Department": "text",
          "RequisitionCode": "text",
          "DepartmentId": 1,
          "Location": "text",
          "Status": "Draft",
          "PipelineId": 1,
          "JobNumber": "text",
          "SecondaryText": "text"
        },
        "ApplicationId": 1,
        "Result": {
          "Score": "text",
          "ResultUrl": "text",
          "Summary": "text",
          "Duration": 1,
          "Details": null,
          "Grade": "Average",
          "Attachments": [
            {
              "FileName": "text",
              "Url": "text",
              "ContentType": "text",
              "ConvertedUrl": "text",
              "MalwareScanStatus": "InProgress",
              "MalwareScanResult": "Safe"
            }
          ]
        },
        "Anonymized": true
      },
      "Tag": {
        "Id": 1,
        "Value": "text",
        "Count": 1
      },
      "LoggedActivity": {
        "Id": 1,
        "Type": "Call",
        "Body": "text",
        "Created": "2025-04-02T15:04:57.067Z",
        "CallOutcome": "NoAnswer",
        "Direction": "Sent",
        "ApplicationId": 1,
        "CandidateId": 1,
        "PartnerId": "text",
        "Visibility": "Everyone"
      },
      "Task": {
        "Id": 1,
        "Title": "text",
        "PersonalId": "123e4567-e89b-12d3-a456-426614174000",
        "Notes": "text",
        "Status": "Open",
        "DueDate": "2025-04-02T15:04:57.067Z",
        "Reminder": "2025-04-02T15:04:57.067Z",
        "Type": "Todo",
        "ApplicationId": 1,
        "TimelineId": 1,
        "AssignedTo": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text"
        },
        "Candidate": {
          "Id": 1,
          "FirstName": "text",
          "LastName": "text",
          "Name": "text",
          "Avatar": "text"
        },
        "Application": {
          "Id": 1,
          "CandidateId": 1,
          "ProfileUrl": "text",
          "Created": "2025-04-02T15:04:57.067Z",
          "Disqualified": true,
          "DisqualifiedAt": "2025-04-02T15:04:57.067Z",
          "DisqualificationReason": "text",
          "Stage": {
            "Id": 1,
            "Name": "text",
            "Type": "text",
            "Position": 1
          },
          "Job": {
            "Id": 1,
            "Title": "text",
            "FriendlyUrl": "text",
            "Department": "text",
            "RequisitionCode": "text",
            "DepartmentId": 1,
            "Location": "text",
            "Status": "Draft",
            "PipelineId": 1,
            "JobNumber": "text",
            "SecondaryText": "text"
          },
          "ExternalId": "text",
          "Source": {
            "SourceType": "JobBoard",
            "SourceBy": "123e4567-e89b-12d3-a456-426614174000",
            "SourceFrom": "text",
            "SourceChanel": "Manual",
            "SourceFormatted": "text"
          },
          "Evaluation": {
            "DefinitelyNo": 1,
            "No": 1,
            "Yes": 1,
            "DefinitelyYes": 1
          },
          "PreviousEvaluation": {
            "DefinitelyNo": 1,
            "No": 1,
            "Yes": 1,
            "DefinitelyYes": 1
          },
          "DisqualificationType": "NoneSpecified"
        }
      },
      "Pool": {
        "Id": 1,
        "Name": "text",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "LastSize": 1,
        "Pipeline": {
          "Id": 1,
          "Name": "text",
          "Type": "HiringPipeline",
          "Stages": [
            {
              "Id": 1,
              "Name": "text",
              "Type": "Sourced",
              "Ordinal": 1,
              "ActiveCandidates": 1,
              "DisqualifiedCandidates": 1,
              "Candidates": 1,
              "Actions": [
                {
                  "Id": 1,
                  "Type": "SendEmail",
                  "Action": null
                }
              ],
              "Evaluations": [
                {
                  "Id": 1,
                  "Type": "Scorecard",
                  "Evaluation": null
                }
              ],
              "Integrations": [
                {
                  "Type": "JobBoards",
                  "App": null
                }
              ],
              "HasESignatureDocuments": true,
              "HasJobOfferDocuments": true
            }
          ],
          "IsActive": true
        },
        "CurrentStage": {
          "Id": 1,
          "Name": "text",
          "Type": "Sourced",
          "Ordinal": 1,
          "ActiveCandidates": 1,
          "DisqualifiedCandidates": 1,
          "Candidates": 1,
          "Actions": [
            {
              "Id": 1,
              "Type": "SendEmail",
              "Action": null
            }
          ],
          "Evaluations": [
            {
              "Id": 1,
              "Type": "Scorecard",
              "Evaluation": null
            }
          ],
          "Integrations": [
            {
              "Type": "JobBoards",
              "App": null
            }
          ],
          "HasESignatureDocuments": true,
          "HasJobOfferDocuments": true
        }
      },
      "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:04:57.067Z",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "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:04:57.067Z"
        },
        "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:04:57.067Z",
          "LastModified": "2025-04-02T15:04:57.067Z",
          "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:04:57.067Z"
          },
          "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
          }
        ]
      },
      "Session": {
        "PageViewCount": 1,
        "JobViewCount": 1,
        "BlogViewCount": 1,
        "SearchCount": 1,
        "CategoryClickCount": 1,
        "CtaViewCount": 1,
        "CtaClickedCount": 1,
        "JobApplicationStartedCount": 1,
        "JobApplicationCompletedCount": 1,
        "FormViewCount": 1,
        "FormSubmissionCount": 1,
        "SourceType": "JobBoard"
      },
      "Vendor": {
        "Title": "text",
        "Slug": "text",
        "Logo": "text",
        "DocumentationUrl": "text",
        "IsIntegrated": true,
        "Type": "JobBoards"
      },
      "Sms": {
        "Id": 1,
        "Status": "Sent",
        "Service": "Sms",
        "Provider": "TalentLyft",
        "Direction": "Sent",
        "Message": "text",
        "ToPhone": "text",
        "FromPhone": "text",
        "ThreadId": "123e4567-e89b-12d3-a456-426614174000",
        "CampaignId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "Form": {
        "Id": 1,
        "Name": "text",
        "Created": "2025-04-02T15:04:57.067Z",
        "LastModified": "2025-04-02T15:04:57.067Z",
        "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:04:57.067Z"
        },
        "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-04-02T15:04:57.067Z",
            "LastModified": "2025-04-02T15:04:57.067Z",
            "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:04:57.067Z"
            },
            "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:04:57.067Z",
              "LastModified": "2025-04-02T15:04:57.067Z",
              "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:04:57.067Z"
              },
              "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
          }
        ]
      },
      "Action": {
        "Id": 1,
        "Type": "SendEmail",
        "Action": null
      },
      "JobOffer": {
        "Id": 1,
        "Status": "Pending",
        "Type": "Offer",
        "ApprovalSteps": [
          {
            "Id": "123e4567-e89b-12d3-a456-426614174000",
            "Type": "Anyone",
            "Step": 1,
            "Approvers": [
              {
                "Id": 1,
                "AnonymousEmail": "text",
                "User": {
                  "Id": "123e4567-e89b-12d3-a456-426614174000",
                  "Name": "text",
                  "Email": "text",
                  "SenderEmail": "text",
                  "Username": "text",
                  "Headline": "text",
                  "Avatar": "text",
                  "Role": "Administrator",
                  "InvitationSentTime": "2025-04-02T15:04:57.067Z"
                },
                "IsCurrentUser": true,
                "ApprovalStatus": "Approved",
                "RejectionMessage": "text",
                "SkipedBy": {
                  "Id": "123e4567-e89b-12d3-a456-426614174000",
                  "Name": "text",
                  "Email": "text",
                  "SenderEmail": "text",
                  "Username": "text",
                  "Headline": "text",
                  "Avatar": "text",
                  "Role": "Administrator",
                  "InvitationSentTime": "2025-04-02T15:04:57.067Z"
                },
                "SkipedReason": "text",
                "StatusChangeAt": "2025-04-02T15:04:57.067Z"
              }
            ],
            "IsActive": true,
            "ApprovalStatus": "Approved"
          }
        ],
        "Offer": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "Name": "text",
          "Url": "text",
          "Variables": [
            "text"
          ]
        },
        "AdditionalDocuments": [
          {
            "Id": "123e4567-e89b-12d3-a456-426614174000",
            "Name": "text",
            "Url": "text",
            "Variables": [
              "text"
            ]
          }
        ],
        "InternalVariables": null,
        "Variables": null,
        "ConversationId": "123e4567-e89b-12d3-a456-426614174000",
        "ShowApproveRejectActions": true,
        "CandidateId": 1,
        "ApplicationId": 1,
        "JobId": 1,
        "ConversationCount": 1,
        "OfferTemplateId": 1,
        "Email": {
          "To": [
            {
              "Email": "text",
              "CandidateId": 1,
              "MemberId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "ExcludedTo": [
            {
              "Email": "text",
              "CandidateId": 1,
              "MemberId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "Cc": [
            {
              "Email": "text",
              "CandidateId": 1,
              "MemberId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "Bcc": [
            {
              "Email": "text",
              "CandidateId": 1,
              "MemberId": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "Body": "text",
          "Subject": "text",
          "Attachments": [
            1
          ],
          "Tags": [
            {
              "Key": "text",
              "Value": "text"
            }
          ],
          "EmailCredentials": {
            "EmailProvider": "TalentLyft",
            "Credentials": [
              {
                "Key": 1,
                "Value": "text"
              }
            ],
            "Name": "text",
            "Email": "text"
          },
          "SenderId": "123e4567-e89b-12d3-a456-426614174000",
          "JobId": 1,
          "StageId": 1,
          "TemplateId": 1,
          "ReplyEmailId": 1,
          "ThreadId": "123e4567-e89b-12d3-a456-426614174000",
          "SubscriptionType": "JobOffersAndCompanyUpdates",
          "SendAt": "2025-04-02T15:04:57.067Z",
          "LanguageCode": "text",
          "Visibility": "Everyone",
          "CampaignId": "123e4567-e89b-12d3-a456-426614174000",
          "SendingType": "CompanyMail",
          "TriggeredBy": "VirtualRecruiter",
          "Audience": {
            "JobSearchFilter": {
              "Query": "text",
              "Job": 1,
              "Stage": 1,
              "Disqualified": true,
              "Tags": [
                "text"
              ],
              "Answers": [
                1
              ],
              "JobApplicationLocations": [
                1
              ],
              "SourceTypes": [
                "JobBoard"
              ],
              "DisqualificationReasons": [
                1
              ],
              "CustomFields": [
                1
              ],
              "Pools": [
                1
              ],
              "ApplicantId": 1
            },
            "Query": [
              {
                "Key": "text",
                "Value": "text",
                "Operator": "Eq"
              }
            ],
            "Campaigns": {
              "CampaignId": "123e4567-e89b-12d3-a456-426614174000",
              "EmailStatus": "Sent"
            }
          },
          "IsBulkAction": true
        },
        "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
        "TimelineId": 1,
        "Meta": {
          "Company": "text",
          "CandidateName": "text",
          "JobTitle": "text",
          "JobLocation": "text",
          "JobDepartment": "text",
          "Budget": {
            "Frequency": "Yearly",
            "AmountFrom": 1,
            "AmountTo": 1,
            "CurrencyId": "text",
            "CurrencyText": "text",
            "CurrencySymbol": "text"
          }
        }
      },
      "JobRequisitionHiredApplicant": {
        "IsActivityEditable": true,
        "Id": "123e4567-e89b-12d3-a456-426614174000",
        "SalaryFrequency": "Yearly",
        "SalaryCurrency": "text",
        "SalaryAmount": 1,
        "PlannedStartDate": "text",
        "JobRequisition": {
          "Id": "123e4567-e89b-12d3-a456-426614174000",
          "JobRequisitionStatus": "Draft",
          "TempJobName": "text"
        }
      },
      "IsPrivate": true,
      "HasAttachment": true,
      "ExternalCommentName": "text"
    }
  ],
  "OriginalCount": 1
}

Success

Get candidate application by id

get

Authorizations

Path parameters

idinteger · int32required

applicationIdinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v2/candidates/{id}/applications/{applicationId}' \
  --header 'Authorization: YOUR_API_KEY'

200

401

403

404

500

200

{
  "Answers": [
    {
      "Id": 1,
      "Required": true,
      "Body": "text",
      "Type": "text",
      "Position": 1,
      "Choices": [
        {
          "Id": 1,
          "Body": "text",
          "Disqualify": true,
          "Tag": "text",
          "Value": 1,
          "Ordinal": 1,
          "IsTranslated": true,
          "Translation": {
            "TranslationProperties": [
              "text"
            ],
            "TranslationRequiredProperties": [
              "text"
            ],
            "Translations": [
              {
                "Language": "text",
                "Property": "text",
                "TranslateValue": "text"
              }
            ]
          },
          "DisplayName": "text"
        }
      ],
      "Answer": {
        "Response": "text",
        "File": {
          "Id": 1,
          "FileName": "text",
          "Url": "text",
          "ContentType": "text",
          "ConvertedUrl": "text",
          "DocumentType": 1,
          "Created": "2025-04-02T15:04:57.067Z",
          "CreatedBy": "text",
          "MalwareScanStatus": "InProgress",
          "MalwareScanResult": "Safe"
        },
        "Choices": [
          1
        ]
      }
    }
  ],
  "ScreeningQuestionAnswers": [
    {
      "Field": {
        "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
          }
        ]
      },
      "Answer": {
        "Choices": [
          1
        ],
        "File": {
          "Id": 1,
          "FileName": "text",
          "Url": "text",
          "ContentType": "text",
          "ConvertedUrl": "text",
          "DocumentType": 1,
          "Created": "2025-04-02T15:04:57.067Z",
          "CreatedBy": "text",
          "MalwareScanStatus": "InProgress",
          "MalwareScanResult": "Safe"
        },
        "Value": "text"
      }
    }
  ],
  "Projects": [
    {
      "Id": 1,
      "ProjectName": "text",
      "ProjectUrl": "text",
      "Description": "text",
      "From": "2025-04-02T15:04:57.067Z",
      "To": "2025-04-02T15:04:57.067Z",
      "Current": true
    }
  ],
  "Experiences": [
    {
      "Id": 1,
      "Title": "text",
      "Company": "text",
      "Description": "text",
      "From": "2025-04-02T15:04:57.067Z",
      "To": "2025-04-02T15:04:57.067Z",
      "Current": true
    }
  ],
  "Educations": [
    {
      "Id": 1,
      "Institution": "text",
      "Degree": "text",
      "Description": "text",
      "From": "2025-04-02T15:04:57.067Z",
      "To": "2025-04-02T15:04:57.067Z",
      "Current": true
    }
  ],
  "Languages": [
    {
      "Id": 1,
      "Language": "text",
      "LanguageIso": "text",
      "LanguageProficiency": "text"
    }
  ],
  "Attachments": [
    {
      "Id": 1,
      "FileName": "text",
      "Url": "text",
      "ContentType": "text",
      "ConvertedUrl": "text",
      "DocumentType": 1,
      "Created": "2025-04-02T15:04:57.067Z",
      "CreatedBy": "text",
      "MalwareScanStatus": "InProgress",
      "MalwareScanResult": "Safe"
    }
  ],
  "Resume": {
    "Id": 1,
    "FileName": "text",
    "Url": "text",
    "ContentType": "text",
    "ConvertedUrl": "text",
    "DocumentType": 1,
    "Created": "2025-04-02T15:04:57.067Z",
    "CreatedBy": "text",
    "MalwareScanStatus": "InProgress",
    "MalwareScanResult": "Safe"
  },
  "Summary": "text",
  "CoverLetter": "text",
  "MatchScore": {
    "Id": 1,
    "Overall": 1,
    "Occupation": 1,
    "Industry": 1,
    "Skills": 1,
    "JobFunction": 1,
    "Knowledge": 1,
    "Abilities": 1,
    "Summary": "text",
    "Created": "2025-04-02T15:04:57.067Z",
    "LastModified": "2025-04-02T15:04:57.067Z",
    "Feedback": {
      "IsRelevant": true,
      "Comment": "text",
      "LastModified": "2025-04-02T15:04:57.067Z",
      "Created": "2025-04-02T15:04:57.067Z"
    },
    "Status": "NotCalculated"
  },
  "CustomFields": [
    {
      "Field": {
        "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
      },
      "Answer": {
        "Choices": [
          1
        ],
        "File": {
          "Id": 1,
          "FileName": "text",
          "Url": "text",
          "ContentType": "text",
          "ConvertedUrl": "text",
          "DocumentType": 1,
          "Created": "2025-04-02T15:04:57.067Z",
          "CreatedBy": "text",
          "MalwareScanStatus": "InProgress",
          "MalwareScanResult": "Safe"
        },
        "Value": "text"
      }
    }
  ],
  "Evaluations": [
    {
      "IsEvaluatedByMe": true,
      "EvaluationSummary": {
        "DefinitelyNo": [
          1
        ],
        "No": [
          1
        ],
        "Yes": [
          1
        ],
        "DefinitelyYes": [
          1
        ]
      },
      "Id": 1,
      "Name": "text",
      "Type": "Sourced",
      "Ordinal": 1,
      "ActiveCandidates": 1,
      "DisqualifiedCandidates": 1,
      "Candidates": 1,
      "Actions": [
        {
          "Id": 1,
          "Type": "SendEmail",
          "Action": null
        }
      ],
      "Evaluations": [
        {
          "Id": 1,
          "Type": "Scorecard",
          "Evaluation": null
        }
      ],
      "Integrations": [
        {
          "Type": "JobBoards",
          "App": null
        }
      ],
      "HasESignatureDocuments": true,
      "HasJobOfferDocuments": true
    }
  ],
  "EeeopIsSelfIdentified": true,
  "HasActiveOffer": true,
  "Id": 1,
  "CandidateId": 1,
  "ProfileUrl": "text",
  "Created": "2025-04-02T15:04:57.067Z",
  "Disqualified": true,
  "DisqualifiedAt": "2025-04-02T15:04:57.067Z",
  "DisqualificationReason": "text",
  "Stage": {
    "Id": 1,
    "Name": "text",
    "Type": "text",
    "Position": 1
  },
  "Job": {
    "Id": 1,
    "Title": "text",
    "FriendlyUrl": "text",
    "Department": "text",
    "RequisitionCode": "text",
    "DepartmentId": 1,
    "Location": "text",
    "Status": "Draft",
    "PipelineId": 1,
    "JobNumber": "text",
    "SecondaryText": "text"
  },
  "ExternalId": "text",
  "Source": {
    "SourceType": "JobBoard",
    "SourceBy": "123e4567-e89b-12d3-a456-426614174000",
    "SourceFrom": "text",
    "SourceChanel": "Manual",
    "SourceFormatted": "text"
  },
  "Evaluation": {
    "DefinitelyNo": 1,
    "No": 1,
    "Yes": 1,
    "DefinitelyYes": 1
  },
  "PreviousEvaluation": {
    "DefinitelyNo": 1,
    "No": 1,
    "Yes": 1,
    "DefinitelyYes": 1
  },
  "DisqualificationType": "NoneSpecified"
}

Success

Create education for a candidate application

post

Authorizations

Path parameters

idinteger · int32required

applicationIdinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Idinteger · int32optional

Institutionstring · max: 2000required

Degreestring | nullableoptional

Descriptionstring | nullableoptional

Fromstring · date-time | nullableoptional

Tostring · date-time | nullableoptional

Currentbooleanoptional

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/candidates/{id}/applications/{applicationId}/education' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Institution": "text",
    "Degree": "text",
    "Description": "text",
    "From": "2025-04-02T15:04:57.067Z",
    "To": "2025-04-02T15:04:57.067Z",
    "Current": true
  }'

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

201

401

403

404

500

201

{
  "Id": 1,
  "Title": "text",
  "Location": "text",
  "Description": "text",
  "DateFrom": "2025-04-02T15:04:57.067Z",
  "DateTo": "2025-04-02T15:04:57.067Z",
  "ApplicantProfileItemTypeId": "Experience",
  "CertificateName": "text",
  "Url": "text",
  "ApplicantProfileId": 1
}

Created

Update education for a candidate application

put

Authorizations

Path parameters

idinteger · int32required

applicationIdinteger · int32required

educationIdinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Idinteger · int32optional

Institutionstring · max: 2000required

Degreestring | nullableoptional

Descriptionstring | nullableoptional

Fromstring · date-time | nullableoptional

Tostring · date-time | nullableoptional

Currentbooleanoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v2/candidates/{id}/applications/{applicationId}/education/{educationId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Institution": "text",
    "Degree": "text",
    "Description": "text",
    "From": "2025-04-02T15:04:57.067Z",
    "To": "2025-04-02T15:04:57.067Z",
    "Current": true
  }'

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

204

401

403

404

500

204

No body

No Content

Delete education for a candidate application

delete

Authorizations

Path parameters

idinteger · int32required

applicationIdinteger · int32required

educationIdinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v2/candidates/{id}/applications/{applicationId}/education/{educationId}' \
  --header 'Authorization: YOUR_API_KEY'

204

401

403

404

500

204

No body

No Content

Create experience for a candidate application

post

Authorizations

Path parameters

idinteger · int32required

applicationIdinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Idinteger · int32optional

Titlestring · max: 2000required

Companystring | nullableoptional

Descriptionstring | nullableoptional

Fromstring · date-time | nullableoptional

Tostring · date-time | nullableoptional

Currentbooleanoptional

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/candidates/{id}/applications/{applicationId}/experience' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Title": "text",
    "Company": "text",
    "Description": "text",
    "From": "2025-04-02T15:04:57.067Z",
    "To": "2025-04-02T15:04:57.067Z",
    "Current": true
  }'

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

201

401

403

404

500

201

{
  "Id": 1,
  "Title": "text",
  "Location": "text",
  "Description": "text",
  "DateFrom": "2025-04-02T15:04:57.067Z",
  "DateTo": "2025-04-02T15:04:57.067Z",
  "ApplicantProfileItemTypeId": "Experience",
  "CertificateName": "text",
  "Url": "text",
  "ApplicantProfileId": 1
}

Created

Update experience for a candidate application

put

Authorizations

Path parameters

idinteger · int32required

applicationIdinteger · int32required

experienceIdinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Idinteger · int32optional

Titlestring · max: 2000required

Companystring | nullableoptional

Descriptionstring | nullableoptional

Fromstring · date-time | nullableoptional

Tostring · date-time | nullableoptional

Currentbooleanoptional

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v2/candidates/{id}/applications/{applicationId}/experience/{experienceId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Title": "text",
    "Company": "text",
    "Description": "text",
    "From": "2025-04-02T15:04:57.067Z",
    "To": "2025-04-02T15:04:57.067Z",
    "Current": true
  }'

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

204

401

403

404

500

204

No body

No Content

Delete experience for a candidate application

delete

Authorizations

Path parameters

idinteger · int32required

applicationIdinteger · int32required

experienceIdinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v2/candidates/{id}/applications/{applicationId}/experience/{experienceId}' \
  --header 'Authorization: YOUR_API_KEY'

204

401

403

404

500

204

No body

No Content

Get candidate's contacts

get

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

401

403

500

200

{
  "Emails": [
    {
      "Id": 1,
      "Value": "text",
      "Type": "text",
      "IsPrimary": true
    }
  ],
  "PhoneNumbers": [
    {
      "Id": 1,
      "Value": "text",
      "Type": "text",
      "IsPrimary": true
    }
  ],
  "SocialNetworks": [
    {
      "Id": 1,
      "Value": "text",
      "Type": "text",
      "IsPrimary": true
    }
  ]
}

Success

Create candidate's contact

post

Authorizations

Path parameters

idinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Idinteger · int32optional

Valuestring · max: 300required

Typestring | nullableoptional

IsPrimaryboolean | nullableoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v2/candidates/{id}/contacts' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Value": "text",
    "Type": "text",
    "IsPrimary": true
  }'

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

201

401

403

500

201

No body

Created

Update candidate's contact

put

Authorizations

Path parameters

idinteger · int32required

contactIdinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Body

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

Idinteger · int32optional

Valuestring · max: 300required

Typestring | nullableoptional

IsPrimaryboolean | nullableoptional

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v2/candidates/{id}/contacts/{contactId}' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: application/json-patch+json' \
  --data '{
    "Id": 1,
    "Value": "text",
    "Type": "text",
    "IsPrimary": true
  }'

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

204

401

403

500

204

No body

No Content

Delete candidate's contact

delete

Authorizations

Path parameters

idinteger · int32required

contactIdinteger · int32required

Header parameters

X-TL-CompanyIdguidoptional

Company Id

X-TL-Subdomainguidoptional

Account subdomain

X-TL-UserIdguidoptional

Team member id

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v2/candidates/{id}/contacts/{contactId}' \
  --header 'Authorization: YOUR_API_KEY'

204

401

403

500

204

No body

No Content