Class Manager
GET /v1/contacts/

List Contact

Query parameters

Responses

  • 200 application/json

    Paginated response

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

      Contact schema

      Hide data attributes Show data 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 | null 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

    • 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/contacts/ 
curl \
 --request GET 'https://localhost/v1/contacts/'
Response examples (200) 
{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "total": 15,
    "count": 10,
    "perPage": 10,
    "currentPage": 1,
    "totalPages": 2
  }
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}