---
title: "List membership credits"
method: GET
path: "/shop/reports/membership-credits"
tags: ["Reports"]
---

# List membership credits

`GET /shop/reports/membership-credits`

Use this endpoint to retrieve a paginated list of membership credits.

## Query parameters

- `site_id` string, uuid
- `page` integer

## Response `200`

The list of items was successfully retrieved

- ListMembershipCreditsResponse
  - `data` MembershipCreditItem[], required
    - `id` string, uuid, required — The ID of the item.
    - `membership_number` string — The membership number associated with the membership credit.
    - `customer_id` string, uuid — The ID of the customer associated with the membership credit.
    - `first_name` string, required — The first name of the customer associated with the membership credit.
    - `last_name` string, required — The last name of the customer associated with the membership credit.
    - `email` string, email, required — The email of the customer associated with the membership credit.
    - `total_credits` integer, required — The total number of credits available on this membership.
    - `multi_use_credits` integer, required — The number of multi-use credits available on this membership.
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set
  - `totals` MembershipCreditItemTotals, required
    - `total_memberships` integer — The total number of memberships.
    - `total_credits` integer — The total number of credits across all memberships.
    - `total_multi_use_credits` integer — The total number of multi-use credits across all memberships.

## Other responses

- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)