FOfountain
talent

Count talent

Counts visible talent only by default (isHidden is not true and archivedAt is null). Pass onlyReturnHiddenTalent=true to count only hidden talent instead, or includeHidden=true to count BOTH visible and hidden talent (archived still excluded). For Match Score counts, vectors[matchUuid] takes the Pool entity's own uuid (for matchType Opening, a Hire funnel id is also resolved via the opening's hireExternalId); an identifier found in neither space is rejected as a 400 naming the unresolvable id. averageScore is DEPRECATED here and returns null unless the query carries vectors — use GET /talents/averageScore instead. It stays in this response for one release so existing consumers keep parsing. Removing it is also what moves the Average Match tile in the talent table onto GET /talents/averageScore; until then the tile reads it here, because the count computes the number inside a vector search it is already running. The filter lists common fields; any talent field works.

get/api/servicepool/talents/count

Request

  • Base URL
    https://services.fountain.com
  • URL
    https://services.fountain.com/api/servicepool/talents/count
  • Auth
    HTTP bearer

Query parameters

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

The match threshold of the job match vector, as a percent from 0 to 100

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.

searchstring

Free-text search across talent name, email and phone — matches the search parameter on GET /talents. Bounded to 200 characters.

unread'1'

The Unread messages condition: only talent with unread SMS replies. Ignored while two-way SMS is off for the company; 403 for a role without the campaign conversation read action.

campaignRecipients'all' | 'receiving' | 'excluded'

Which of the campaign's recipients to count; needs audienceCampaignUuid (400 without it). Same views as GET /talents, so the count beside each tab matches its rows.

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

Changes

No recorded changes to this operation across all 1 revision of this API.