HiringCenter
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 ordered by due date (oldest first) using the standard list envelope. When incompleteOnly is omitted, defaults to false and all tasks are returned.

List Tasks › query Parameters

  • prospectIdstring

    Optional. When provided, only tasks for this prospect are returned.

    Example: c1a7e9d34b8f4c2aa6d15e0f7b3c9d42
  • assignedTostring

    Optional. When provided, only tasks assigned to this user id are returned.

    Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45
  • userIdstring

    Optional. When provided, only tasks created by this user id are returned (matches createdBy).

    Example: b2e7a1d94c3f4a8eb6d05c1f9a7e2d45
  • incompleteOnlyboolean

    Optional completion filter. true returns only open/incomplete tasks (completedAt is null). false returns all statuses. When this parameter is provided, it takes precedence over status.

    Example: true
  • dueBefore

    Optional upper bound for due date (dueAt, inclusive). Applied for non-completed status queries.

  • dueAfter

    Optional lower bound for due date (dueAt, inclusive). Applied for non-completed status queries.

  • limitinteger · max: 200

    Optional page size.

    Example: 25
    Default: 50
  • pageTokenstring

    Opaque pagination token returned from a prior GET /tasks response.

    Example: eyJpZCI6InRhc2tfMDFIVjZXNldSNU44SzJNNFQ3WTlQMUMifQ==

List Tasks › 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 Task

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

Accepts required prospectId, assignedTo, and task text with optional fields and creates a task.

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

  • prospectIdstring · required

    Prospect id the task belongs to.

  • assignedTostring · required

    User id assigned to complete the task.

  • taskstring · required

    Task title or instruction text.

  • userIdstring

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

  • dueAt

    Optional due timestamp as Unix epoch milliseconds (integer) or ISO 8601 date string. If omitted, 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,"updatedAt":1717010900000,"dueAt":1717097200000,"completedAt":null,"completedBy":null,"createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null}
Additional properties are allowed

Get Task by ID

GET
https://api.hiringcenterpro.com/v2
/tasks/{taskId}

Accepts a required taskId path parameter, looks up the matching task record, and returns it in item when found.

Get Task by ID › path Parameters

  • taskIdstring · required
    Example: e3f9a1c74b2d4e8aa6d05c1f7b9e2d43

Get Task by ID › Responses

OK

  • successboolean · required
  • itemobject · required
    Example: {"id":"e3f9a1c74b2d4e8aa6d05c1f7b9e2d43","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","task":"Call prospect after webinar","assignedTo":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","assignedBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717010800000,"updatedAt":1717010900000,"dueAt":1717097200000,"completedAt":null,"completedBy":null,"createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null}
Additional properties are allowed

Update Task

POST
https://api.hiringcenterpro.com/v2
/tasks/{taskId}

Accepts a required taskId plus mutable task fields, updates the existing task, and returns the updated fields in item.

Update Task › path Parameters

  • taskIdstring · required
    Example: e3f9a1c74b2d4e8aa6d05c1f7b9e2d43

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

  • userIdstring

    Optional acting user id for audit context.

  • completeboolean

    If true, marks the task as completed.

  • taskstring

    Updated task title or instruction text.

  • assignedTostring

    Updated assignee user id.

  • dueAt

    Updated due timestamp as Unix epoch milliseconds (integer) or ISO 8601 date string.

Additional properties are allowed

Update Task › Responses

OK

  • successboolean · required
  • itemobject · required
    Example: {"id":"e3f9a1c74b2d4e8aa6d05c1f7b9e2d43","prospectId":"c1a7e9d34b8f4c2aa6d15e0f7b3c9d42","task":"Call prospect after webinar","assignedTo":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","assignedBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdBy":"b2e7a1d94c3f4a8eb6d05c1f9a7e2d45","createdAt":1717010800000,"updatedAt":1717010900000,"dueAt":1717097200000,"completedAt":null,"completedBy":null,"createdByApi":false,"createdByApiKeyId":null,"createdByApiKeyName":null}
Additional properties are allowed

Delete Task

DELETE
https://api.hiringcenterpro.com/v2
/tasks/{taskId}

Accepts a required taskId path parameter and deletes the specified task.

Delete Task › path Parameters

  • taskIdstring · required
    Example: e3f9a1c74b2d4e8aa6d05c1f7b9e2d43

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

OK

  • successboolean · required
  • messagestring · required
NotesMeetings