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). 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.

  • assignTostring

    Optional. When provided, only tasks assigned to this user id are returned (matches assignedTo).

  • userIdstring

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

  • 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.

  • 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.

    Default: 50
  • pageTokenstring

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

List Tasks › Responses

OK

  • successboolean · required
  • itemsobject[] · required
  • nextPageTokenstring | null

Create Task

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

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

Create Task › Request Body

  • prospectIdstring · required

    Prospect id the task belongs to.

  • assignTostring · 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.

  • due

    Optional due timestamp as Unix epoch milliseconds (integer) or ISO 8601 date string. If omitted, defaults to "now".

Create Task › Responses

Created

  • successboolean · required
  • idstring
  • prospectIdstring
  • taskstring
  • assignedTostring
  • assignedBystring | null
  • createdBystring | null
  • createdAtinteger · int64

    Unix timestamp in milliseconds

  • updatedAtinteger | null · int64

    Unix timestamp in milliseconds

  • dueAtinteger | null · int64

    Unix timestamp in milliseconds

  • completedAtinteger | null · int64

    Unix timestamp in milliseconds

  • completedBystring | null
  • createdByApiboolean

    True when the task was created without a userId via API.

  • createdByApiKeyIdstring | null

    API key document id used to create the task when authenticated via API key.

  • createdByApiKeyNamestring | null

    API key display name used to create the task when authenticated via API key.

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 the task object with success status when found.

Get Task by ID › path Parameters

  • taskIdstring · required

Get Task by ID › Responses

OK

  • successboolean · required
  • idstring
  • prospectIdstring
  • taskstring
  • assignedTostring
  • assignedBystring | null
  • createdBystring | null
  • createdAtinteger · int64

    Unix timestamp in milliseconds

  • updatedAtinteger | null · int64

    Unix timestamp in milliseconds

  • dueAtinteger | null · int64

    Unix timestamp in milliseconds

  • completedAtinteger | null · int64

    Unix timestamp in milliseconds

  • completedBystring | null
  • createdByApiboolean

    True when the task was created without a userId via API.

  • createdByApiKeyIdstring | null

    API key document id used to create the task when authenticated via API key.

  • createdByApiKeyNamestring | null

    API key display name used to create the task when authenticated via API key.

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 a success payload containing the task id.

Update Task › path Parameters

  • taskIdstring · required

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.

  • assignTostring

    Updated assignee user id.

  • due

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

Additional properties are allowed

Update Task › Responses

OK

  • successboolean · required
  • idstring · required
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

Delete Task › Request Body
optional

  • userIdstring

    Optional user id requesting task deletion.

Delete Task › Responses

OK

  • successboolean · required
  • messagestring · required
NotesMeetings