HiringCenter API

Tasks

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

Create, list, and manage tasks

List Tasks

GET

https://api.hiringcenterpro.com/v2

/tasks

Returns tasks using the standard list envelope. Ordering depends on the filters:

Default (status=all or open): by dueAt, earliest first.
status=completed: by completedAt, most recent first. dueAfter/dueBefore are ignored.
When createdAfter or createdBefore is set: by createdAt, newest first, with the status and due-date filters still applied.

When a page is full, pagination.nextPageToken is set; pass it as pageToken to get the next page.

List Tasks › query Parameters

prospectIdstring
Optional. Only tasks for this prospect.
Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
assignedTostring
Optional. Only tasks assigned to this user id (or hiringcenterAi).
Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45
userIdstring
Optional. Only tasks created by this user (matches createdBy). Must be a user in the account (400 otherwise).
Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45
statusstring · enum
Optional completion filter. open returns tasks that are not complete, completed only completed tasks, and all everything. Ignored when incompleteOnly is sent.
Enum values:
open
completed
all
Default: all
incompleteOnlyboolean
Optional. true is the same as status=open; false is the same as status=all. Takes precedence over status.
Example: true
dueBefore
Optional inclusive upper bound for dueAt as Unix epoch milliseconds/seconds or a date string. Not applied with status=completed.
dueAfter
Optional inclusive lower bound for dueAt as Unix epoch milliseconds/seconds or a date string. Not applied with status=completed.
createdAfter
Optional inclusive lower bound for createdAt as Unix epoch milliseconds/seconds or a date string.
createdBefore
Optional inclusive upper bound for createdAt as Unix epoch milliseconds/seconds or a date string. Must not be earlier than createdAfter.
limitinteger · min: 1 · max: 200
Page size.
Example: 25
Default: 50
pageTokenstring
Opaque pagination token returned from a prior GET /tasks response.
Example: eyJpZCI6ImUzZjlhMWM3NGIyZDRlOGFhNmQwNWMxZjdiOWUyZDQzIn0=
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 Tasks › 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 Task

POST

https://api.hiringcenterpro.com/v2

/tasks

Creates a task on a prospect and fires the task.created webhook event. When userId is set, the prospect owner is notified that a task was added.

HTML tags and control characters are stripped from task; it must not be empty afterward. assignedTo must be a user in the account (users removed from the account are refused) or hiringcenterAi (400 otherwise). A prospectId that is not in the account returns 404 and nothing is created.

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

prospectIdstring · required
Prospect the task belongs to.
assignedTostring · required
User id in the account who should do the task, or hiringcenterAi to assign it to HiringCenter AI, which works on it when it is due.
taskstring · required
Task text.

userIdstring
Optional user creating the task. Stored as createdBy and assignedBy; both are null when omitted and the task is credited to the API key (createdByApiKeyName). Does not set the assignee; use assignedTo.
dueAt
Optional due time as Unix epoch milliseconds/seconds or a date string. Defaults to now.

Create Task › Responses

Created

successboolean · required
itemobject · required
Example: {"id":"e3f9a1c74b2d4e8aa6d05c1f7b9e2d43","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","task":"Call prospect after webinar","assignedTo":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","assignedBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717010800000,"dueAt":1717097200000,"completedAt":null,"completedBy":null,"createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key"}

Get Task by ID

GET

https://api.hiringcenterpro.com/v2

/tasks/{taskId}

Returns one task in item.

Get Task by ID › path Parameters

taskIdstring · required
Example: e3f9a1c74b2d4e8aa6d05c1f7b9e2d43

Get Task by ID › Responses

successboolean · required
itemobject · required
Example: {"id":"e3f9a1c74b2d4e8aa6d05c1f7b9e2d43","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","task":"Call prospect after webinar","assignedTo":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","assignedBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717010800000,"dueAt":1717097200000,"completedAt":null,"completedBy":null,"createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key"}

Update Task

POST

https://api.hiringcenterpro.com/v2

/tasks/{taskId}

Updates or completes a task and returns the whole task in item.

complete: true marks the task complete (completedAt now, completedBy set to userId), ignores the other fields, and fires the task.completed webhook event. When userId is set, the prospect owner is notified. A completed task cannot be reopened through the API.
Otherwise at least one of task, assignedTo, or dueAt is required (400 "No valid fields to update"), and the task.updated webhook event fires. A new assignedTo must be a user in the account or hiringcenterAi (400 otherwise).

Update Task › path Parameters

taskIdstring · required
Example: e3f9a1c74b2d4e8aa6d05c1f7b9e2d43

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

userIdstring
Optional user making the change. Stored as updatedBy, and as completedBy when completing.
completeboolean
If true, marks the task complete.
taskstring
New task text. HTML tags are stripped; ignored if empty afterward.
assignedTostring
New assignee user id, or hiringcenterAi.
dueAt
New due time as Unix epoch milliseconds/seconds or a date string.

Update Task › Responses

successboolean · required
itemobject · required
Example: {"id":"e3f9a1c74b2d4e8aa6d05c1f7b9e2d43","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","task":"Call prospect after webinar","assignedTo":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","assignedBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717010800000,"dueAt":1717097200000,"completedAt":null,"completedBy":null,"createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key"}

Delete Task

DELETE

https://api.hiringcenterpro.com/v2

/tasks/{taskId}

Deletes a task and fires the task.deleted webhook event. Deleting a task that does not exist also returns 200.

Delete Task › path Parameters

taskIdstring · required
Example: e3f9a1c74b2d4e8aa6d05c1f7b9e2d43

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

