Skip to main content

[API Endpoint] Tasks

Samantha Cook
Updated

Tasks are also known as Next Steps or Action Steps within Boost.

https://app.teachboost.com/api/v1/tasks
  • 10 requests are allowed every 60 seconds.

Options

  • offset: Integer, default is 0
  • limit: Integer, default and max is 100
  • start_date: DateTime
  • end_date: DateTime

Sample Object

{
    id: 1209,
    group_id: 10,
    user_id: 10000,
    created_by: 10001,
    is_complete: true,
    is_archived: false,
    object_id: 4100,
    object_type: 'goal',
    description: 'Attend PD session',
    date_due: '2016-02-10 00:00:00',
    created_on: '2016-01-07 14:51:13',
    completed_on: '2016-02-07 14:52:21'
}

Dictionary

  • id: Integer, internal ID for the object
  • group_id: Integer, ID of Group this Task was created in
  • user_id: Integer, staff whom this Task was added for
  • created_by: Integer, staff member who created this Task
  • is_complete: Bool, if the Task has been marked 'complete'
  • is_archived: Bool, if the Task has been marked 'archived'
  • object_id: Integer, internal ID of the associated object, if there is one
  • object_type: String, can be one of 'goal', 'form', or 'user'
  • description: String, the text of the Task
  • date_due: DateTime, optional due date set by creator
  • created_on: DateTime, when the Task was created
  • completed_on: DateTime, id the task is complete, this is the date it was completed

Related articles