Class Manager
GET /v1/users/

List User

Query parameters

  • page number

    Current page

  • pageSize number

    Number of items per page

  • selectAll boolean

    Determines if all items are selected

  • where object

    App\Users\Core\Models\User Filters: 0

    Hide where attribute Show where attribute object
  • sort object

    App\Users\Core\Models\User Sorting by

  • onlyArchived boolean

    Determines whether to return only archived records in the response.

  • includeArchived boolean

    Determines whether to return with archived records in the response.

Responses

  • 200 application/json

    Paginated response

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

      User schema

      Hide data attributes Show data attributes object
      • id string Required

        id

      • firstname string | null Required

        Firstname

      • lastname string | null Required

        Lastname

      • email string Required

        User email

      • emailVerifiedAt string | null Required

        User email verified at

    • 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/users/ 
curl \
 --request GET 'https://classmanager.test/v1/users/'
Response examples (200) 
{
  "data": [
    {
      "id": "usr_123123123123",
      "firstname": "John",
      "lastname": "Doe",
      "email": "new Email(john@example.com)",
      "emailVerifiedAt": "2023-11-08 14:05:51"
    }
  ],
  "pagination": {
    "total": 15,
    "count": 10,
    "perPage": 10,
    "currentPage": 1,
    "totalPages": 2
  }
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}