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 hire date (newest first) using the standard list envelope. prospectId and hire date window filters are optional. Results are paginated with limit and pageToken.

List Hires › query Parameters

prospectIdstring
Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
hiredAfter
Optional lower bound for hireDate as Unix epoch milliseconds (integer) or ISO 8601 date string.
hiredBefore
Optional upper bound for hireDate as Unix epoch milliseconds (integer) or ISO 8601 date string.
limitinteger · max: 200
Example: 25
Default: 50
pageTokenstring
Example: eyJpZCI6ImhpcmVfMDFIVjZXOEZKMlA3UjJNNVQ5WTFRNEMifQ==
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 on the source document. Nested paths are not supported. 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.
Example: {"nextPageToken":"opaque-page-token-example","hasMore":true,"totalCount":125}

Create Hire

POST

https://api.hiringcenterpro.com/v2

/hires

Creates a hire for a prospect and moves the prospect to the Hired stage when a matching stage exists. Each prospect may have at most one hire document.

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

prospectIdstring · required
Prospect id the hire is associated with.
hireDaterequired
Hire date/time as Unix epoch milliseconds (integer) or ISO 8601 date string.

hireDescriptionstring
Optional hire description/notes.

Create Hire › Responses

Created

successboolean · required
itemobject · required
Example: {"id":"a1b2c3d74e5f4a8eb6d05c1f9a7e2d45","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","hireDate":1717783200000,"hireDescription":"Started as sales associate","type":"hire","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717783200000,"updatedAt":1717783200000}

Get Hire

GET

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Retrieves a hire by document ID.

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","createdAt":1717783200000,"updatedAt":1717783200000}

Update Hire

POST

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Updates an existing hire by document ID. At least one of hireDate or hireDescription is required.

Update Hire › path Parameters

hireIdstring · required
Example: a1b2c3d74e5f4a8eb6d05c1f9a7e2d45

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

hireDate
Hire date/time as Unix epoch milliseconds (integer) or ISO 8601 date string.
hireDescriptionstring
Hire description/notes.

Update Hire › Responses

successboolean · required
itemobject · required
Example: {"id":"a1b2c3d74e5f4a8eb6d05c1f9a7e2d45","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","hireDate":1717783200000,"hireDescription":"Started as sales associate","type":"hire","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717783200000,"updatedAt":1717783200000}

Delete Hire

DELETE

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Deletes a hire by document ID. Requires an authenticated user who created the hire or owns the associated prospect. The nested DELETE /prospects/{prospectId}/hire/{hireId} route remains available for legacy clients.

Delete Hire › path Parameters

hireIdstring · required
Example: a1b2c3d74e5f4a8eb6d05c1f9a7e2d45

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

successboolean · required
hireIdstring · required

Meetings Account

List Hires

GET

https://api.hiringcenterpro.com/v2

/hires

Returns hires ordered by hire date (newest first) using the standard list envelope. prospectId and hire date window filters are optional. Results are paginated with limit and pageToken.

List Hires › query Parameters

prospectIdstring
Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
hiredAfter
Optional lower bound for hireDate as Unix epoch milliseconds (integer) or ISO 8601 date string.
hiredBefore
Optional upper bound for hireDate as Unix epoch milliseconds (integer) or ISO 8601 date string.
limitinteger · max: 200
Example: 25
Default: 50
pageTokenstring
Example: eyJpZCI6ImhpcmVfMDFIVjZXOEZKMlA3UjJNNVQ5WTFRNEMifQ==
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 on the source document. Nested paths are not supported. 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.
Example: {"nextPageToken":"opaque-page-token-example","hasMore":true,"totalCount":125}

Create Hire

POST

https://api.hiringcenterpro.com/v2

/hires

Creates a hire for a prospect and moves the prospect to the Hired stage when a matching stage exists. Each prospect may have at most one hire document.

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

prospectIdstring · required
Prospect id the hire is associated with.
hireDaterequired
Hire date/time as Unix epoch milliseconds (integer) or ISO 8601 date string.

hireDescriptionstring
Optional hire description/notes.

Create Hire › Responses

Created

successboolean · required
itemobject · required
Example: {"id":"a1b2c3d74e5f4a8eb6d05c1f9a7e2d45","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","hireDate":1717783200000,"hireDescription":"Started as sales associate","type":"hire","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717783200000,"updatedAt":1717783200000}

Get Hire

GET

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Retrieves a hire by document ID.

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","createdAt":1717783200000,"updatedAt":1717783200000}

Update Hire

POST

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Updates an existing hire by document ID. At least one of hireDate or hireDescription is required.

Update Hire › path Parameters

hireIdstring · required
Example: a1b2c3d74e5f4a8eb6d05c1f9a7e2d45

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

hireDate
Hire date/time as Unix epoch milliseconds (integer) or ISO 8601 date string.
hireDescriptionstring
Hire description/notes.

Update Hire › Responses

successboolean · required
itemobject · required
Example: {"id":"a1b2c3d74e5f4a8eb6d05c1f9a7e2d45","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","hireDate":1717783200000,"hireDescription":"Started as sales associate","type":"hire","userId":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717783200000,"updatedAt":1717783200000}

Delete Hire

DELETE

https://api.hiringcenterpro.com/v2

/hires/{hireId}

Delete Hire › path Parameters

hireIdstring · required
Example: a1b2c3d74e5f4a8eb6d05c1f9a7e2d45

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

successboolean · required
hireIdstring · required