---
title: "Create one or multiple talent"
method: POST
path: "/api/servicepool/talents"
tags: ["talent"]
---

# Create one or multiple talent

`POST /api/servicepool/talents`

## Request body

- union
  - TalentDtoInput
    - `uuid` string
    - `prospects` object[]
      - `uuid` string
      - `email` string, email, required — The email of the prospect
      - `firstName` string, required — The first name of the prospect
      - `middleName` string — The middle name of the prospect
      - `lastName` string — The last name of the prospect
      - `phone` string — The mobile phone of the prospect
      - `homeAddress` object
        - `address1` string — Street number and name of an address
        - `address2` string — Identifies a specific location within the context of address 1
        - `city` string — City name of an address
        - `zip` string — Postal or ZIP code of an address
        - `state` string — State or province code of an address
        - `country` string — Country name of an address
      - `calculatedCustomAttributes` object — The calculated custom attributes of the prospect
      - `csvImportFileUuid` string — The unique identifier of the CSV import file
      - `customAttributes` object[]
        - `customAttributeUuid` string, required — The unique identifier of the custom attribute
        - `value` union, required — The value of the custom attribute
          - string
          - number
          - boolean
      - `dateOfBirth` string — The date of birth of the prospect
      - `filename` string — The filename of the prospect
      - `homePhone` string — The home phone of the prospect
      - `source` 'csv' | 'self-import' — The source of the prospect
      - `timezone` string — The timezone of the prospect
      - `onetV2Skills` object[] — List of onet v2 skills
        - `skill` string, required
        - `category` string
        - `Element ID` string
        - `frequency` number
        - `dataValue` number
        - `evidence` string
      - `schemaVersion` integer — Schema version for migration tracking. Incremented when the sub-document schema changes.
    - `wxWorkers` object[]
      - `wxWorkerUuid` string, required — The unique identifier of the worker
      - `startDate` string — The date and time the worker started
      - `hireDate` string — The date and time the worker was hired
      - `terminationDate` string — The date and time the worker was terminated
      - `jobUuid` string — The unique identifier of the job
      - `employmentStatus` object
        - `type` 'created' | 'preHire' | 'active' | 'rehire' | 'inactive' | 'terminated' | 'temporary', required — The type of the employment status
        - `subtype` 'applicant' | 'employee' | 'leaveOfAbsence' | 'suspended' | 'seasonal' | 'furloughed' | 'resigned' | 'fired' | 'involuntarySeparation' | 'archived' — The subtype of the employment status
        - `lastStatusUpdateDate` string — The date and time the employment status was updated
      - `rehireEligible` boolean — Whether the worker is rehire eligible
      - `customAttributes` object[]
        - `customAttributeUuid` string, required — The unique identifier of the custom attribute
        - `value` string, nullable — The value of the custom attribute
      - `calculatedCustomAttributes` object — The calculated custom attributes of the worker
      - `onetV2Skills` object[] — List of onet v2 skills
        - `skill` string, required
        - `category` string
        - `Element ID` string
        - `frequency` number
        - `dataValue` number
        - `evidence` string
      - `schemaVersion` integer — Schema version for migration tracking. Incremented when the sub-document schema changes.
      - `uuid` string
    - `firstName` string — The first name of the talent
    - `middleName` string — The middle name of the talent
    - `lastName` string — The last name of the talent
    - `displayFullName` string — The display full name of the talent
    - `dateOfBirth` string — The date of birth of the talent
    - `mobilePhone` object
      - `number` string — Phone number
      - `countryCode` string — Country code of a phone number
      - `verified` boolean — Indicator for whether the phone number is verified
    - `homeAddress` object
      - `address1` string — Street number and name of an address
      - `address2` string — Identifies a specific location within the context of address 1
      - `city` string — City name of an address
      - `zip` string — Postal or ZIP code of an address
      - `state` string — State or province code of an address
      - `country` string — Country name of an address
      - `location` object
        - `type` 'Point', required — The type of location
        - `coordinates` number[], required — The coordinates of the location
    - `lastActivityAt` string — The date and time of the most recent Pool-relevant activity for retention
    - `availability` object
      - `monday` string[], required — Availability periods for Monday
      - `tuesday` string[], required — Availability periods for Tuesday
      - `wednesday` string[], required — Availability periods for Wednesday
      - `thursday` string[], required — Availability periods for Thursday
      - `friday` string[], required — Availability periods for Friday
      - `saturday` string[], required — Availability periods for Saturday
      - `sunday` string[], required — Availability periods for Sunday
    - `onetV2SkillsVector` number[] — Vector of onet v2 skills information
    - `primaryCustomValues` object
      - `customAttributes` object[]
        - `type` 'concept' | 'customAttribute' | 'prospect', required — The type of the custom attribute or concept
        - `conceptName` string — The name of the concept
        - `dataKey` string — The key of the data in Hire
        - `values` object[]
          - `rawValue` string, required — The raw value of the concept
          - `conceptOptionUuid` string — The unique identifier of the concept option
          - `label` string, required — The label of the concept option
        - `customAttributeUuid` string, required — The unique identifier of the custom attribute
        - `value` string, nullable — The value of the custom attribute
        - `uploadedAt` string — The date and time the custom attribute or concept was uploaded
      - `calculatedCustomAttributes` object — The calculated custom attributes of the worker
  - TalentDtoInput[]
    - `uuid` string
    - `prospects` object[]
      - `uuid` string
      - `email` string, email, required — The email of the prospect
      - `firstName` string, required — The first name of the prospect
      - `middleName` string — The middle name of the prospect
      - `lastName` string — The last name of the prospect
      - `phone` string — The mobile phone of the prospect
      - `homeAddress` object
        - `address1` string — Street number and name of an address
        - `address2` string — Identifies a specific location within the context of address 1
        - `city` string — City name of an address
        - `zip` string — Postal or ZIP code of an address
        - `state` string — State or province code of an address
        - `country` string — Country name of an address
      - `calculatedCustomAttributes` object — The calculated custom attributes of the prospect
      - `csvImportFileUuid` string — The unique identifier of the CSV import file
      - `customAttributes` object[]
        - `customAttributeUuid` string, required — The unique identifier of the custom attribute
        - `value` union, required — The value of the custom attribute
          - string
          - number
          - boolean
      - `dateOfBirth` string — The date of birth of the prospect
      - `filename` string — The filename of the prospect
      - `homePhone` string — The home phone of the prospect
      - `source` 'csv' | 'self-import' — The source of the prospect
      - `timezone` string — The timezone of the prospect
      - `onetV2Skills` object[] — List of onet v2 skills
        - `skill` string, required
        - `category` string
        - `Element ID` string
        - `frequency` number
        - `dataValue` number
        - `evidence` string
      - `schemaVersion` integer — Schema version for migration tracking. Incremented when the sub-document schema changes.
    - `wxWorkers` object[]
      - `wxWorkerUuid` string, required — The unique identifier of the worker
      - `startDate` string — The date and time the worker started
      - `hireDate` string — The date and time the worker was hired
      - `terminationDate` string — The date and time the worker was terminated
      - `jobUuid` string — The unique identifier of the job
      - `employmentStatus` object
        - `type` 'created' | 'preHire' | 'active' | 'rehire' | 'inactive' | 'terminated' | 'temporary', required — The type of the employment status
        - `subtype` 'applicant' | 'employee' | 'leaveOfAbsence' | 'suspended' | 'seasonal' | 'furloughed' | 'resigned' | 'fired' | 'involuntarySeparation' | 'archived' — The subtype of the employment status
        - `lastStatusUpdateDate` string — The date and time the employment status was updated
      - `rehireEligible` boolean — Whether the worker is rehire eligible
      - `customAttributes` object[]
        - `customAttributeUuid` string, required — The unique identifier of the custom attribute
        - `value` string, nullable — The value of the custom attribute
      - `calculatedCustomAttributes` object — The calculated custom attributes of the worker
      - `onetV2Skills` object[] — List of onet v2 skills
        - `skill` string, required
        - `category` string
        - `Element ID` string
        - `frequency` number
        - `dataValue` number
        - `evidence` string
      - `schemaVersion` integer — Schema version for migration tracking. Incremented when the sub-document schema changes.
      - `uuid` string
    - `firstName` string — The first name of the talent
    - `middleName` string — The middle name of the talent
    - `lastName` string — The last name of the talent
    - `displayFullName` string — The display full name of the talent
    - `dateOfBirth` string — The date of birth of the talent
    - `mobilePhone` object
      - `number` string — Phone number
      - `countryCode` string — Country code of a phone number
      - `verified` boolean — Indicator for whether the phone number is verified
    - `homeAddress` object
      - `address1` string — Street number and name of an address
      - `address2` string — Identifies a specific location within the context of address 1
      - `city` string — City name of an address
      - `zip` string — Postal or ZIP code of an address
      - `state` string — State or province code of an address
      - `country` string — Country name of an address
      - `location` object
        - `type` 'Point', required — The type of location
        - `coordinates` number[], required — The coordinates of the location
    - `lastActivityAt` string — The date and time of the most recent Pool-relevant activity for retention
    - `availability` object
      - `monday` string[], required — Availability periods for Monday
      - `tuesday` string[], required — Availability periods for Tuesday
      - `wednesday` string[], required — Availability periods for Wednesday
      - `thursday` string[], required — Availability periods for Thursday
      - `friday` string[], required — Availability periods for Friday
      - `saturday` string[], required — Availability periods for Saturday
      - `sunday` string[], required — Availability periods for Sunday
    - `onetV2SkillsVector` number[] — Vector of onet v2 skills information
    - `primaryCustomValues` object
      - `customAttributes` object[]
        - `type` 'concept' | 'customAttribute' | 'prospect', required — The type of the custom attribute or concept
        - `conceptName` string — The name of the concept
        - `dataKey` string — The key of the data in Hire
        - `values` object[]
          - `rawValue` string, required — The raw value of the concept
          - `conceptOptionUuid` string — The unique identifier of the concept option
          - `label` string, required — The label of the concept option
        - `customAttributeUuid` string, required — The unique identifier of the custom attribute
        - `value` string, nullable — The value of the custom attribute
        - `uploadedAt` string — The date and time the custom attribute or concept was uploaded
      - `calculatedCustomAttributes` object — The calculated custom attributes of the worker

