Class Manager
GET /v1/agreements/

List Agreement

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\Agreement Filters: 0, 1, 2, 3

    Hide where attributes Show where attributes object
  • sort object

    App\Families\Waivers\Models\Agreement Sorting by

Responses

  • 200 application/json

    Paginated response

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

      Agreement schema

      Hide data attributes Show data attributes object
      • id string Required

        ID

      • companyId string

        Company ID

      • signatoryName string Required

        Signatory Name

      • waiverId string Required

        Waiver ID

      • familyId string Required

        Family ID

      • createdAt string(date-time) Required

        Date the Family member agreed to the Waiver

    • 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/agreements/ 
curl \
 --request GET 'https://api-dev.classmanager.io/v1/agreements/'
Response examples (200) 
{
  "data": [
    {
      "id": "agr_123123123123",
      "companyId": "cmp_12345567768",
      "signatoryName": "Signatory name",
      "waiverId": "pol_123123123123",
      "familyId": "fam_123123123123",
      "createdAt": "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": {}
}