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 meetingDate (latest first) using the standard list envelope. prospectId, ownerId, meetingType, and the meeting date window are optional filters. When a page is full, pagination.nextPageToken is set; pass it as pageToken to get the next page.

List Meetings › query Parameters

prospectIdstring
Optional. Only meetings for this prospect.
Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
ownerIdstring
Optional. Only meetings owned by this user (matches ownerId, not secondaryOwnerId).
Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45
meetingTypestring
Optional. Exact match on meetingType.
Example: Virtual Meeting
meetingAfter
Optional inclusive lower bound for meetingDate as Unix epoch milliseconds/seconds or a date string.
meetingBefore
Optional inclusive upper bound for meetingDate as Unix epoch milliseconds/seconds or a date string.
limitinteger · min: 1 · max: 200
Page size.
Example: 25
Default: 50
pageTokenstring
Opaque pagination token returned from a prior GET /meetings response.
Example: eyJpZCI6ImY0ZDhhMmMxN2I5ZTRmM2FhNmMwMWQ1ZTdiMmY5YzQ0In0=
fieldsstring
Optional comma-separated list of top-level field names to include in each list item. Use this to reduce response payload size for large list requests. id is always included when present. Nested paths are not supported, and the accepted names depend on the endpoint. Unknown field names or invalid syntax (for example nested selectors) return HTTP 400 with invalidFields and/or invalidSyntax in the error body.
Example: id,prospectId,hireDate

List Meetings › Responses

successboolean · required
itemsobject[] · required
paginationobject · required
Pagination metadata. Fields are included only when that resource supports them; some list endpoints return an empty object.
Example: {"nextPageToken":"opaque-page-token-example","hasMore":true,"totalCount":125}

Create Meeting

POST

https://api.hiringcenterpro.com/v2

/meetings

Schedules a meeting with a prospect and returns it in item. The owner is reminded to review the meeting after it takes place. When userId is set, the prospect owner is notified that a meeting was added.

ownerId, secondaryOwnerId, and assistantId must be users in the account (users removed from the account are refused) and must all be different (400 otherwise). A prospectId that is not in the account returns 404 and nothing is created.

Create Meeting › Headers

X-Idempotency-Keystring
Optional. Client-generated key that makes retries of this request safe. The first response for the key is stored for 24 hours and replayed for retries with the same method, path, query, and body. Reuse a key only when retrying the exact same request.
Example: idem_prospect_create_01HV6W0J7Y7A5Q3T4J6N8M2P

Create Meeting › Request Body

prospectIdstring · required
Prospect the meeting is with.
meetingDaterequired
Meeting start as Unix epoch milliseconds/seconds or a date string.
timeZonestring · maxLength: 64 · required
IANA time zone name for the meeting (for example America/New_York).
meetingTypestring · maxLength: 64 · required
Meeting type label. The app uses In-Person Meeting, Phone Meeting, Virtual Meeting, and Other.
ownerIdstring · required
User who owns the meeting.

userIdstring
Optional user creating the meeting. Stored as createdBy; null when omitted and the meeting is credited to the API key (createdByApiKeyName). Does not set the owner; use ownerId.
secondaryOwnerIdstring | null
Optional second owner.
assistantIdstring | null
Optional assistant.
durationMinutesinteger · enum
Meeting length in minutes. Any other value is stored as 60.
Enum values:
15
30
45
60
120
Default: 60
locationstring | null · maxLength: 500
Optional location text. Longer values are truncated.
notesstring | null · maxLength: 5000
Optional meeting notes. Longer values are truncated.

Create Meeting › Responses

Created