## Response `201`

One or many talents created.

- object
  - `data` union
    - TalentDto
      - `uuid` string, required — The unique identifier of the talent
      - `companyUuid` string, required — The unique identifier of the company
      - `hireApplicants` object[], required
        - `hireExternalId` string, required — The external identifier of the applicant from Hire
        - `createdAt` string, date-time, required — The date and time the applicant was created
        - `positionUuid` string — The unique identifier of the position
        - `stage` object
          - `type` string — The type of the stage
          - `title` string — The title of the stage
          - `external_id` string — The external identifier of the stage from Hire
        - `rejectionReason` string — Unique identifier of the rejection reason
        - `opening` object
          - `uuid` string, required — The unique identifier of the opening
          - `title` string — The title of the opening
          - `address` object
            - `address1` string — Street number and name of an address
            - `address2` string — Identifies a specific location within the context of address 1
            - `city` string — City name of an address
            - `zip` string — Postal or ZIP code of an address
            - `state` string — State or province code of an address
            - `country` string — Country name of an address
            - `location` object — Longitude and latitude of a location as an object
              - …
          - `jobHours` 'full_time' | 'part_time' — The job hours of the opening
        - `availability` object
          - `monday` string[], required — Availability periods for Monday
          - `tuesday` string[], required — Availability periods for Tuesday
          - `wednesday` string[], required — Availability periods for Wednesday
          - `thursday` string[], required — Availability periods for Thursday
          - `friday` string[], required — Availability periods for Friday
          - `saturday` string[], required — Availability periods for Saturday
          - `sunday` string[], required — Availability periods for Sunday
        - `onetV2Skills` object[] — List of onet v2 skills
          - `skill` string, required
          - `category` string
          - `Element ID` string
          - `frequency` number
          - `dataValue` number
          - `evidence` string
        - `concepts` object[]
          - `conceptUuid` string, required — The unique identifier of the concept
          - `conceptName` string, required — The name of the concept
          - `dataKey` string, required — The key of the data in Hire
          - `values` object[], required
            - `rawValue` string, required — The raw value of the concept
            - `conceptOptionUuid` string — The unique identifier of the concept option
            - `label` string, required — The label of the concept option
        - `structured_data` object — Structured data from the application
        - `data` object — Additional data from the application
        - `aiRecruiterResults` object[] — AI Recruiter interview results from Alpharun
          - `assessmentScore` number
          - `summary` string
          - `strengths` string[]
          - `weaknesses` string[]
          - `assessmentCriteria` object[]
            - `name` string, required
            - `value` union
              - …
            - `commentary` string
          - `dataExtractionFields` object[]
            - `key` string
            - `name` string, required
            - `type` string
            - `value` unknown
            - `commentary` string
          - `transcript` object[]
            - `role` string, required
            - `transcript` string, required
            - `started_at` string
            - `ended_at` string
          - `status` string
          - `startedAt` string
          - `completedAt` string
          - `recordingUrl` string
          - `videoUrl` string
          - `interviewId` string
          - `jobOpeningId` string
        - `schemaVersion` integer — Schema version for migration tracking. Incremented when the sub-document schema changes.
      - `prospects` object[], required
        - `uuid` string, required — The unique identifier of the prospect
        - `email` string, email, required — The email of the prospect
        - `firstName` string, required — The first name of the prospect
        - `middleName` string — The middle name of the prospect
        - `lastName` string — The last name of the prospect
        - `phone` string — The mobile phone of the prospect
        - `homeAddress` object
          - `address1` string — Street number and name of an address
          - `address2` string — Identifies a specific location within the context of address 1
          - `city` string — City name of an address
          - `zip` string — Postal or ZIP code of an address
          - `state` string — State or province code of an address
          - `country` string — Country name of an address
        - `calculatedCustomAttributes` object — The calculated custom attributes of the prospect
        - `csvImportFileUuid` string — The unique identifier of the CSV import file
        - `customAttributes` object[]
          - `customAttributeUuid` string, required — The unique identifier of the custom attribute
          - `value` union, required — The value of the custom attribute
            - string
            - number
            - boolean
        - `dateOfBirth` string — The date of birth of the prospect
        - `filename` string — The filename of the prospect
        - `homePhone` string — The home phone of the prospect
        - `source` 'csv' | 'self-import' — The source of the prospect
        - `timezone` string — The timezone of the prospect
        - `uploadedAt` string — The date and time the prospect was uploaded
        - `uploadedBy` string — The unique identifier of the user who uploaded the prospect
        - `onetV2Skills` object[] — List of onet v2 skills
          - `skill` string, required
          - `category` string
          - `Element ID` string
          - `frequency` number
          - `dataValue` number
          - `evidence` string
        - `schemaVersion` integer — Schema version for migration tracking. Incremented when the sub-document schema changes.
      - `wxWorkers` object[], required
        - `wxWorkerUuid` string, required — The unique identifier of the worker
        - `startDate` string — The date and time the worker started
        - `hireDate` string — The date and time the worker was hired
        - `terminationDate` string — The date and time the worker was terminated
        - `jobUuid` string — The unique identifier of the job
        - `employmentStatus` object
          - `type` 'created' | 'preHire' | 'active' | 'rehire' | 'inactive' | 'terminated' | 'temporary', required — The type of the employment status
          - `subtype` 'applicant' | 'employee' | 'leaveOfAbsence' | 'suspended' | 'seasonal' | 'furloughed' | 'resigned' | 'fired' | 'involuntarySeparation' | 'archived' — The subtype of the employment status
          - `lastStatusUpdateDate` string — The date and time the employment status was updated
        - `rehireEligible` boolean — Whether the worker is rehire eligible
        - `customAttributes` object[]
          - `customAttributeUuid` string, required — The unique identifier of the custom attribute
          - `value` string, nullable — The value of the custom attribute
        - `calculatedCustomAttributes` object — The calculated custom attributes of the worker
        - `onetV2Skills` object[] — List of onet v2 skills
          - `skill` string, required
          - `category` string
          - `Element ID` string
          - `frequency` number
          - `dataValue` number
          - `evidence` string
        - `schemaVersion` integer — Schema version for migration tracking. Incremented when the sub-document schema changes.
      - `createdAt` string, date-time, required — The date and time the talent was created
      - `createdBy` string, required — The unique identifier of the user who created the talent
      - `updatedAt` string, date-time, required — The date and time the talent was updated
      - `updatedBy` string, required — The unique identifier of the user who updated the talent
      - `personalEmail` object, required
        - `email` string, email, required — The email of the talent
        - `verified` boolean — Flag for indicating if the email is verified
      - `primaryContactUuid` string — The unique identifier of the primary contact
      - `exclusions` object
        - `activeApplicants` boolean — Flag for excluding active applicants
        - `approvedApplicants` boolean — Flag for excluding approved applicants (HiredStage)
        - `onHoldApplicants` boolean — Flag for excluding applicants on hold (ArchivedStage)
        - `rejectedApplicants` boolean — Flag for excluding rejected applicants (RejectedStage)
        - `applicantRejectionReasons` object[]
          - `rejectionReason` string — The reason for the rejection
          - `hireRejectionReasonUuid` string — The unique identifier of the rejection reason in Hire
        - `workerSegments` object[]
          - `workerSegmentUuid` string — The unique identifier of the worker segment
          - `workerSegmentName` string — The name of the worker segment
        - `customConditions` object[]
          - `conceptUuid` string — The unique identifier of the concept
          - `operator` 'is' | 'isNot' — The operator of the concept
          - `value` string[] — The value of the concept
        - `retentionExpired` boolean — When true, the talent is outside the configured Pool data retention window
        - `smsMarketingOptOut` boolean — When true, the talent's most recent applicant record explicitly opted out of SMS marketing
      - `isHidden` boolean — Flag for hiding the talent
      - `unsubscribedAt` string — The date and time the talent was unsubscribed
      - `skills` string[] — The v1 list of skills of the talent
      - `isCurrentlyEmployed` boolean — Flag for indicating if the talent is currently employed
      - `firstName` string — The first name of the talent
      - `middleName` string — The middle name of the talent
      - `lastName` string — The last name of the talent
      - `displayFullName` string — The display full name of the talent
      - `dateOfBirth` string — The date of birth of the talent
      - `mobilePhone` object
        - `number` string — Phone number
        - `countryCode` string — Country code of a phone number
        - `verified` boolean — Indicator for whether the phone number is verified
        - `verifiedAt` string — Date the phone number was verified
      - `homeAddress` object
        - `address1` string — Street number and name of an address
        - `address2` string — Identifies a specific location within the context of address 1
        - `city` string — City name of an address
        - `zip` string — Postal or ZIP code of an address
        - `state` string — State or province code of an address
        - `country` string — Country name of an address
        - `location` object
          - `type` 'Point', required — The type of location
          - `coordinates` number[], required — The coordinates of the location
      - `audienceUuids` string[] — The unique identifiers of the audiences
      - `archivedAt` string — The date and time the talent was archived
      - `audienceCampaignStats` object
      - `aggregatedCampaignStats` object
        - `total` number, required — The total number of messages
        - `sent` number, required — The number of messages sent
        - `delivered` number, required — The number of messages delivered
        - `opened` number, required — The number of messages opened
        - `clicked` number, required — The number of messages clicked
        - `unsubscribed` number — The number of messages that resulted in an unsubscribe
      - `aggregatedCampaignCalculatedStats` object
        - `deliveryRate` number, required — The delivery rate of the campaign
        - `openRate` number, required — The open rate of the campaign
        - `clickRate` number, required — The click rate of the campaign
        - `bounceRate` number, required — The bounce rate of the campaign
        - `unsubscribeRate` number — The unsubscribe rate of the campaign (unsubscribed / delivered)
      - `talentType` 'worker' | 'applicant' | 'prospect' — The type of talent
      - `statsLastInteraction` string — The date and time the last interaction was made
      - `lastActivityAt` string — The date and time of the most recent Pool-relevant activity for retention
      - `retentionExpiresAt` string, date-time — UTC instant when Pool data retention eligibility ends for this talent, derived from the company match-setting window and last qualifying activity
      - `availability` object
        - `monday` string[], required — Availability periods for Monday
        - `tuesday` string[], required — Availability periods for Tuesday
        - `wednesday` string[], required — Availability periods for Wednesday
        - `thursday` string[], required — Availability periods for Thursday
        - `friday` string[], required — Availability periods for Friday
        - `saturday` string[], required — Availability periods for Saturday
        - `sunday` string[], required — Availability periods for Sunday
      - `availabilityShiftVector` number[] — Vector of availability information
      - `score` number — The match score of the talent, ranging from 0 to 1
      - `onetV2SkillsVector` number[] — Vector of onet v2 skills information
      - `primaryCustomValues` object
        - `customAttributes` object[]
          - `type` 'concept' | 'customAttribute' | 'prospect', required — The type of the custom attribute or concept
          - `conceptName` string — The name of the concept
          - `dataKey` string — The key of the data in Hire
          - `values` object[]
            - `rawValue` string, required — The raw value of the concept
            - `conceptOptionUuid` string — The unique identifier of the concept option
            - `label` string, required — The label of the concept option
          - `customAttributeUuid` string, required — The unique identifier of the custom attribute
          - `value` string, nullable — The value of the custom attribute
          - `uploadedAt` string — The date and time the custom attribute or concept was uploaded
        - `calculatedCustomAttributes` object — The calculated custom attributes of the worker
      - `schemaVersion` integer — Schema version for migration tracking. Incremented when the talent document schema changes.
    - TalentDto[]
      - `uuid` string, required — The unique identifier of the talent
      - `companyUuid` string, required — The unique identifier of the company
      - `hireApplicants` object[], required
        - `hireExternalId` string, required — The external identifier of the applicant from Hire
        - `createdAt` string, date-time, required — The date and time the applicant was created
        - `positionUuid` string — The unique identifier of the position
        - `stage` object
          - `type` string — The type of the stage
          - `title` string — The title of the stage
          - `external_id` string — The external identifier of the stage from Hire
        - `rejectionReason` string — Unique identifier of the rejection reason
        - `opening` object
          - `uuid` string, required — The unique identifier of the opening
          - `title` string — The title of the opening
          - `address` object
            - `address1` string — Street number and name of an address
            - `address2` string — Identifies a specific location within the context of address 1
            - `city` string — City name of an address
            - `zip` string — Postal or ZIP code of an address
            - `state` string — State or province code of an address
            - `country` string — Country name of an address
            - `location` object — Longitude and latitude of a location as an object
              - …
          - `jobHours` 'full_time' | 'part_time' — The job hours of the opening
        - `availability` object
          - `monday` string[], required — Availability periods for Monday
          - `tuesday` string[], required — Availability periods for Tuesday
          - `wednesday` string[], required — Availability periods for Wednesday
          - `thursday` string[], required — Availability periods for Thursday
          - `friday` string[], required — Availability periods for Friday
          - `saturday` string[], required — Availability periods for Saturday
          - `sunday` string[], required — Availability periods for Sunday
        - `onetV2Skills` object[] — List of onet v2 skills
          - `skill` string, required
          - `category` string
          - `Element ID` string
          - `frequency` number
          - `dataValue` number
          - `evidence` string
        - `concepts` object[]
          - `conceptUuid` string, required — The unique identifier of the concept
          - `conceptName` string, required — The name of the concept
          - `dataKey` string, required — The key of the data in Hire
          - `values` object[], required
            - `rawValue` string, required — The raw value of the concept
            - `conceptOptionUuid` string — The unique identifier of the concept option
            - `label` string, required — The label of the concept option
        - `structured_data` object — Structured data from the application
        - `data` object — Additional data from the application
        - `aiRecruiterResults` object[] — AI Recruiter interview results from Alpharun
          - `assessmentScore` number
          - `summary` string
          - `strengths` string[]
          - `weaknesses` string[]
          - `assessmentCriteria` object[]
            - `name` string, required
            - `value` union
              - …
            - `commentary` string
          - `dataExtractionFields` object[]
            - `key` string
            - `name` string, required
            - `type` string
            - `value` unknown
            - `commentary` string
          - `transcript` object[]
            - `role` string, required
            - `transcript` string, required
            - `started_at` string
            - `ended_at` string
          - `status` string
          - `startedAt` string
          - `completedAt` string
          - `recordingUrl` string
          - `videoUrl` string
          - `interviewId` string
          - `jobOpeningId` string
        - `schemaVersion` integer — Schema version for migration tracking. Incremented when the sub-document schema changes.
      - `prospects` object[], required
        - `uuid` string, required — The unique identifier of the prospect
        - `email` string, email, required — The email of the prospect
        - `firstName` string, required — The first name of the prospect
        - `middleName` string — The middle name of the prospect
        - `lastName` string — The last name of the prospect
        - `phone` string — The mobile phone of the prospect
        - `homeAddress` object
          - `address1` string — Street number and name of an address
          - `address2` string — Identifies a specific location within the context of address 1
          - `city` string — City name of an address
          - `zip` string — Postal or ZIP code of an address
          - `state` string — State or province code of an address
          - `country` string — Country name of an address
        - `calculatedCustomAttributes` object — The calculated custom attributes of the prospect
        - `csvImportFileUuid` string — The unique identifier of the CSV import file
        - `customAttributes` object[]
          - `customAttributeUuid` string, required — The unique identifier of the custom attribute
          - `value` union, required — The value of the custom attribute
            - string
            - number
            - boolean
        - `dateOfBirth` string — The date of birth of the prospect
        - `filename` string — The filename of the prospect
        - `homePhone` string — The home phone of the prospect
        - `source` 'csv' | 'self-import' — The source of the prospect
        - `timezone` string — The timezone of the prospect
        - `uploadedAt` string — The date and time the prospect was uploaded
        - `uploadedBy` string — The unique identifier of the user who uploaded the prospect
        - `onetV2Skills` object[] — List of onet v2 skills
          - `skill` string, required
          - `category` string
          - `Element ID` string
          - `frequency` number
          - `dataValue` number
          - `evidence` string
        - `schemaVersion` integer — Schema version for migration tracking. Incremented when the sub-document schema changes.
      - `wxWorkers` object[], required
        - `wxWorkerUuid` string, required — The unique identifier of the worker
        - `startDate` string — The date and time the worker started
        - `hireDate` string — The date and time the worker was hired
        - `terminationDate` string — The date and time the worker was terminated
        - `jobUuid` string — The unique identifier of the job
        - `employmentStatus` object
          - `type` 'created' | 'preHire' | 'active' | 'rehire' | 'inactive' | 'terminated' | 'temporary', required — The type of the employment status
          - `subtype` 'applicant' | 'employee' | 'leaveOfAbsence' | 'suspended' | 'seasonal' | 'furloughed' | 'resigned' | 'fired' | 'involuntarySeparation' | 'archived' — The subtype of the employment status
          - `lastStatusUpdateDate` string — The date and time the employment status was updated
        - `rehireEligible` boolean — Whether the worker is rehire eligible
        - `customAttributes` object[]
          - `customAttributeUuid` string, required — The unique identifier of the custom attribute
          - `value` string, nullable — The value of the custom attribute
        - `calculatedCustomAttributes` object — The calculated custom attributes of the worker
        - `onetV2Skills` object[] — List of onet v2 skills
          - `skill` string, required
          - `category` string
          - `Element ID` string
          - `frequency` number
          - `dataValue` number
          - `evidence` string
        - `schemaVersion` integer — Schema version for migration tracking. Incremented when the sub-document schema changes.
      - `createdAt` string, date-time, required — The date and time the talent was created
      - `createdBy` string, required — The unique identifier of the user who created the talent
      - `updatedAt` string, date-time, required — The date and time the talent was updated
      - `updatedBy` string, required — The unique identifier of the user who updated the talent
      - `personalEmail` object, required
        - `email` string, email, required — The email of the talent
        - `verified` boolean — Flag for indicating if the email is verified
      - `primaryContactUuid` string — The unique identifier of the primary contact
      - `exclusions` object
        - `activeApplicants` boolean — Flag for excluding active applicants
        - `approvedApplicants` boolean — Flag for excluding approved applicants (HiredStage)
        - `onHoldApplicants` boolean — Flag for excluding applicants on hold (ArchivedStage)
        - `rejectedApplicants` boolean — Flag for excluding rejected applicants (RejectedStage)
        - `applicantRejectionReasons` object[]
          - `rejectionReason` string — The reason for the rejection
          - `hireRejectionReasonUuid` string — The unique identifier of the rejection reason in Hire
        - `workerSegments` object[]
          - `workerSegmentUuid` string — The unique identifier of the worker segment
          - `workerSegmentName` string — The name of the worker segment
        - `customConditions` object[]
          - `conceptUuid` string — The unique identifier of the concept
          - `operator` 'is' | 'isNot' — The operator of the concept
          - `value` string[] — The value of the concept
        - `retentionExpired` boolean — When true, the talent is outside the configured Pool data retention window
        - `smsMarketingOptOut` boolean — When true, the talent's most recent applicant record explicitly opted out of SMS marketing
      - `isHidden` boolean — Flag for hiding the talent
      - `unsubscribedAt` string — The date and time the talent was unsubscribed
      - `skills` string[] — The v1 list of skills of the talent
      - `isCurrentlyEmployed` boolean — Flag for indicating if the talent is currently employed
      - `firstName` string — The first name of the talent
      - `middleName` string — The middle name of the talent
      - `lastName` string — The last name of the talent
      - `displayFullName` string — The display full name of the talent
      - `dateOfBirth` string — The date of birth of the talent
      - `mobilePhone` object
        - `number` string — Phone number
        - `countryCode` string — Country code of a phone number
        - `verified` boolean — Indicator for whether the phone number is verified
        - `verifiedAt` string — Date the phone number was verified
      - `homeAddress` object
        - `address1` string — Street number and name of an address
        - `address2` string — Identifies a specific location within the context of address 1
        - `city` string — City name of an address
        - `zip` string — Postal or ZIP code of an address
        - `state` string — State or province code of an address
        - `country` string — Country name of an address
        - `location` object
          - `type` 'Point', required — The type of location
          - `coordinates` number[], required — The coordinates of the location
      - `audienceUuids` string[] — The unique identifiers of the audiences
      - `archivedAt` string — The date and time the talent was archived
      - `audienceCampaignStats` object
      - `aggregatedCampaignStats` object
        - `total` number, required — The total number of messages
        - `sent` number, required — The number of messages sent
        - `delivered` number, required — The number of messages delivered
        - `opened` number, required — The number of messages opened
        - `clicked` number, required — The number of messages clicked
        - `unsubscribed` number — The number of messages that resulted in an unsubscribe
      - `aggregatedCampaignCalculatedStats` object
        - `deliveryRate` number, required — The delivery rate of the campaign
        - `openRate` number, required — The open rate of the campaign
        - `clickRate` number, required — The click rate of the campaign
        - `bounceRate` number, required — The bounce rate of the campaign
        - `unsubscribeRate` number — The unsubscribe rate of the campaign (unsubscribed / delivered)
      - `talentType` 'worker' | 'applicant' | 'prospect' — The type of talent
      - `statsLastInteraction` string — The date and time the last interaction was made
      - `lastActivityAt` string — The date and time of the most recent Pool-relevant activity for retention
      - `retentionExpiresAt` string, date-time — UTC instant when Pool data retention eligibility ends for this talent, derived from the company match-setting window and last qualifying activity
      - `availability` object
        - `monday` string[], required — Availability periods for Monday
        - `tuesday` string[], required — Availability periods for Tuesday
        - `wednesday` string[], required — Availability periods for Wednesday
        - `thursday` string[], required — Availability periods for Thursday
        - `friday` string[], required — Availability periods for Friday
        - `saturday` string[], required — Availability periods for Saturday
        - `sunday` string[], required — Availability periods for Sunday
      - `availabilityShiftVector` number[] — Vector of availability information
      - `score` number — The match score of the talent, ranging from 0 to 1
      - `onetV2SkillsVector` number[] — Vector of onet v2 skills information
      - `primaryCustomValues` object
        - `customAttributes` object[]
          - `type` 'concept' | 'customAttribute' | 'prospect', required — The type of the custom attribute or concept
          - `conceptName` string — The name of the concept
          - `dataKey` string — The key of the data in Hire
          - `values` object[]
            - `rawValue` string, required — The raw value of the concept
            - `conceptOptionUuid` string — The unique identifier of the concept option
            - `label` string, required — The label of the concept option
          - `customAttributeUuid` string, required — The unique identifier of the custom attribute
          - `value` string, nullable — The value of the custom attribute
          - `uploadedAt` string — The date and time the custom attribute or concept was uploaded
        - `calculatedCustomAttributes` object — The calculated custom attributes of the worker
      - `schemaVersion` integer — Schema version for migration tracking. Incremented when the talent document schema changes.
  - `meta` ResponsesPartMeta
    - `timestamp` string, date-time, required
    - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
    - `path` string
    - `jti` string
    - `rid` string
    - `count` number
    - `status` string
    - `duration` number
    - `size` number

## Other responses

- `422` — default error response
- `500` — default error response

---

[API](https://skmtc.net/fountain/apis/hire-public-api.md) · [All operations](https://skmtc.net/fountain/apis/hire-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/fountain/hire-public-api/versions/5f406c0e9462/schema)
