HiringCenter
HiringCenter API

Notes

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

Create, list, and manage notes

List Notes

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

Returns notes ordered by created date (newest first). prospectId and userId are optional filters. If both are omitted, returns the most recent notes for the account.

List Notes › query Parameters

  • prospectIdstring

    Optional. When provided, only notes for this prospect are returned.

  • userIdstring

    Optional. When provided, only notes created by this user are returned.

  • limitinteger
    Default: 50
  • startAfterinteger · int64

    Unix timestamp in milliseconds

List Notes › Responses

OK

  • successboolean · required
  • notesobject[] · required
  • lastNoteinteger | null · int64 · required

    Unix timestamp in milliseconds

Create Note

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

Accepts required prospectId and note body with optional fields, and creates a new note for the prospect.

Create Note › Request Body

  • prospectIdstring · required

    Prospect id the note belongs to.

  • notestring · required

    HTML note body content.

  • userIdstring

    Optional user id creating the note. When omitted, the note is created with userId=null, createdByApi=true, and includes API key attribution metadata when available.

  • date

    Optional note timestamp as Unix epoch milliseconds (integer) or ISO 8601 date string.

  • mentionsobject[]

    Optional mention list for users referenced in the note body.

  • pinboolean

    If true, marks the note as pinned.

  • fileUrlstring · uri

    Optional HTTPS URL to a file associated with the note.

Create Note › Responses

Created

  • successboolean · required
  • idstring
  • bodystring
  • createdAtinteger · int64

    Unix timestamp in milliseconds

  • prospectIdstring
  • userIdstring | null
  • createdByApiboolean

    True when the note was created without a userId via API.

  • createdByApiKeyIdstring | null

    API key document id used to create the note when authenticated via API key.

  • createdByApiKeyNamestring | null

    API key display name used to create the note when authenticated via API key.

  • mentionsobject[]
  • pinboolean
  • fileUrlstring | null · uri
Additional properties are allowed

Get Note by ID

GET
https://api.hiringcenterpro.com/v2
/notes/{noteId}

Accepts a required noteId path parameter, retrieves that specific note, and returns the note object with success status when it exists.

Get Note by ID › path Parameters

  • noteIdstring · required

Get Note by ID › Responses

OK

  • successboolean · required
  • idstring
  • bodystring
  • createdAtinteger · int64

    Unix timestamp in milliseconds

  • prospectIdstring
  • userIdstring | null
  • createdByApiboolean

    True when the note was created without a userId via API.

  • createdByApiKeyIdstring | null

    API key document id used to create the note when authenticated via API key.

  • createdByApiKeyNamestring | null

    API key display name used to create the note when authenticated via API key.

  • mentionsobject[]
  • pinboolean
  • fileUrlstring | null · uri
Additional properties are allowed

Delete Note

DELETE
https://api.hiringcenterpro.com/v2
/notes/{noteId}

Accepts a required noteId path parameter and deletes the specified note.

Delete Note › path Parameters

  • noteIdstring · required

Delete Note › Request Body
optional

  • userIdstring

    Optional user id requesting note deletion.

Delete Note › Responses

OK

  • successboolean · required
  • messagestring · required
ProspectsTasks