Class Manager
GET /v1/waivers/

List Waiver

Query parameters

  • page number

    Current page

  • pageSize number

    Number of items per page

  • selectAll boolean

    Determines if all items are selected

  • where object

    App\Families\Waivers\Models\Waiver Filters: 0, 1, 2

    Hide where attributes Show where attributes object
  • sort object

    App\Families\Waivers\Models\Waiver Sorting by name, createdAt

    Hide sort attributes Show sort attributes object
    • name 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

      Waiver schema

      Hide data attributes Show data attributes object
      • id string Required

        Prefixed ID for the Waiver

      • name string Required

        A title for the Waiver

      • content string Required

        The Waiver contents

      • type string Required

        Values are terms-and-conditions, privacy-policy, or custom.

      • isLocked boolean Required

        Whether the Waiver can be archived/deleted or have it's title changed

      • companyId string Required

        Company ID

      • archivedAt string(date-time) | null Required

        Archived at date

      • createdAt string(date-time) Required

        Created date

      • updatedAt string(date-time) Required

        Last updated date

    • 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/waivers/ 
curl \
 --request GET 'https://api.classmanager.io/v1/waivers/'
Response examples (200) 
{
  "data": [
    {
      "id": "wvr_123123123123",
      "name": "Refund waiver",
      "content": "Potentially some really long content with no HTML tags",
      "type": "terms-and-conditions",
      "isLocked": true,
      "companyId": "co_123123123123",
      "archivedAt": "2024-06-12T09:39:49.000000Z",
      "createdAt": "2024-06-12T09:39:49.000000Z",
      "updatedAt": "2024-06-12T09:39:49.000000Z"
    }
  ],
  "pagination": {
    "total": 15,
    "count": 10,
    "perPage": 10,
    "currentPage": 1,
    "totalPages": 2
  }
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}