---
title: "List Benefit Grants"
method: GET
path: "/v1/customer-portal/benefit-grants/"
tags: ["customer_portal", "benefit-grants", "public"]
---

# List Benefit Grants

`GET /v1/customer-portal/benefit-grants/`

## Request

- Base URL: `https://api.polar.sh`
- URL: `https://api.polar.sh/v1/customer-portal/benefit-grants/`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

List benefits grants of the authenticated customer.

**Scopes**: `customer_portal:read` `customer_portal:write`

## Query parameters

- `query` string, nullable: Filter by benefit description.
- `type` union: Filter by benefit type.
  - 'custom' | 'discord' | 'github_repository' | 'downloadables' | 'license_keys' | 'meter_credit' | 'feature_flag' | 'slack_shared_channel'
  - BenefitType[]
- `benefit_id` union: Filter by benefit ID.
  - string, uuid4
  - string[]
- `checkout_id` union: Filter by checkout ID.
  - string, uuid4
  - string[]
- `order_id` union: Filter by order ID.
  - string, uuid4: The order ID.
  - string[]
- `subscription_id` union: Filter by subscription ID.
  - string, uuid4: The subscription ID.
  - string[]
- `member_id` union: Filter by member ID.
  - string, uuid4
  - string[]
- `page` integer: Page number, defaults to 1.
- `limit` integer: Size of a page, defaults to 10. Maximum is 100.
- `sorting` CustomerBenefitGrantSortProperty[], nullable: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.

## Response `200`

Successful Response

- ListResourceCustomerBenefitGrant
  - `items` CustomerBenefitGrant[], required
    - union
      - CustomerBenefitGrantDiscord (unresolved $ref)
      - CustomerBenefitGrantGitHubRepository (unresolved $ref)
      - CustomerBenefitGrantDownloadables (unresolved $ref)
      - CustomerBenefitGrantLicenseKeys (unresolved $ref)
      - CustomerBenefitGrantCustom (unresolved $ref)
      - CustomerBenefitGrantMeterCredit (unresolved $ref)
      - CustomerBenefitGrantFeatureFlag (unresolved $ref)
      - CustomerBenefitGrantSlackSharedChannel (unresolved $ref)
  - `pagination` Pagination, required
    - `total_count` integer, required
    - `max_page` integer, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/polar/apis/polar-api.md) - [All operations](https://skmtc.dev/polar/apis/polar-api/llms.txt) - [OpenAPI document](https://skmtc.dev/polar/apis/polar-api/revisions/77e4ef94fcc3?raw)