Skip to main content

[API Endpoint] Goals

Samantha L Cook
Updated 
https://teachboost.com/api/v1/goals
  • 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
  • type_id: Integer, used to optionally return Goals of a specific type in Goal Types. If you pass in 0 for this field, only basic goals will be returned.

Sample Object

{
    id: 4100,
    group_id: 10,
    user_id: 10000,
    created_by: 10001,
    class: 'goal',
    type_id: 12,
    title: '',
    description: 'Work: Monitoring of student behavior',
    competencies: [
        '211-6.2'
    ],
    is_archived: false,
    is_approved: true,
    archived_on: null,
    approved_on: '2016-03-03 12:10:52',
    created_on: '2016-01-11 11:43:43',
    activated_on: '2016-01-11 11:43:43',
    last_modified: '2016-04-05 06:43:43'
}

Dictionary

  • id: Integer, internal ID for the object
  • group_id: Integer, ID of Group this Goal was created in
  • user_id: Integer, staff whom this Goal was added for
  • created_by: Integer, staff member who created this Goal
  • class: String, one of 'goal' or 'sgo'
  • type_id: Integer, optional custom goal type set for this Goal relating to a type in Goal Types
  • title: String, optional title for the Goal
  • description: String, full text description of the Goal
  • competencies: Array of Strings, list of any attached Competencies
  • is_archived: Bool, if the Goal has been marked 'archived'
  • is_approved: Bool, if the Goal has been marked 'approved'
  • archived_on: DateTime, if the Goal is archived, this is the date of archival. Can be NULL.
  • approved_on: DateTime, if the Goal is approved, this is the data of approval. Can be NULL.
  • created_on: DateTime, date the Goal was created
  • activated_on: DateTime, date the Goal was created, or re-opened if it was previously archived
  • last_modified: DateTime, last date that the Goal was modified in any way

Related articles