HiringCenter Pro
HiringCenter Pro API

Prospects

Endpoint:https://api.hiringcenterpro.com/v2

Operations for managing prospects.

List Prospects

GET
https://api.hiringcenterpro.com/v2
/prospects

List Prospects › query Parameters

  • emailstring
  • phonestring
  • namestring
  • titlestring
  • companystring
  • stagestring
  • labelstring
  • limitinteger
    Default: 1

List Prospects › Headers

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

List Prospects › Responses

OK

  • prospectsobject[]
  • totalCountinteger

Create or Update Prospect

POST
https://api.hiringcenterpro.com/v2
/prospects

Create or Update Prospect › Headers

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Create or Update Prospect › Request Body

  • firstNamestring · required
  • lastNamestring · required
  • emailstring · email
  • phonestring
  • stageIdstring
  • pipelineIdstring
  • licenseStatusstring
  • labelsstring[]
  • notesstring
  • titlestring
  • companystring
  • userIdstring
  • streetAddressstring
  • citystring
  • statestring
  • postalCodestring
  • officestring
  • sourcestring
  • newSourceNamestring
  • resumeobject
  • muteWebhookboolean
  • jobIdstring
  • updateboolean
    Default: false

Create or Update Prospect › Responses

Existing prospect returned or updated

  • idstring
  • firstNamestring
  • lastNamestring
  • emailstring | null · email
  • phonestring | null
  • currentStagestring | null
  • currentStageIdstring | null
  • labelsstring[]
  • titlestring | null
  • companystring | null
  • createdAtinteger | null · int64
  • updatedAtinteger | null · int64
Additional properties are allowed

Get Specific Prospect

GET
https://api.hiringcenterpro.com/v2
/prospects/{prospectId}

Get Specific Prospect › path Parameters

  • prospectIdstring · required

Get Specific Prospect › Headers

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Get Specific Prospect › Responses

OK

  • idstring
  • firstNamestring
  • lastNamestring
  • emailstring | null · email
  • phonestring | null
  • currentStagestring | null
  • currentStageIdstring | null
  • labelsstring[]
  • titlestring | null
  • companystring | null
  • createdAtinteger | null · int64
  • updatedAtinteger | null · int64
Additional properties are allowed

Delete Prospect

DELETE
https://api.hiringcenterpro.com/v2
/prospects/{prospectId}

Delete Prospect › path Parameters

  • prospectIdstring · required

Delete Prospect › Headers

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Delete Prospect › Request Body

  • userIdstring · required

Delete Prospect › Responses

Deleted

  • messagestring
  • prospectIdstring

Update Prospect (by ID in URL)

PATCH
https://api.hiringcenterpro.com/v2
/prospects/{prospectId}

Update Prospect (by ID in URL) › path Parameters

  • prospectIdstring · required

Update Prospect (by ID in URL) › Headers

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Update Prospect (by ID in URL) › Request Body

  • userIdstring · required
  • updatesobject · required

Update Prospect (by ID in URL) › Responses

Updated

  • idstring
  • firstNamestring
  • lastNamestring
  • emailstring | null · email
  • phonestring | null
  • currentStagestring | null
  • currentStageIdstring | null
  • labelsstring[]
  • titlestring | null
  • companystring | null
  • createdAtinteger | null · int64
  • updatedAtinteger | null · int64
Additional properties are allowed
Notes