GET educators

Description

Returns a list with educators. The query supports Paging and Sorting. Only Admin user can list information of all educators.

Parameters

page: integer The page number.
limit: integer The number of items to return.
sort: array[string] Contains the names of the attributes, separated by commas, that will be used to sort the result of the query. For ascending sort, use the '+' character before the attribute name. For descending sort, use the '-' character before the attribute name. By default, the order is ascending, so the '+' symbol is optional, just enter the attribute.

URL

GET https://localhost:3001/v1/educators

Curl example

curl -X GET "https://localhost:3001/v1/educators?page=1&limit=20" -H "accept: application/json" -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response body

• 200 Successful requisition.

  [
    {
      "id": "5db06595e59316737e2878a2",
      "username": "educator01",
      "institution_id": "5db05279fcfefe5c3de20497",
      "children_groups": [
        {
          "id": "5db065a5e59316737e2878a3",
          "name": "Group One",
          "children": [
            {
              "id": "5db05289fcfefe5c3de20498",
              "username": "BR0001",
              "institution_id": "5db05279fcfefe5c3de20497",
              "gender": "male",
              "age": 11
            }
          ],
          "school_class": "4th Grade"
        }
      ]
    }
  ]

• 401 Authentication Error

• 403 Permission Error

• 429 Too Many Requests Error

• 500 Internal Server Error