successboolean · required
messagestring · required

Activities Meetings

List Tasks

GET

https://api.hiringcenterpro.com/v2

/tasks

Returns tasks using the standard list envelope. Ordering depends on the filters:

Default (status=all or open): by dueAt, earliest first.
status=completed: by completedAt, most recent first. dueAfter/dueBefore are ignored.
When createdAfter or createdBefore is set: by createdAt, newest first, with the status and due-date filters still applied.

When a page is full, pagination.nextPageToken is set; pass it as pageToken to get the next page.

List Tasks › query Parameters

prospectIdstring
Optional. Only tasks for this prospect.
Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
assignedTostring
Optional. Only tasks assigned to this user id (or hiringcenterAi).
Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45
userIdstring
Optional. Only tasks created by this user (matches createdBy). Must be a user in the account (400 otherwise).
Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45
statusstring · enum
Optional completion filter. open returns tasks that are not complete, completed only completed tasks, and all everything. Ignored when incompleteOnly is sent.
Enum values:
open
completed
all
Default: all
incompleteOnlyboolean
Optional. true is the same as status=open; false is the same as status=all. Takes precedence over status.
Example: true
dueBefore
Optional inclusive upper bound for dueAt as Unix epoch milliseconds/seconds or a date string. Not applied with status=completed.
dueAfter
Optional inclusive lower bound for dueAt as Unix epoch milliseconds/seconds or a date string. Not applied with status=completed.
createdAfter
Optional inclusive lower bound for createdAt as Unix epoch milliseconds/seconds or a date string.
createdBefore
Optional inclusive upper bound for createdAt as Unix epoch milliseconds/seconds or a date string. Must not be earlier than createdAfter.
limitinteger · min: 1 · max: 200
Page size.
Example: 25
Default: 50
pageTokenstring
Opaque pagination token returned from a prior GET /tasks response.
Example: eyJpZCI6ImUzZjlhMWM3NGIyZDRlOGFhNmQwNWMxZjdiOWUyZDQzIn0=
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 Tasks › 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 Task

POST

https://api.hiringcenterpro.com/v2

/tasks

Creates a task on a prospect and fires the task.created webhook event. When userId is set, the prospect owner is notified that a task was added.

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

prospectIdstring · required
Prospect the task belongs to.
assignedTostring · required
User id in the account who should do the task, or hiringcenterAi to assign it to HiringCenter AI, which works on it when it is due.
taskstring · required
Task text.

userIdstring
Optional user creating the task. Stored as createdBy and assignedBy; both are null when omitted and the task is credited to the API key (createdByApiKeyName). Does not set the assignee; use assignedTo.
dueAt
Optional due time as Unix epoch milliseconds/seconds or a date string. Defaults to now.

Create Task › Responses

Created

successboolean · required
itemobject · required
Example: {"id":"e3f9a1c74b2d4e8aa6d05c1f7b9e2d43","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","task":"Call prospect after webinar","assignedTo":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","assignedBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717010800000,"dueAt":1717097200000,"completedAt":null,"completedBy":null,"createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key"}

Get Task by ID

GET

https://api.hiringcenterpro.com/v2

/tasks/{taskId}

Returns one task in item.

Get Task by ID › path Parameters

taskIdstring · required
Example: e3f9a1c74b2d4e8aa6d05c1f7b9e2d43

Get Task by ID › Responses

successboolean · required
itemobject · required
Example: {"id":"e3f9a1c74b2d4e8aa6d05c1f7b9e2d43","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","task":"Call prospect after webinar","assignedTo":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","assignedBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717010800000,"dueAt":1717097200000,"completedAt":null,"completedBy":null,"createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key"}

Update Task

POST

https://api.hiringcenterpro.com/v2

/tasks/{taskId}

Updates or completes a task and returns the whole task in item.

complete: true marks the task complete (completedAt now, completedBy set to userId), ignores the other fields, and fires the task.completed webhook event. When userId is set, the prospect owner is notified. A completed task cannot be reopened through the API.
Otherwise at least one of task, assignedTo, or dueAt is required (400 "No valid fields to update"), and the task.updated webhook event fires. A new assignedTo must be a user in the account or hiringcenterAi (400 otherwise).

Update Task › path Parameters

taskIdstring · required
Example: e3f9a1c74b2d4e8aa6d05c1f7b9e2d43

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

userIdstring
Optional user making the change. Stored as updatedBy, and as completedBy when completing.
completeboolean
If true, marks the task complete.
taskstring
New task text. HTML tags are stripped; ignored if empty afterward.
assignedTostring
New assignee user id, or hiringcenterAi.
dueAt
New due time as Unix epoch milliseconds/seconds or a date string.

Update Task › Responses

successboolean · required
itemobject · required
Example: {"id":"e3f9a1c74b2d4e8aa6d05c1f7b9e2d43","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","task":"Call prospect after webinar","assignedTo":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","assignedBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717010800000,"dueAt":1717097200000,"completedAt":null,"completedBy":null,"createdByApi":true,"createdByApiKeyId":"8f4c2a19d7e34b6f9a1c5e2d7b3f8c4a","createdByApiKeyName":"Zapier production key"}

Delete Task

DELETE

https://api.hiringcenterpro.com/v2

/tasks/{taskId}

Deletes a task and fires the task.deleted webhook event. Deleting a task that does not exist also returns 200.

Delete Task › path Parameters

taskIdstring · required
Example: e3f9a1c74b2d4e8aa6d05c1f7b9e2d43

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

successboolean · required
messagestring · required