Class Manager
GET /v1/contacts/receives-additional

Search Contact

Query parameters

  • where object

    Filter conditions

    Hide where attributes Show where attributes object
    • studentId object

      Filter by Season ID

      Hide studentId attribute Show studentId attribute object
      • in array[string]

        Filter by ID in array

    • familyId object

      Filter by Family ID

      Hide familyId attribute Show familyId attribute object
      • in array[string]

        Filter by ID in array

    • classId object

      Filter by Class ID

      Hide classId attribute Show classId attribute object
      • in array[string]

        Filter by ID in array

    • seasonId object

      Filter by Season ID

      Hide seasonId attribute Show seasonId attribute object
      • in array[string]

        Filter by ID in array

Responses

  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 200 application/json

    List collection response

    Hide response attributes Show response attributes object
    • id string Required

      id

    • companyId string Required

      Company ID

    • familyId string Required

      Family ID

    • firstname string Required

      Firstname

    • lastname string | null Required

      Lastname

    • email string | null Required

      Email

    • relation string Required

      Values are parent, grandparent, guardian, sibling, or other.

    • phone string | null Required

      Phone number

    • isPrimary boolean Required

      Is primary

    • isEmergency boolean Required

      Is emergency

    • isBilling boolean Required

      Is billing

    • isAdditional boolean Required

      Is additional

    • deletedAt string(date-time) | null Required

      Deleted at date

    • archivedAt string(date-time) | null Required

      Archived at date
  • 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/contacts/receives-additional 
curl \
 --request GET 'https://classmanager.test/v1/contacts/receives-additional'
Response examples (422) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (200) 
[
  {
    "id": "stn_123123123123",
    "companyId": "co_123123123123",
    "familyId": "fml_123123123123",
    "firstname": "John",
    "lastname": "Doe",
    "email": "john@doe",
    "relation": "parent",
    "phone": "(123) 456 7890",
    "isPrimary": false,
    "isEmergency": false,
    "isBilling": false,
    "isAdditional": true,
    "deletedAt": "2023-12-05 14:30:41",
    "archivedAt": "2023-12-05 14:30:41"
  }
]
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}