v1

latestOpenAPI 3.0.12026-07-245752052.0 MB
talent

Count talent

Counts visible talent only by default (isHidden is not true and archivedAt does not exist). Pass onlyReturnHiddenTalent=true to count only hidden talent instead, or includeHidden=true to count BOTH visible and hidden talent (archived still excluded).

get/api/servicepool/talents/count

Query parameters

whereParametersFilterWhere
fieldsParametersFilterFields
limitnumber
skipnumber
orderstring[]
{
  "limit": 10,
  "order": [
    "prop DESC"
  ]
}
matchThresholdnumber required

The match threshold of the job match vector

matchType'Job' | 'Opening' required

The match type of the job match vector

matchUuidstring required

The unique identifier of the job match vector

{
  "matchThreshold": 60,
  "matchType": "Job",
  "matchUuid": "123e4567-e89b-12d3-a456-426614174000"
}
distancenumber required

The numeric distance from location

unit'mile' | 'kilometer' required

The unit of measurement

locationUuidstring required

The unique identifier of the location to check distance against

{
  "distance": 1,
  "unit": "mile",
  "locationUuid": "123e4567-e89b-12d3-a456-426614174000"
}
audienceCampaignUuidstring uuid
onlyReturnHiddenTalentboolean

When true, counts only hidden talent (isHidden: true). Defaults to false, which counts only visible, non-archived talent.

includeHiddenboolean

When true, counts both visible AND hidden talent (archived still excluded). Ignored when onlyReturnHiddenTalent=true.

audienceUuidstring uuid

Restrict counts to talents in this audience. With includeHidden=true, membership is resolved from talentAudienceHistory so hidden talents that lost their audienceUuids still count.

Response

Fetch a count of talent

Example response

{
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}