HiringCenter Pro
HiringCenter Pro API

Notes

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

Operations for prospect notes.

List Notes

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

List Notes › query Parameters

  • prospectIdstring
  • userIdstring
  • limitinteger
    Default: 50
  • startAfterinteger · int64

List Notes › Headers

  • Authorizationstring · required

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

List Notes › Responses

OK

  • notesobject[]
  • lastNoteinteger · int64

Add Note

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

Add Note › Headers

  • Authorizationstring · required

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

Add Note › Request Body

  • prospectIdstring · required
  • userIdstring · required
  • notestring · required
  • datestring

    MM/DD/YYYY HH:mm:ss or ISO format

  • mentionsobject[]
  • pinboolean
  • fileUrlstring · uri

Add Note › Responses

Created

  • idstring
  • bodystring
  • createdAtinteger · int64
  • prospectIdstring
  • userIdstring
  • mentionsobject[]
  • pinboolean
  • fileUrlstring | null · uri
Additional properties are allowed

Get Specific Note

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

Get Specific Note › path Parameters

  • noteIdstring · required

Get Specific Note › Headers

  • Authorizationstring · required

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

Get Specific Note › Responses

OK

  • idstring
  • bodystring
  • createdAtinteger · int64
  • prospectIdstring
  • userIdstring
  • mentionsobject[]
  • pinboolean
  • fileUrlstring | null · uri
Additional properties are allowed

Delete Note

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

Delete Note › path Parameters

  • noteIdstring · required

Delete Note › Headers

  • Authorizationstring · required

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

Delete Note › Responses

OK

  • messagestring
ProspectsConversations