Skip to main content

[API Endpoint] Users

Samantha L Cook
Updated

The users endpoint returns all user accounts that have ever had a role in any associated groups. Note that this includes any inactive users or users with no current group permission.

https://teachboost.com/api/v1/users
  • 15 requests are allowed every 60 seconds.

Options

  • offset: Integer, default is 0
  • limit: Integer, default and max is 100
  • time_period: String, the key of the time period

Sample Object

{
    id: 122404,
    email: 'mike@teachboost.com',
    fname: 'Mike',
    lname: 'Gioia',
    full_name: 'Mike Gioia',
    resource_id: '001002',
    title: '',
    last_login: '2016-11-01 09:15:23',
    tags: [
        'Math Department', 'New Teachers'
    ],
    grades: [
        4, 5, 6
    ],
    targets: [
        'Option 1: 3 Informal Obs.'
    ],
    caseload_tags: [],
    group_access: [
        10: 2
        25527: 1
        25645: 1
        25653: 4
    ],
    roles: [
        10: [
            2015: 2,
            2016: 2
        ],
        25527: [
            2015: 2,
            2016: 1
        ]
        25645: [
            2015: 1,
            2016: 1
        ]
        25653: [
            2015: 3,
            2016: 4
        ]
    ]
}

Dictionary

  • id: Integer, internal ID for the object
  • email: String, email address of the User
  • fname: String, first name
  • lname: String, last name
  • full_name: String, combined first and last name
  • resource_id: String, customer-supplied ID for the staff member
  • title: String, personal title or suffix
  • last_login: DateTime, last active session for this User
  • tags: Array of Strings, collection of tags that have been applied to this staff member
  • grades: Array of Strings, collection of grade levels that have been applied to this staff member
  • targets: Array of Strings, collection of observation targets that have been applied to this staff member
  • caseload_tags: Array of Strings, collection of caseloads that have been applied to this staff member
  • group_access: Array of Integers, this collection consists of two parts: the key being the Group ID, and the value being the access level this User has for the corresponding Group. Access levels range from 1 to 4 and correlate to the Levels of permission within Boost. These values represent the current access level the User has for the given Group. See roles for this historical information.
  • roles: Array of Objects, this collection consists of items indexed first by the Group ID, and then containing pairs of time periods and access levels. For example, "2015" would be the 2015 academic year, and "2" would mean they have Level 2 access for the corresponding group in the 2015 academic year. These values can change depending on the academic year.

Related articles