HiringCenter
HiringCenter API

Meetings

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

Create, list, and manage meetings

List Meetings

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

Returns meetings ordered by meeting date (latest/furthest-out first) using the standard list envelope. prospectId, ownerId, meetingType, and meeting date window filters are optional. Results are paginated with limit and pageToken.

List Meetings › query Parameters

  • prospectIdstring
    Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
  • ownerIdstring
    Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45
  • meetingTypestring
    Example: virtual
  • meetingDateAfter

    Optional lower bound for meetingDate as Unix epoch milliseconds (integer) or ISO 8601 date string.

  • meetingDateBefore

    Optional upper bound for meetingDate as Unix epoch milliseconds (integer) or ISO 8601 date string.

  • limitinteger · max: 200
    Example: 25
    Default: 50
  • pageTokenstring
    Example: eyJpZCI6Im10Z18wMUhWNlc4RkozUDdSMk01VDlZMVE0QyJ9

List Meetings › 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 Meeting

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

Accepts required meeting scheduling fields prospectId, meetingDate, timeZone, meetingType, ownerId with optional fields, and creates a meeting returned in item.

Create Meeting › 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 Meeting › Request Body

  • prospectIdstring · required

    Prospect id the meeting is associated with.

  • meetingDaterequired

    Meeting date/time as Unix epoch milliseconds (integer) or ISO 8601 date string.

  • timeZonestring · required

    IANA time zone name for the meeting (for example, America/New_York).

  • meetingTypestring · required

    Meeting type label (for example, phone, virtual, in-person).

  • ownerIdstring · required

    User id who owns the meeting.

  • userIdstring

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

  • locationstring | null

    Optional meeting location text.

  • notesstring | null

    Optional internal notes for the meeting.

Create Meeting › Responses

Created

  • successboolean · required
  • itemobject · required
    Example: {"id":"f4d8a2c17b9e4f3aa6c01d5e7b2f9c44","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","meetingDate":1717170000000,"timeZone":"America/New_York","meetingType":"virtual","ownerId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","location":"Zoom","notes":"Review benefits package and next interview steps.","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null,"createdAt":1717014400000,"updatedAt":1717014400000,"review":null}
Additional properties are allowed

Get Meeting by ID

GET
https://api.hiringcenterpro.com/v2
/meetings/{meetingId}

Accepts a required meetingId path parameter, retrieves the corresponding meeting record, and returns it in item when found.

Get Meeting by ID › path Parameters

  • meetingIdstring · required
    Example: f4d8a2c17b9e4f3aa6c01d5e7b2f9c44

Get Meeting by ID › Responses

OK

  • successboolean · required
  • itemobject · required
    Example: {"id":"f4d8a2c17b9e4f3aa6c01d5e7b2f9c44","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","meetingDate":1717170000000,"timeZone":"America/New_York","meetingType":"virtual","ownerId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","location":"Zoom","notes":"Review benefits package and next interview steps.","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null,"createdAt":1717014400000,"updatedAt":1717014400000,"review":null}
Additional properties are allowed

Update Meeting

POST
https://api.hiringcenterpro.com/v2
/meetings/{meetingId}

Accepts a required meetingId plus updateable scheduling and ownership fields, applies changes to the existing meeting, and returns the updated meeting in item.

Update Meeting › path Parameters

  • meetingIdstring · required
    Example: f4d8a2c17b9e4f3aa6c01d5e7b2f9c44

Update Meeting › 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

Update Meeting › Request Body

  • userIdstring

    Acting user id for authorization and audit context.

  • meetingDate

    Updated meeting date/time as Unix epoch milliseconds (integer) or ISO 8601 date string.

  • timeZonestring

    Updated IANA time zone name.

  • meetingTypestring

    Updated meeting type label.

  • ownerIdstring

    Updated owner user id.

  • locationstring | null

    Updated location text, or null to clear.

  • notesstring | null

    Updated meeting notes, or null to clear.

Update Meeting › Responses

Updated

  • successboolean · required
  • itemobject · required
    Example: {"id":"f4d8a2c17b9e4f3aa6c01d5e7b2f9c44","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","meetingDate":1717170000000,"timeZone":"America/New_York","meetingType":"virtual","ownerId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","location":"Zoom","notes":"Review benefits package and next interview steps.","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null,"createdAt":1717014400000,"updatedAt":1717014400000,"review":null}
Additional properties are allowed

Delete Meeting

DELETE
https://api.hiringcenterpro.com/v2
/meetings/{meetingId}

Accepts a required meetingId path parameter and deletes the specified meeting.

Delete Meeting › path Parameters

  • meetingIdstring · required
    Example: f4d8a2c17b9e4f3aa6c01d5e7b2f9c44

Delete Meeting › 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 Meeting › Responses

OK

  • successboolean · required
  • messagestring · required
TasksAccount