Retrieve a list of health items with optional search and pagination

GET /api/v1/health

Fetches a paginated list of health items, optionally filtered by a search query. Provides pagination metadata including total items, total pages, current page, and page size.

Query parameters

  • q string

    Optional search query to filter health items by name

  • page integer

    Page number to retrieve (defaults to 1)

    Default value is 1.

  • size integer

    Number of items per page, with a maximum of 200

    Maximum value is 200. Default value is 20.

Responses

  • 200 application/json

    A paginated list of health items was successfully retrieved

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

      List of health items matching the search query

      Hide data attributes Show data attributes object
      • id integer

        Unique identifier of the health item

      • name string

        Name of the health item

    • pagination object

      Pagination metadata

      Additional properties are allowed.

      Hide pagination attributes Show pagination attributes object
  • 500

    Failed to fetch health items due to a server error

GET /api/v1/health 
curl \
 -X GET https://ark.collegecanine.com/api/v1/health
Response examples (200) 
{
  "data": [
    {
      "id": 42,
      "name": "string"
    }
  ],
  "pagination": {
    "totalItems": 42,
    "totalPages": 42,
    "currentPage": 42,
    "pageSize": 42
  }
}