HiringCenter
HiringCenter API

Prospects

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

Create, update, list, and manage prospects

List Prospects

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

Accepts optional query filters, returns matching prospects, and includes a total count for pagination-style clients. When no matches are found, returns 200 with an empty prospects array and totalCount: 0. When multiple labels are provided, results include prospects that match any of those labels.

List Prospects › query Parameters

  • emailstring
  • phonestring
  • namestring
  • titlestring
  • companystring
  • stagestring
  • labelstyle: form · explode: true

    Optional. Filter by label(s). Supports repeated query params (?label=Hot&label=Inbound) or a comma-separated value (?label=Hot,Inbound). Matches prospects that contain any provided label. Up to 10 labels.

  • limitinteger
    Default: 1

List Prospects › Responses

OK

  • prospectsobject[]
  • totalCountinteger

Create or Update Prospect

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

Accepts prospect profile fields, creates or updates a prospect, and returns the created or matched prospect record. If phone is invalid, the request can still succeed; in that case the response includes a message warning and phone may be null.

Create or Update Prospect › Request Body

  • firstNamestring · required

    Prospect first name.

  • lastNamestring · required

    Prospect last name.

  • emailstring · email

    Prospect email address.

  • phonestring

    Prospect phone number.

  • stageIdstring

    Optional stage ID to place the prospect in. When provided, this takes precedence over pipelineId.

  • pipelineIdstring

    Optional pipeline ID used only when stageId is omitted. The prospect is routed to that pipeline's configured default stage.

  • licenseStatusstring · enum

    License status for the prospect.

    Enum values:
    not_started
    in_progress
    licensed
  • labels

    Optional labels to attach to the prospect. Accepts either a comma-separated string or an array of strings.

  • notesstring

    Optional plain-text notes for the prospect profile.

  • titlestring

    Prospect job title.

  • companystring

    Prospect company name.

  • userIdstring

    User id performing the create/update operation.

  • streetAddressstring

    Prospect street address.

  • citystring

    Prospect city.

  • statestring

    Prospect state or region.

  • postalCodestring

    Prospect postal/zip code.

  • officeIdstring

    Optional office id to associate with the prospect.

  • sourceIdstring

    Existing source id to associate with the prospect.

  • newSourceNamestring

    New source name to create/use when sourceId is not provided.

  • resumeobject

    Optional resume payload for parsing and storage.

  • muteWebhookboolean

    If true, suppresses outbound webhook notifications for this write.

  • jobIdstring

    Optional job id used to link this prospect to a job.

  • updateboolean

    If true, update an existing matching prospect instead of creating a new one.

    Default: false

Create or Update Prospect › Responses

Existing prospect returned or updated

  • idstring
  • messagestring | null

    Optional success message. Can include a warning when submitted phone data is invalid (for example, NANP area code/exchange starts with 0 or 1) and the prospect is still created/updated.

  • firstNamestring
  • lastNamestring
  • emailstring | null · email
  • phonestring | null
  • currentStagestring | null
  • currentStageIdstring | null
  • pipelineIdstring | null
  • labelsstring[]
  • titlestring | null
  • companystring | null
  • createdAtinteger | null · int64

    Unix timestamp in milliseconds

  • updatedAtinteger | null · int64

    Unix timestamp in milliseconds

Additional properties are allowed

Get Prospect by ID

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

Accepts a required prospectId path parameter, fetches that specific prospect, and returns the full prospect object when found.

Get Prospect by ID › path Parameters

  • prospectIdstring · required

Get Prospect by ID › Responses

OK

  • idstring
  • messagestring | null

    Optional success message. Can include a warning when submitted phone data is invalid (for example, NANP area code/exchange starts with 0 or 1) and the prospect is still created/updated.

  • firstNamestring
  • lastNamestring
  • emailstring | null · email
  • phonestring | null
  • currentStagestring | null
  • currentStageIdstring | null
  • pipelineIdstring | null
  • labelsstring[]
  • titlestring | null
  • companystring | null
  • createdAtinteger | null · int64

    Unix timestamp in milliseconds

  • updatedAtinteger | null · int64

    Unix timestamp in milliseconds

Additional properties are allowed

Delete Prospect

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

Accepts a required prospectId and deletes the matching prospect.

Delete Prospect › path Parameters

  • prospectIdstring · required

Delete Prospect › Request Body
optional

  • userIdstring

    Optional user id requesting prospect deletion.

Delete Prospect › Responses

Deleted

  • messagestring
  • prospectIdstring
AuthNotes