Skip to content

Get redemption types

Request

Get all available redemption types for client reference. Requires valid project API key. Use pagination parameters (page & limit) for optimal performance. Legacy support: returns array without params (deprecated - will be removed in future).

Security
projectKey
Query
pagestring

Page number for pagination (1-based)

limitstring

Number of items per page

curl -i -X GET \
  'https://docs.pers.ninja/_mock/swagger/redemptions/types?page=string&limit=string' \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Redemption types retrieved

Bodyapplication/json
Array [
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

baseRequiredUserFieldsArray of strings

Base required user fields for all redemptions of this type. Can include built-in field keys (email, firstName) or custom field definition UUIDs.

Default:[]
bookingRequirementobject or null(BookingRequirementConfigDTO)

Default booking requirement config for all redemptions of this type. Individual redemptions can override.

idnumberrequired

Redemption type id

]
Response
[
  {
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "baseRequiredUserFields": [],
    "bookingRequirement": { … },
    "id": 0
  }
]