HiringCenter Pro
HiringCenter Pro API

Tasks

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

Operations for tasks assigned to other users.


List Tasks

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

List Tasksquery Parameters

  • accountIdstring

    If omitted, uses authenticated account

  • prospectIdstring
  • assignTostring
  • userIdstring

    Filters by creator (createdBy)

  • statusstring · enum
    Enum values:
    open
    completed
    all
    Default: open
  • dueAfterstring
  • dueBeforestring
  • limitinteger
    Default: 50
  • pageTokenstring

List TasksHeaders

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

List Tasks Responses

OK

  • itemsobject[]
  • nextPageTokenstring

Get Task by ID

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

Get Task by IDpath Parameters

  • taskIdstring · required

Get Task by IDquery Parameters

  • accountIdstring

Get Task by IDHeaders

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Get Task by ID Responses

OK

  • idstring
  • prospectIdstring
  • taskstring
  • assignTostring
  • assignedBystring
  • createdBystring
  • createdAtinteger · int64
  • updatedAtinteger | null · int64
  • dueAtinteger | null · int64
  • completedAtinteger | null · int64
  • completedBystring | null
Additional properties are allowed

Update or Complete Task

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

Update or Complete Taskpath Parameters

  • taskIdstring · required

Update or Complete TaskHeaders

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Update or Complete Task Request Body

  • accountIdstring
  • completeboolean
  • taskstring
  • assignTostring
  • assignedTostring
  • duestring
  • userIdstring

Update or Complete Task Responses

OK

  • idstring
  • prospectIdstring
  • taskstring
  • assignTostring
  • assignedBystring
  • createdBystring
  • createdAtinteger · int64
  • updatedAtinteger | null · int64
  • dueAtinteger | null · int64
  • completedAtinteger | null · int64
  • completedBystring | null
Additional properties are allowed

Delete Task

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

Delete Taskpath Parameters

  • taskIdstring · required

Delete TaskHeaders

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Delete Task Request Body

  • accountIdstring
  • userIdstring

Delete Task Responses

OK

  • messagestring

Create Task for Prospect

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

Create Task for Prospectpath Parameters

  • prospectIdstring · required

Create Task for ProspectHeaders

  • Authorizationstring · required

    Bearer API key in the format 'Bearer <YOUR_API_KEY>'

Create Task for Prospect Request Body

  • accountIdstring
  • userIdstring
  • taskstring
  • assignTostring
  • assignedTostring
  • duestring

Create Task for Prospect Responses

Created

  • idstring
  • prospectIdstring
  • taskstring
  • assignTostring
  • assignedBystring
  • createdBystring
  • createdAtinteger · int64
  • updatedAtinteger | null · int64
  • dueAtinteger | null · int64
  • completedAtinteger | null · int64
  • completedBystring | null
Additional properties are allowed