---
title: "List a plan's access codes"
method: GET
path: "/v1/projects/{project}/plans/{plan}/access-codes"
tags: ["Access Codes"]
---

# List a plan's access codes

`GET /v1/projects/{project}/plans/{plan}/access-codes`

## Request

- Base URL: `https://api.subscriby.net`
- URL: `https://api.subscriby.net/v1/projects/{project}/plans/{plan}/access-codes`
- Auth: HTTP bearer

Pages the plan's codes, newest first, fifty per page unless you say otherwise. `status` narrows the list to `unredeemed`, `redeemed` or `expired` codes; the default `all` returns every state.

Raw `access_code` values are **always masked** in API responses to the last 5 characters. Plaintext codes ship only through the creator dashboard CSV export or the per-code messages a batch can be delivered as.

## Path parameters

- `project` string, uuid, required
- `plan` string, uuid, required

## Query parameters

- `limit` integer
- `status` string
- `page` integer
- `per_page` integer
- `sort_by` string
- `sort_direction` 'asc' | 'desc'

## Response `200`

The page.

- object
  - `data` AccessCodeResource[], required: The items on this page.
    - `id` string, required: The code's id, the value the revoke endpoint takes.
    - `plan_id` string, required: The plan the code activates.
    - `subscriber_id` string, nullable, required: The member who redeemed the code; null while it is unredeemed.
    - `code_masked` union, required: The code with every character but the last five replaced by `*`. The plaintext ships only through the dashboard export or the messages the batch was delivered as.
      - string
      - ''
    - `expires_at` string, nullable, required: When an unredeemed code stops working, ISO 8601; null for a code that never expires.
    - `redeemed_at` string, nullable, required: When a subscriber claimed the code, ISO 8601; null while it is unredeemed.
    - `created_at` string, nullable, required: When the batch was generated, ISO 8601.
  - `links` object, required: Links to the first, last, previous and next pages.
    - `first` string, nullable, required: The first page's URL.
    - `last` string, nullable, required: The last page's URL.
    - `prev` string, nullable, required: The previous page's URL; null on the first page.
    - `next` string, nullable, required: The next page's URL; null on the last page.
  - `meta` object, required: The paging counters for this page.
    - `current_page` integer, required: The page returned, 1-indexed.
    - `from` integer, nullable, required: The 1-indexed position of this page's first item across every page; null when the page is empty.
    - `last_page` integer, required: How many pages there are.
    - `links` object[], required: Generated paginator links.
      - `url` string, nullable, required: The page's URL; null for the ellipsis and the disabled arrows.
      - `label` string, required: The link's label: a page number, the previous or next arrow, or an ellipsis.
      - `active` boolean, required: Whether this link is the current page.
    - `path` string, nullable, required: Base path for paginator generated URLs.
    - `per_page` integer, required: Number of items shown per page.
    - `to` integer, nullable, required: Number of the last item in the slice.
    - `total` integer, required: Total number of items being paginated.

## Other responses

- `401`: `AUTHENTICATION_REQUIRED`: the request carries no bearer token, or one that is revoked, malformed, or minted for another environment (an `sbt_test_` token on production).
- `403`: `TOKEN_MISSING_ABILITY`: the token is valid but does not carry the ability this endpoint requires; `error.context.required_ability` names the one to grant. An endpoint that also checks who owns a row or which tier the account is on answers `FORBIDDEN`, `TEAM_TIER_REQUIRED` or `CONNECTOR_TIER_REQUIRED` with the same status, and says so in its own description.
- `404`: `RESOURCE_NOT_FOUND`: an id in the path names nothing the token can see. `TENANT_MISMATCH`: the project sits outside the token's `scope:project:` allow-list, or the token carries no team scope. Both answer 404 rather than 403 so that existence outside the token's scope cannot be inferred.
- `429`: `RATE_LIMITED`: the token has spent its 300 requests a minute or 10,000 an hour; `Retry-After` says when the next one is accepted.

---

[API](https://skmtc.dev/memberpass/apis/subscriby-rest-api.md) · [All operations](https://skmtc.dev/memberpass/apis/subscriby-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/memberpass/apis/subscriby-rest-api/revisions/59c4df91d764?raw)