Class Manager
GET /v1/custom-fields/

List Custom Field

Query parameters

  • page number

    Current page

  • pageSize number

    Number of items per page

  • selectAll boolean

    Determines if all items are selected

  • where object

    App\CustomFields\Core\Models\CustomField Filters: 0

    Hide where attribute Show where attribute object
  • sort object

    App\CustomFields\Core\Models\CustomField Sorting by title

    Hide sort attribute Show sort attribute object
    • title string

      Values are asc or desc.

Responses

  • 200 application/json

    Paginated response

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

      CustomField schema

      Hide data attributes Show data attributes object
      • id string Required

        id

      • companyId string Required

        Company ID

      • type string Required

        Values are text, textarea, number, select, multiselect, date, or bool.

      • title string Required

        Title

      • entity string Required

        Values are staff, student, or family.

      • options array[string] | null Required

        Options

    • 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/custom-fields/ 
curl \
 --request GET 'https://classmanager.test/v1/custom-fields/'
Response examples (200) 
{
  "data": [
    {
      "id": "cf_123123123123",
      "companyId": "co_123123123123",
      "type": "text",
      "title": "Custom Field Title",
      "entity": "staff",
      "options": [
        "answer1",
        "answer2"
      ]
    }
  ],
  "pagination": {
    "total": 15,
    "count": 10,
    "perPage": 10,
    "currentPage": 1,
    "totalPages": 2
  }
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}