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) using the standard list envelope. prospectId and userId are optional filters. If both are omitted, returns the most recent notes for the account. Pagination uses pageToken; responses include pagination.nextPageToken when another page is available.

List Notes › query Parameters

  • prospectIdstring

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

    Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
  • userIdstring

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

    Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45
  • limitinteger
    Example: 25
    Default: 50
  • pageTokenstring

    Opaque pagination token returned from a prior GET /notes response.

    Example: eyJjcmVhdGVkQXQiOjE3MTcwMDcyMDAwMDB9

List Notes › Responses

OK

  • successboolean · required
  • itemsobject[] · required
  • paginationobject · required

    Pagination metadata. Fields are included only when that resource supports them.

    Example: {"nextPageToken":"eyJpZCI6InRhc2tfMDFIVjZXNldSNU44SzJNNFQ3WTlQMUMifQ==","totalCount":125}
Additional properties are allowed

Create Note

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

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

Create Note › Headers

  • X-Idempotency-Keystring · maxLength: 512

    Optional. Client-generated key used to make mutation retries safe. Reuse the same key only when retrying the exact same request.

    Example: idem_prospect_create_01HV6W0J7Y7A5Q3T4J6N8M2P

Create Note › Request Body

  • prospectIdstring · required

    Prospect id the note belongs to.

  • bodystring · 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
  • itemobject · required
    Example: {"id":"d8b2c7a14e9f4d3ab6c05e1f9a7d2c48","body":"<p>Left voicemail and sent a follow-up email.</p>","createdAt":1717007200000,"prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null,"mentions":[{"userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","displayName":"Jamie Lee"}],"pin":true,"fileUrl":null}
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 it in item when it exists.

Get Note by ID › path Parameters

  • noteIdstring · required
    Example: d8b2c7a14e9f4d3ab6c05e1f9a7d2c48

Get Note by ID › Responses

OK

  • successboolean · required
  • itemobject · required
    Example: {"id":"d8b2c7a14e9f4d3ab6c05e1f9a7d2c48","body":"<p>Left voicemail and sent a follow-up email.</p>","createdAt":1717007200000,"prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null,"mentions":[{"userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","displayName":"Jamie Lee"}],"pin":true,"fileUrl":null}
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
    Example: d8b2c7a14e9f4d3ab6c05e1f9a7d2c48

Delete Note › Headers

  • X-Idempotency-Keystring · maxLength: 512

    Optional. Client-generated key used to make mutation retries safe. Reuse the same key only when retrying the exact same request.

    Example: idem_prospect_create_01HV6W0J7Y7A5Q3T4J6N8M2P

Delete Note › Responses

OK

  • successboolean · required
  • messagestring · required
ProspectsTasks