HiringCenter API

Hires

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

Create, list, and manage hires

List Hires

GET

https://api.hiringcenterpro.com/v2

/hires

Returns hires ordered by hireDate (newest first) using the standard list envelope. prospectId and the hire date window are optional filters. When a page is full, pagination.nextPageToken is set; pass it as pageToken to get the next page.

List Hires › query Parameters

prospectIdstring
Optional. Only the hire for this prospect.
Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
hiredAfter
Optional inclusive lower bound for hireDate as Unix epoch milliseconds/seconds or a date string.
hiredBefore
Optional inclusive upper bound for hireDate as Unix epoch milliseconds/seconds or a date string. Must not be earlier than hiredAfter.
limitinteger · min: 1 · max: 200
Page size.
Example: 25
Default: 50
pageTokenstring
Opaque pagination token returned from a prior GET /hires response.
Example: eyJpZCI6ImExYjJjM2Q3NGU1ZjRhOGViNmQwNWMxZjlhN2UyZDQ1In0=
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 Hires › 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 Hire

POST

https://api.hiringcenterpro.com/v2

/hires

Records a hire for a prospect. A prospect can have only one hire; a second one returns 400.

The prospect is moved to the stage named "Hired" in its current pipeline (or the first "Hired" stage when it has no pipeline), and the stage change is added to its stage history. If there is no such stage, the stage is left unchanged. When userId is set, the prospect owner is notified.

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

prospectIdstring · maxLength: 256 · required
Prospect who was hired.
hireDaterequired
Hire date as Unix epoch milliseconds/seconds or a date string.

hireDescriptionstring
Optional description of the hire. Defaults to an empty string.
userIdstring
Optional user recording the hire. Stored as userId; null when omitted and the hire is credited to the API key (createdByApiKeyName).

Create Hire › Responses

Created

successboolean · required
itemobject · required
Example: {"id":"a1b2c3d74e5f4a8eb6d05c1f9a7e2d45","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","hireDate":1717783200000,"hireDescription":"Started as sales associate","type":"hire","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717783200000,"updatedAt":1717783200000}

Get Hire

GET

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Returns one hire in item.

Get Hire › path Parameters

hireIdstring · required
Example: a1b2c3d74e5f4a8eb6d05c1f9a7e2d45

Get Hire › Responses

successboolean · required
itemobject · required
Example: {"id":"a1b2c3d74e5f4a8eb6d05c1f9a7e2d45","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","hireDate":1717783200000,"hireDescription":"Started as sales associate","type":"hire","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717783200000,"updatedAt":1717783200000}

Update Hire

POST

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Updates a hire and returns the whole hire in item. At least one of hireDate, hireDescription, or ignoreHire is required. Changing the hire does not change the prospect's stage.

Update Hire › path Parameters

hireIdstring · required
Example: a1b2c3d74e5f4a8eb6d05c1f9a7e2d45

Update Hire › 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 Hire › Request Body

hireDate
New hire date as Unix epoch milliseconds/seconds or a date string.
hireDescriptionstring
New description.
ignoreHireboolean
true marks the hire as ignored, as the app's "Ignore this hire" option does; false clears it.
userIdstring
Optional user making the change. Stored as updatedBy.

Update Hire › Responses

successboolean · required
itemobject · required
Example: {"id":"a1b2c3d74e5f4a8eb6d05c1f9a7e2d45","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","hireDate":1717783200000,"hireDescription":"Started as sales associate","type":"hire","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717783200000,"updatedAt":1717783200000}

Delete Hire

DELETE

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Deletes a hire. The prospect's stage is not changed. Unlike tasks and meetings, deleting a hire that does not exist returns 404.

Delete Hire › path Parameters

hireIdstring · required
Example: a1b2c3d74e5f4a8eb6d05c1f9a7e2d45

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

successboolean · required
hireIdstring · required

Meetings Account

List Hires

GET

https://api.hiringcenterpro.com/v2

/hires

List Hires › query Parameters

prospectIdstring
Optional. Only the hire for this prospect.
Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
hiredAfter
Optional inclusive lower bound for hireDate as Unix epoch milliseconds/seconds or a date string.
hiredBefore
Optional inclusive upper bound for hireDate as Unix epoch milliseconds/seconds or a date string. Must not be earlier than hiredAfter.
limitinteger · min: 1 · max: 200
Page size.
Example: 25
Default: 50
pageTokenstring
Opaque pagination token returned from a prior GET /hires response.
Example: eyJpZCI6ImExYjJjM2Q3NGU1ZjRhOGViNmQwNWMxZjlhN2UyZDQ1In0=
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 Hires › 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 Hire

POST

https://api.hiringcenterpro.com/v2

/hires

Records a hire for a prospect. A prospect can have only one hire; a second one returns 400.

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

prospectIdstring · maxLength: 256 · required
Prospect who was hired.
hireDaterequired
Hire date as Unix epoch milliseconds/seconds or a date string.

hireDescriptionstring
Optional description of the hire. Defaults to an empty string.
userIdstring
Optional user recording the hire. Stored as userId; null when omitted and the hire is credited to the API key (createdByApiKeyName).

Create Hire › Responses

Created

successboolean · required
itemobject · required
Example: {"id":"a1b2c3d74e5f4a8eb6d05c1f9a7e2d45","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","hireDate":1717783200000,"hireDescription":"Started as sales associate","type":"hire","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717783200000,"updatedAt":1717783200000}

Get Hire

GET

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Returns one hire in item.

Get Hire › path Parameters

hireIdstring · required
Example: a1b2c3d74e5f4a8eb6d05c1f9a7e2d45

Get Hire › Responses

successboolean · required
itemobject · required
Example: {"id":"a1b2c3d74e5f4a8eb6d05c1f9a7e2d45","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","hireDate":1717783200000,"hireDescription":"Started as sales associate","type":"hire","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717783200000,"updatedAt":1717783200000}

Update Hire

POST

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Updates a hire and returns the whole hire in item. At least one of hireDate, hireDescription, or ignoreHire is required. Changing the hire does not change the prospect's stage.

Update Hire › path Parameters

hireIdstring · required
Example: a1b2c3d74e5f4a8eb6d05c1f9a7e2d45

Update Hire › 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 Hire › Request Body

hireDate
New hire date as Unix epoch milliseconds/seconds or a date string.
hireDescriptionstring
New description.
ignoreHireboolean
true marks the hire as ignored, as the app's "Ignore this hire" option does; false clears it.
userIdstring
Optional user making the change. Stored as updatedBy.

Update Hire › Responses

successboolean · required
itemobject · required
Example: {"id":"a1b2c3d74e5f4a8eb6d05c1f9a7e2d45","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","hireDate":1717783200000,"hireDescription":"Started as sales associate","type":"hire","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key","createdAt":1717783200000,"updatedAt":1717783200000}

Delete Hire

DELETE

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Deletes a hire. The prospect's stage is not changed. Unlike tasks and meetings, deleting a hire that does not exist returns 404.

Delete Hire › path Parameters

hireIdstring · required
Example: a1b2c3d74e5f4a8eb6d05c1f9a7e2d45

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

successboolean · required
hireIdstring · required