Class Manager
GET /v1/staff/

List Staff

Query parameters

  • page number

    Current page

  • pageSize number

    Number of items per page

  • selectAll boolean

    Determines if all items are selected

  • where object

    App\Staff\Core\Models\Staff Filters: 0, 2, 3

    Hide where attributes Show where attributes object
  • sort object

    App\Staff\Core\Models\Staff Sorting by firstname, lastname, createdAt

    Hide sort attributes Show sort attributes object
    • firstname string

      Values are asc or desc.

    • lastname string

      Values are asc or desc.

    • createdAt string

      Values are asc or desc.

  • onlyArchived boolean

    Determines whether to return only archived records in the response.

Responses

  • 200 application/json

    Paginated response

    Hide response attributes Show response attributes object
    • data array[object] Required

      Staff schema

      Hide data attributes Show data attributes object
      • id string Required

        id

      • companyId string Required

        Company ID

      • firstname string Required

        First name

      • lastname string Required

        Last name

      • email string | null Required

        Email address

      • phone string | null Required

        Phone number

      • permissionSet string | null Required

        Values are family, admin, owner, assistant, manager, instructor, or none.

      • jobTitle string | null Required

        Job title

      • invitationStatus string Required

        Values are not_invited, invited, or accepted.

      • archivedAt string(date-time) | null Required

        Archived at date

      • deletedAt string(date-time) | null Required

        Deleted at date

      • joinedAt string(date) | null Required

        Joined at date

      • createdAt string(date-time) | null Required

        Created at date

      • profilePicture string | null Required

        Profile Picture

    • pagination object Required

      Pagination schema

      Hide pagination attributes Show pagination attributes object
      • total integer Required

        Total number of items

      • count integer Required

        Number of items on this page

      • perPage integer

        Number of items per page

      • currentPage integer

        Current page number

      • totalPages integer

        Total number of pages
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/staff/ 
curl \
 --request GET 'https://api-dev.classmanager.io/v1/staff/'
Response examples (200) 
{
  "data": [
    {
      "id": "stf_123123123123",
      "companyId": "co_123123123123",
      "firstname": "John",
      "lastname": "Doe",
      "email": "john@example.com",
      "phone": "(123) 456 7890",
      "permissionSet": "family",
      "jobTitle": "Teacher",
      "invitationStatus": "not_invited",
      "archivedAt": "2023-12-05 14:30:41",
      "deletedAt": "2023-12-05 14:30:41",
      "joinedAt": "2023-12-05",
      "createdAt": "2023-12-05 14:30:41",
      "profilePicture": "https://"
    }
  ],
  "pagination": {
    "total": 15,
    "count": 10,
    "perPage": 10,
    "currentPage": 1,
    "totalPages": 2
  }
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}