Retrieve a list of purchasable items with optional search and pagination

GET /api/v1/purchasable

Fetches a paginated list of purchasable items, filtered by an optional search query. Returns pagination details including total items, total pages, current page, and page size.

Query parameters

  • q string

    Optional search query to filter purchasable items by name

  • page integer

    The page number to retrieve, defaults to 1

    Default value is 1.

  • size integer

    The number of items per page, with a maximum limit of 200

    Maximum value is 200. Default value is 20.

Responses

  • 200 application/json

    Successfully retrieved a paginated list of purchasable items

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

      List of purchasable items matching the search criteria

      Hide data attributes Show data attributes object
      • id integer

        Unique identifier of the purchasable item

      • name string

        Name of the purchasable item

    • pagination object

      Pagination metadata

      Additional properties are allowed.

      Hide pagination attributes Show pagination attributes object
  • 500

    Failed to fetch purchasable items due to a server error

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