Skip to content

PERS-api docs (2.0.7)

Download OpenAPI description
swagger.json
swagger.yaml
Overview
Languages
Servers
Mock server
https://docs.pers.ninja/_mock/swagger/
https://explorins-loyalty.ngrok.io/
https://api.pers.ninja/v2/

Tenants

Operations

Admins

Operations

Administrative Management

Administrative user management for tenant administrators. Handles admin authentication, permissions, and tenant-level administrative operations with secure access controls.
Admin Features:

•
Admin Authentication:
Secure admin login and session management

•
Permission Management:
Role-based access control for administrative functions

•
Tenant Administration:
Full tenant configuration and management capabilities

•
Security Controls:
Enhanced security measures for administrative access

•
Multi-Level Access:
Support for different administrative privilege levels

Get all admins

Request

ADMIN: Retrieve all admins associated with the current tenant

Security
tenantAdminJWT
curl -i -X GET \
  https://docs.pers.ninja/_mock/swagger/admins \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Admins retrieved successfully

Bodyapplication/jsonArray [
idstringrequired

Id of the admin

emailstringrequired

Email of the admin

displayNameobjectrequired

Display name of the admin

typestringrequired

Type of the admin

Enum"SUPER_ADMIN""TENANT_ADMIN"
tenantsArray of objects(TenantDTO)

Tenant of the admin

]
Response
application/json
[
  {
    "id": "string",
    "email": "string",
    "displayName": {},
    "type": "SUPER_ADMIN",
    "tenants": [ … ]
  }
]

Create or update admin

Request

ADMIN: Create a new admin or update an existing admin within the tenant scope

Security
tenantAdminJWT
Bodyapplication/jsonrequired
emailstringrequired

Email of the admin

displayNamestring

Display name of the admin

typestringrequired

Type of the admin

Enum"SUPER_ADMIN""TENANT_ADMIN"
curl -i -X POST \
  https://docs.pers.ninja/_mock/swagger/admins \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "string",
    "displayName": "string",
    "type": "SUPER_ADMIN"
  }'

Responses

Admin created or updated successfully

Bodyapplication/json
idstringrequired

Id of the admin

emailstringrequired

Email of the admin

displayNameobjectrequired

Display name of the admin

typestringrequired

Type of the admin

Enum"SUPER_ADMIN""TENANT_ADMIN"
tenantsArray of objects(TenantDTO)

Tenant of the admin

Response
application/json
{
  "id": "string",
  "email": "string",
  "displayName": {},
  "type": "SUPER_ADMIN",
  "tenants": [
    { … }
  ]
}

Toggle admin-tenant association

Request

ADMIN: Associate or disassociate the specified admin with the current tenant. This affects admin tenant access.

Security
tenantAdminJWT
Path
adminIdstringrequired
curl -i -X PUT \
  'https://docs.pers.ninja/_mock/swagger/admins/{adminId}/tenant' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Admin-tenant association updated successfully

Bodyapplication/json
idstringrequired

Id of the admin

emailstringrequired

Email of the admin

displayNameobjectrequired

Display name of the admin

typestringrequired

Type of the admin

Enum"SUPER_ADMIN""TENANT_ADMIN"
tenantsArray of objects(TenantDTO)

Tenant of the admin

Response
application/json
{
  "id": "string",
  "email": "string",
  "displayName": {},
  "type": "SUPER_ADMIN",
  "tenants": [
    { … }
  ]
}

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

webhooks

Business Types

Operations

Redemption Types

Operations

Redemption Redeems

Operations

Redemption Tokens

Operations

API Keys

Operations