successboolean · required
itemobject · required
Example: {"id":"f4d8a2c17b9e4f3aa6c01d5e7b2f9c44","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","meetingDate":1717170000000,"timeZone":"America/New_York","meetingType":"Virtual Meeting","ownerId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","secondaryOwnerId":null,"assistantId":null,"durationMinutes":60,"location":"Zoom","notes":"Review benefits package and next interview steps.","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717014400000,"updatedAt":1717014400000,"review":null}

Get Meeting by ID

GET

https://api.hiringcenterpro.com/v2

/meetings/{meetingId}

Returns one meeting in item.

Get Meeting by ID › path Parameters

meetingIdstring · required
Example: f4d8a2c17b9e4f3aa6c01d5e7b2f9c44

Get Meeting by ID › Responses

successboolean · required
itemobject · required
Example: {"id":"f4d8a2c17b9e4f3aa6c01d5e7b2f9c44","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","meetingDate":1717170000000,"timeZone":"America/New_York","meetingType":"Virtual Meeting","ownerId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","secondaryOwnerId":null,"assistantId":null,"durationMinutes":60,"location":"Zoom","notes":"Review benefits package and next interview steps.","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717014400000,"updatedAt":1717014400000,"review":null}

Update Meeting

POST

https://api.hiringcenterpro.com/v2

/meetings/{meetingId}

Updates a meeting and returns the whole meeting in item. Send at least one of meetingDate, timeZone, meetingType, ownerId, secondaryOwnerId, assistantId, durationMinutes, location, notes, or review (400 "No valid fields to update" otherwise); fields you leave out are not changed. When userId is set, the prospect owner is notified that the meeting was updated.

ownerId, secondaryOwnerId, and assistantId must be users in the account (users removed from the account are refused) and must all be different. Send null to clear secondaryOwnerId or assistantId.
Rescheduling an unreviewed meeting moves its review reminder to the new time.
review records the outcome, as the app's review form does: status is Completed or Incomplete (required on the first review); nextSteps is Hire, Pipeline, or Do Not Pursue for a completed meeting and Reschedule or Do Not Pursue for an incomplete one; rating is 0-5; feedback is free text. On an existing review, fields you leave out keep their value, and a next step the new status does not offer is cleared. reviewedBy is the userId you send (or null) and reviewedAt is now. Send review: null to remove the review.

Update Meeting › path Parameters

meetingIdstring · required
Example: f4d8a2c17b9e4f3aa6c01d5e7b2f9c44

Update Meeting › Headers

X-Idempotency-Keystring
Optional. Client-generated key that makes retries of this request safe. The first response for the key is stored for 24 hours and replayed for retries with the same method, path, query, and body. Reuse a key only when retrying the exact same request.
Example: idem_prospect_create_01HV6W0J7Y7A5Q3T4J6N8M2P

Update Meeting › Request Body

userIdstring
Optional user making the change. Must be a user in the account (400 otherwise). Stored as updatedBy.
meetingDate
New meeting start as Unix epoch milliseconds/seconds or a date string.
timeZonestring · maxLength: 64
New IANA time zone name.
meetingTypestring · maxLength: 64
New meeting type label.
ownerIdstring
New owner. Must be a user in the account.
secondaryOwnerIdstring | null
Second owner, a user in the account, or null to clear.
assistantIdstring | null
Assistant, a user in the account, or null to clear.
durationMinutesinteger · enum
Meeting length in minutes.
Enum values:
15
30
45
60
120
reviewobject | null
Meeting outcome. See the description above.
locationstring | null · maxLength: 500
New location text, or null to clear.
notesstring | null · maxLength: 5000
New 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 Meeting","ownerId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","secondaryOwnerId":null,"assistantId":null,"durationMinutes":60,"location":"Zoom","notes":"Review benefits package and next interview steps.","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717014400000,"updatedAt":1717014400000,"review":null}

Delete Meeting

DELETE

https://api.hiringcenterpro.com/v2

/meetings/{meetingId}

Deletes a meeting. Deleting a meeting that does not exist also returns 200. When userId is sent (query or body), the prospect owner is notified that the meeting was deleted.

Delete Meeting › path Parameters

meetingIdstring · required
Example: f4d8a2c17b9e4f3aa6c01d5e7b2f9c44

Delete Meeting › query Parameters

userIdstring
Optional user deleting the meeting.
Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45

Delete Meeting › Headers

X-Idempotency-Keystring
Optional. Client-generated key that makes retries of this request safe. The first response for the key is stored for 24 hours and replayed for retries with the same method, path, query, and body. Reuse a key only when retrying the exact same request.
Example: idem_prospect_create_01HV6W0J7Y7A5Q3T4J6N8M2P

Delete Meeting › Responses

successboolean · required
messagestring · required

Tasks Hires

List Meetings

GET

https://api.hiringcenterpro.com/v2

/meetings

List Meetings › query Parameters

prospectIdstring
Optional. Only meetings for this prospect.
Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
ownerIdstring
Optional. Only meetings owned by this user (matches ownerId, not secondaryOwnerId).
Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45
meetingTypestring
Optional. Exact match on meetingType.
Example: Virtual Meeting
meetingAfter
Optional inclusive lower bound for meetingDate as Unix epoch milliseconds/seconds or a date string.
meetingBefore
Optional inclusive upper bound for meetingDate as Unix epoch milliseconds/seconds or a date string.
limitinteger · min: 1 · max: 200
Page size.
Example: 25
Default: 50
pageTokenstring
Opaque pagination token returned from a prior GET /meetings response.
Example: eyJpZCI6ImY0ZDhhMmMxN2I5ZTRmM2FhNmMwMWQ1ZTdiMmY5YzQ0In0=
fieldsstring
Optional comma-separated list of top-level field names to include in each list item. Use this to reduce response payload size for large list requests. id is always included when present. Nested paths are not supported, and the accepted names depend on the endpoint. Unknown field names or invalid syntax (for example nested selectors) return HTTP 400 with invalidFields and/or invalidSyntax in the error body.
Example: id,prospectId,hireDate

List Meetings › Responses

successboolean · required
itemsobject[] · required
paginationobject · required
Pagination metadata. Fields are included only when that resource supports them; some list endpoints return an empty object.
Example: {"nextPageToken":"opaque-page-token-example","hasMore":true,"totalCount":125}

Create Meeting

POST

https://api.hiringcenterpro.com/v2

/meetings

Create Meeting › Headers

X-Idempotency-Keystring
Optional. Client-generated key that makes retries of this request safe. The first response for the key is stored for 24 hours and replayed for retries with the same method, path, query, and body. Reuse a key only when retrying the exact same request.
Example: idem_prospect_create_01HV6W0J7Y7A5Q3T4J6N8M2P

Create Meeting › Request Body

prospectIdstring · required
Prospect the meeting is with.
meetingDaterequired
Meeting start as Unix epoch milliseconds/seconds or a date string.
timeZonestring · maxLength: 64 · required
IANA time zone name for the meeting (for example America/New_York).
meetingTypestring · maxLength: 64 · required
Meeting type label. The app uses In-Person Meeting, Phone Meeting, Virtual Meeting, and Other.
ownerIdstring · required
User who owns the meeting.

userIdstring
Optional user creating the meeting. Stored as createdBy; null when omitted and the meeting is credited to the API key (createdByApiKeyName). Does not set the owner; use ownerId.
secondaryOwnerIdstring | null
Optional second owner.
assistantIdstring | null
Optional assistant.
durationMinutesinteger · enum
Meeting length in minutes. Any other value is stored as 60.
Enum values:
15
30
45
60
120
Default: 60
locationstring | null · maxLength: 500
Optional location text. Longer values are truncated.
notesstring | null · maxLength: 5000
Optional meeting notes. Longer values are truncated.

Create Meeting › Responses

Created

successboolean · required
itemobject · required
Example: {"id":"f4d8a2c17b9e4f3aa6c01d5e7b2f9c44","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","meetingDate":1717170000000,"timeZone":"America/New_York","meetingType":"Virtual Meeting","ownerId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","secondaryOwnerId":null,"assistantId":null,"durationMinutes":60,"location":"Zoom","notes":"Review benefits package and next interview steps.","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717014400000,"updatedAt":1717014400000,"review":null}

Get Meeting by ID

GET

https://api.hiringcenterpro.com/v2

/meetings/{meetingId}

Returns one meeting in item.

Get Meeting by ID › path Parameters

meetingIdstring · required
Example: f4d8a2c17b9e4f3aa6c01d5e7b2f9c44

Get Meeting by ID › Responses

successboolean · required
itemobject · required
Example: {"id":"f4d8a2c17b9e4f3aa6c01d5e7b2f9c44","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","meetingDate":1717170000000,"timeZone":"America/New_York","meetingType":"Virtual Meeting","ownerId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","secondaryOwnerId":null,"assistantId":null,"durationMinutes":60,"location":"Zoom","notes":"Review benefits package and next interview steps.","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717014400000,"updatedAt":1717014400000,"review":null}

Update Meeting

POST

https://api.hiringcenterpro.com/v2

/meetings/{meetingId}

ownerId, secondaryOwnerId, and assistantId must be users in the account (users removed from the account are refused) and must all be different. Send null to clear secondaryOwnerId or assistantId.
Rescheduling an unreviewed meeting moves its review reminder to the new time.
review records the outcome, as the app's review form does: status is Completed or Incomplete (required on the first review); nextSteps is Hire, Pipeline, or Do Not Pursue for a completed meeting and Reschedule or Do Not Pursue for an incomplete one; rating is 0-5; feedback is free text. On an existing review, fields you leave out keep their value, and a next step the new status does not offer is cleared. reviewedBy is the userId you send (or null) and reviewedAt is now. Send review: null to remove the review.

Update Meeting › path Parameters

meetingIdstring · required
Example: f4d8a2c17b9e4f3aa6c01d5e7b2f9c44

Update Meeting › Headers

X-Idempotency-Keystring
Optional. Client-generated key that makes retries of this request safe. The first response for the key is stored for 24 hours and replayed for retries with the same method, path, query, and body. Reuse a key only when retrying the exact same request.
Example: idem_prospect_create_01HV6W0J7Y7A5Q3T4J6N8M2P

Update Meeting › Request Body

userIdstring
Optional user making the change. Must be a user in the account (400 otherwise). Stored as updatedBy.
meetingDate
New meeting start as Unix epoch milliseconds/seconds or a date string.
timeZonestring · maxLength: 64
New IANA time zone name.
meetingTypestring · maxLength: 64
New meeting type label.
ownerIdstring
New owner. Must be a user in the account.
secondaryOwnerIdstring | null
Second owner, a user in the account, or null to clear.
assistantIdstring | null
Assistant, a user in the account, or null to clear.
durationMinutesinteger · enum
Meeting length in minutes.
Enum values:
15
30
45
60
120
reviewobject | null
Meeting outcome. See the description above.
locationstring | null · maxLength: 500
New location text, or null to clear.
notesstring | null · maxLength: 5000
New 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 Meeting","ownerId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","secondaryOwnerId":null,"assistantId":null,"durationMinutes":60,"location":"Zoom","notes":"Review benefits package and next interview steps.","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717014400000,"updatedAt":1717014400000,"review":null}

Delete Meeting

DELETE

https://api.hiringcenterpro.com/v2

/meetings/{meetingId}

Deletes a meeting. Deleting a meeting that does not exist also returns 200. When userId is sent (query or body), the prospect owner is notified that the meeting was deleted.

Delete Meeting › path Parameters

meetingIdstring · required
Example: f4d8a2c17b9e4f3aa6c01d5e7b2f9c44

Delete Meeting › query Parameters

userIdstring
Optional user deleting the meeting.
Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45

Delete Meeting › Headers

X-Idempotency-Keystring
Optional. Client-generated key that makes retries of this request safe. The first response for the key is stored for 24 hours and replayed for retries with the same method, path, query, and body. Reuse a key only when retrying the exact same request.
Example: idem_prospect_create_01HV6W0J7Y7A5Q3T4J6N8M2P

Delete Meeting › Responses

successboolean · required
messagestring · required