Class Manager
GET /v1/families/

List Family

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\Core\Models\Family Filters: 0, 2, 3

    Hide where attributes Show where attributes object
  • sort object

    App\Families\Core\Models\Family 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.

  • includeArchived boolean

    Determines whether to return with archived records in the response.

Responses

  • 200 application/json

    Paginated response

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

      Family schema

      Hide data attributes Show data attributes object
      • id string Required

        id

      • companyId string Required

        Company ID

      • name string Required

        Name

      • joinedAt string(date) | null Required

        Joined at date

      • invitationStatus string Required

        Values are not_invited, invited, or accepted.

      • profilePicture string | null Required

        Profile Picture

      • deletedAt string(date-time) | null Required

        Deleted at date

      • archivedAt string(date-time) | null Required

        Archived at date

      • createdAt string(date-time) Required

        Created 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/families/ 
curl \
 --request GET 'https://localhost/v1/families/'
Response examples (200) 
{
  "data": [
    {
      "id": "fml_123123123123",
      "companyId": "co_123123123123",
      "name": "Potter",
      "joinedAt": "2023-12-05",
      "invitationStatus": "not_invited",
      "profilePicture": "https://",
      "deletedAt": "2023-12-05 14:30:41",
      "archivedAt": "2023-12-05 14:30:41",
      "createdAt": "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": {}
}