Skip to content

PERS-api docs (2.0.5)

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Languages
Servers
Mock server

https://docs.pers.ninja/_mock/swagger/

https://api.pers.ninja/v2/

Tenants

Operations

Admins

Operations

Tokens

Operations

Campaigns

Operations

Campaign Tags

Operations

Campaign Tokens

Operations

Campaign Triggers

Operations

Campaign Engagements

Operations

Campaign Claims

Operations

Redemptions

Operations

Purchases

Operations

Businesses

Operations

Transactions

Operations

Users

Operations

Balances

Operations

Files

Operations

Web3 Chains

Operations

Contracts

Operations

Auth

Operations

Root

Operations

Well-known

Operations

Business Types

Operations

Redemption Redeems

Operations

Redemption Types

Operations

Get redemption types

Request

Get all available redemption types for client reference. Requires valid project API key.

Security
projectKey
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/redemption-types \
  -H 'x-project-key: YOUR_API_KEY_HERE'

Responses

Redemption types retrieved

Bodyapplication/jsonArray [
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

idnumberrequired

Redemption type id

]
Response
application/json
[
  {
    "name": "string",
    "description": "string",
    "imageUrl": "string",
    "id": 0
  }
]

Create redemption type (Admin)

Request

Create a new redemption type for system configuration. Replaces POST /redemption/admin/type

Security
tenantAdminJWT
Bodyapplication/jsonrequired
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/redemption-types \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "description": "string",
    "imageUrl": "string"
  }'

Responses

Redemption type created successfully

Bodyapplication/json
namestringrequired

Redemption type name

descriptionstring

Redemption type description

imageUrlstring

Redemption type image url

idnumberrequired

Redemption type id

Response
application/json
{
  "name": "string",
  "description": "string",
  "imageUrl": "string",
  "id": 0
}

Redemption Tokens

Operations