v1
latestOpenAPI 3.0.12026-07-245752052.0 MBtalent
fetch list of talent
Returns visible talent only by default (isHidden is not true and archivedAt does not exist). Pass onlyReturnHiddenTalent=true to return only hidden talent instead, or includeHidden=true to return BOTH visible and hidden talent (archived still excluded).
get/api/servicepool/talents
Query parameters
{
"limit": 10,
"order": [
"prop DESC"
]
}{
"matchThreshold": 60,
"matchType": "Job",
"matchUuid": "123e4567-e89b-12d3-a456-426614174000"
}{
"distance": 1,
"unit": "mile",
"locationUuid": "123e4567-e89b-12d3-a456-426614174000"
}audienceCampaignUuidstring uuid
onlyReturnHiddenTalentboolean
When true, returns only hidden talent (isHidden: true). Defaults to false, which returns only visible, non-archived talent.
includeHiddenboolean
When true, returns both visible AND hidden talent (archived still excluded). Ignored when onlyReturnHiddenTalent=true.
audienceUuidstring uuid
Restrict results to talents in this audience. With includeHidden=true, membership is resolved from talentAudienceHistory so hidden talents that lost their audienceUuids still appear.
Response
list of talent
Example response
{
"data": [
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"companyUuid": "123e4567-e89b-12d3-a456-426614174000",
"hireApplicants": [
{
"hireExternalId": "123e4567-e89b-12d3-a456-426614174000",
"createdAt": "2025-08-25T16:53:13.000Z",
"positionUuid": "123e4567-e89b-12d3-a456-426614174000",
"stage": {
"type": "HiredStage",
"title": "Hired",
"external_id": "123e4567-e89b-12d3-a456-426614174000"
},
"rejectionReason": "123e4567-e89b-12d3-a456-426614174000",
"opening": {
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"title": "Software Engineer",
"address": {
"address1": "275 Sacramento St.",
"address2": "Building 5, Apt B",
"city": "San Francisco",
"zip": "94105",
"state": "CA",
"country": "US",
"location": {
"type": "Point",
"coordinates": [
-122.39862,
37.79438
]
}
},
"jobHours": "full_time"
},
"availability": {
"monday": [
"morning",
"afternoon"
],
"tuesday": [
"morning",
"afternoon"
],
"wednesday": [
"morning",
"afternoon"
],
"thursday": [
"morning",
"afternoon"
],
"friday": [
"morning",
"afternoon"
],
"saturday": [
"morning",
"afternoon"
],
"sunday": [
"morning",
"afternoon"
]
},
"onetV2Skills": [
{
"skill": "Skill 1",
"category": "Category 1",
"Element ID": "Element 1",
"frequency": 1,
"dataValue": 0.8,
"evidence": "Evidence text"
}
],
"concepts": [
{
"conceptUuid": "123e4567-e89b-12d3-a456-426614174000",
"conceptName": "Gender",
"dataKey": "gender",
"values": [
{
"rawValue": "MALE",
"conceptOptionUuid": "123e4567-e89b-12d3-a456-426614174000",
"label": "Male"
}
]
}
],
"schemaVersion": 1
}
],
"prospects": [
{
"uuid": "123e4567-e89b-12d3-a456-426614174000",
"email": "john.doe@example.com",
"firstName": "John",
"middleName": "William",
"lastName": "Doe",
"phone": "+1234567890",
"homeAddress": {
"address1": "275 Sacramento St.",
"address2": "Building 5, Apt B",
"city": "San Francisco",
"zip": "94105",
"state": "CA",
"country": "US"
},
"csvImportFileUuid": "123e4567-e89b-12d3-a456-426614174000",
"customAttributes": [
{
"customAttributeUuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"dateOfBirth": "1990-01-01",
"filename": "prospects.csv",
"homePhone": "+1234567890",
"source": "csv",
"timezone": "America/New_York",
"uploadedAt": "2025-09-09T10:58:17.451+00:00",
"uploadedBy": "123e4567-e89b-12d3-a456-426614174000",
"onetV2Skills": [
{
"skill": "Skill 1",
"category": "Category 1",
"Element ID": "Element 1",
"frequency": 1,
"dataValue": 0.8,
"evidence": "Evidence text"
}
],
"schemaVersion": 1
}
],
"wxWorkers": [
{
"wxWorkerUuid": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-09-09T10:58:17.451+00:00",
"hireDate": "2025-09-09T10:58:17.451+00:00",
"terminationDate": "2025-09-09T10:58:17.451+00:00",
"jobUuid": "123e4567-e89b-12d3-a456-426614174000",
"employmentStatus": {
"type": "created",
"subtype": "applicant",
"lastStatusUpdateDate": "2025-09-08T21:22:26.958+00:00"
},
"rehireEligible": true,
"customAttributes": [
{
"customAttributeUuid": "123e4567-e89b-12d3-a456-426614174000",
"value": "San Francisco"
}
],
"onetV2Skills": [
{
"skill": "Skill 1",
"category": "Category 1",
"Element ID": "Element 1",
"frequency": 1,
"dataValue": 0.8,
"evidence": "Evidence text"
}
],
"schemaVersion": 1
}
],
"createdAt": "2025-09-09T10:58:17.451Z",
"createdBy": "123e4567-e89b-12d3-a456-426614174000",
"updatedAt": "2025-09-09T10:58:17.451Z",
"updatedBy": "123e4567-e89b-12d3-a456-426614174000",
"personalEmail": {
"email": "john.doe@example.com",
"verified": true
},
"primaryContactUuid": "123e4567-e89b-12d3-a456-426614174000",
"exclusions": {
"activeApplicants": true,
"applicantRejectionReasons": [
{
"rejectionReason": "Not a good fit",
"hireRejectionReasonUuid": "123e4567-e89b-12d3-a456-426614174000"
}
],
"workerSegments": [
{
"workerSegmentUuid": "123e4567-e89b-12d3-a456-426614174000",
"workerSegmentName": "Workers in Houston"
}
],
"customConditions": [
{
"conceptUuid": "123e4567-e89b-12d3-a456-426614174000",
"operator": "is",
"value": [
"I_IDENTIFY_AS_ONE_OR_MORE_OF_THE_CLASSIFICATIONS_OF_A_PROTECTED_VETERAN"
]
}
]
},
"unsubscribedAt": "2025-09-09T10:58:17.451+00:00",
"skills": [
"Oral expression",
"Written expression"
],
"isCurrentlyEmployed": true,
"firstName": "William",
"middleName": "William",
"lastName": "Doe",
"displayFullName": "John Doe",
"dateOfBirth": "1990-01-01",
"mobilePhone": {
"number": "2484345508",
"countryCode": "+1",
"verified": true,
"verifiedAt": "2023-06-28"
},
"homeAddress": {
"address1": "275 Sacramento St.",
"address2": "Building 5, Apt B",
"city": "San Francisco",
"zip": "94105",
"state": "CA",
"country": "US",
"location": {
"type": "Point",
"coordinates": [
-122.39862,
37.79438
]
}
},
"audienceUuids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"archivedAt": "2025-09-09T10:58:17.451+00:00",
"aggregatedCampaignStats": {
"total": 100,
"sent": 100,
"delivered": 100,
"opened": 100,
"clicked": 100,
"unsubscribed": 5
},
"aggregatedCampaignCalculatedStats": {
"deliveryRate": 100,
"openRate": 100,
"clickRate": 100,
"bounceRate": 100,
"unsubscribeRate": 5
},
"talentType": "prospect",
"statsLastInteraction": "2025-09-09T10:58:17.451+00:00",
"lastActivityAt": "2025-09-09T10:58:17.451+00:00",
"retentionExpiresAt": "2027-09-09T10:58:17.451Z",
"availability": {
"monday": [
"morning",
"afternoon"
],
"tuesday": [
"morning",
"afternoon"
],
"wednesday": [
"morning",
"afternoon"
],
"thursday": [
"morning",
"afternoon"
],
"friday": [
"morning",
"afternoon"
],
"saturday": [
"morning",
"afternoon"
],
"sunday": [
"morning",
"afternoon"
]
},
"score": 0.5,
"primaryCustomValues": {
"customAttributes": [
{
"type": "concept",
"conceptName": "Gender",
"dataKey": "gender",
"values": [
{
"rawValue": "MALE",
"conceptOptionUuid": "123e4567-e89b-12d3-a456-426614174000",
"label": "Male"
}
],
"customAttributeUuid": "123e4567-e89b-12d3-a456-426614174000",
"value": "San Francisco",
"uploadedAt": "2025-09-09T10:58:17.451+00:00"
}
]
},
"schemaVersion": 1
}
]
}