---
title: "List SignupTokens"
method: GET
path: "/customers/signup-tokens"
tags: ["SignupTokens"]
---

# List SignupTokens

`GET /customers/signup-tokens`

Lists every `SignupToken` you are authorised to see. Tokens are used to permit a customer
to sign up to a private `MembershipType` or non-default `MembershipRate`.

## Response `200`

The signup tokens were successfully retrieved.

- object
  - `data` SignupToken[], required
    - `id` string, required — The ID of the signup token.
    - `membership_type_id` string, required — The MembershipType this token allows signups as
    - `membership_rate_id` string, nullable, required — The MembershipRate this token allows signups as. If omitted, the default rate of the given type will be used.
    - `start_date` string, date, nullable, required — The date which the membership should start
    - `end_date` string, date, nullable, required — The date which the membership should end
    - `duration` string — The duration of the membership as an ISO8601 string. See https://en.wikipedia.org/wiki/ISO_8601#Durations
    - `max_uses` integer, nullable, required — The maximum number of times this signup token can be used. If null, it can be used an unlimited number of times. When the number of uses reaches the max_uses, it is soft-deleted.
    - `uses` integer, required — The number of times this signup token has been used.
    - `first_name` string, nullable — The first name of the customer this token allows signups as. If omitted, the customer can set a first name.
    - `last_name` string, nullable — The last name of the customer this token allows signups as. If omitted, the customer can set a last name.
    - `email` string, nullable — The email of the customer this token allows signups as. If omitted, the customer can set an email.
  - `meta` PaginationMeta — 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 — 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

## 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)