PaginatedSuccessResponse

Paginated list response format

  • data
    Type: array object[]
    required

    Array of resources for current page

    Resource object (structure varies by endpoint)

    • propertyName
      Type: anything
  • message
    Type: string
    required
  • meta
    Type: object
    required

    Pagination metadata

    • hasNextPage
      Type: boolean
      required

      Whether there is a next page

    • hasPreviousPage
      Type: boolean
      required

      Whether there is a previous page

    • page
      Type: integer
      required

      Current page number (1-indexed)

    • pageSize
      Type: integer
      required

      Number of items per page

    • total
      Type: integer
      required

      Total count of resources across all pages

    • totalPages
      Type: integer
      required

      Total number of pages

  • success
    Type: boolean
    required