Checklists

View task checklists and their items

Endpoints

GET/v1/checklists/{checklist_id}
GET/v1/checklists/{checklist_id}/items
GET/v1/tasks/{task_id}/checklists

Get checklist

GET/v1/checklists/{checklist_id}

Returns the checklist with the given ID.

Parameters

Name	In	Type	Description
checklist_idrequired	path	integer (int32)	A checklist ID

Responses

200A checklist

object

checklistobject
object
checklist model
- idinteger
- namestring
- task_idinteger
- positioninteger

Example response

json

{
  "checklist": {
    "id": 0,
    "name": "string",
    "task_id": 0,
    "position": 0
  }
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

List checklist items

GET/v1/checklists/{checklist_id}/items

Returns a collection of items for the given checklist.

Parameters

Name	In	Type	Description
checklist_idrequired	path	integer (int32)	A checklist ID
page_start_id	query	integer (int32)	The page start ID.
page_limit	query	integer (int32)	The default page size

Responses

200A list of checklist items

object

checklist_itemsarray
array<object>
items
object
checklist_item model
- idinteger
- namestring
- doneboolean
- checklist_idinteger
- positioninteger

Example response

json

{
  "checklist_items": [
    {
      "id": 0,
      "name": "string",
      "done": false,
      "checklist_id": 0,
      "position": 0
    }
  ]
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

List task checklists

GET/v1/tasks/{task_id}/checklists

Returns a collection of checklists for the given task.

Parameters

Name	In	Type	Description
page_start_id	query	integer (int32)	The page start ID.
page_limit	query	integer (int32)	The default page size
task_idrequired	path	integer (int32)	A task ID

Responses

200A list of checklists

object

checklistsarray
array<object>
items
object
checklist model
- idinteger
- namestring
- task_idinteger
- positioninteger

Example response

json

{
  "checklists": [
    {
      "id": 0,
      "name": "string",
      "task_id": 0,
      "position": 0
    }
  ]
}

400Invalid parameters

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

401Unauthorized

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

403API access is only for organizations on an active plan

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

404Could not find record

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}

429Rate limit exceeded

object

HubstaffTasks_Public_V1_Entities_Error model

codestring
Error code
errorstring
Descriptive error message

Example response

json

{
  "code": "string",
  "error": "string"
}