Orishare
Api

List rewards with issued counts

GET
/rewards

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Query Parameters

status?string

Value in

  • "active"
  • "archived"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rewards"
{  "data": [    {      "id": "string",      "name": "string",      "cost": 0,      "currency": "string",      "availability": 0,      "issued": 0,      "expiry_after": "string",      "status": "active",      "version": 0,      "created_at": "string",      "updated_at": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Create a reward

POST
/rewards

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/rewards" \  -H "Content-Type: application/json" \  -d '{    "name": "Free audiobook",    "cost": 500,    "currency": "points",    "availability": 100,    "expiry_after": "30d"  }'
{  "id": "string",  "name": "string",  "cost": 0,  "currency": "string",  "availability": 0,  "issued": 0,  "expiry_after": "string",  "status": "active",  "version": 0,  "created_at": "string",  "updated_at": "string"}

One reward

GET
/rewards/{id}

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/rewards/string"
{  "id": "string",  "name": "string",  "cost": 0,  "currency": "string",  "availability": 0,  "issued": 0,  "expiry_after": "string",  "status": "active",  "version": 0,  "created_at": "string",  "updated_at": "string"}

Edit or archive a reward (availability cannot drop below issued)

PATCH
/rewards/{id}

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/rewards/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "cost": 0,  "currency": "string",  "availability": 0,  "issued": 0,  "expiry_after": "string",  "status": "active",  "version": 0,  "created_at": "string",  "updated_at": "string"}

Delete a never-issued, unreferenced reward

DELETE
/rewards/{id}

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/rewards/string"
Empty

List issuances

GET
/reward_issuances

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
cursor?string
Lengthlength <= 2048
customer_id?string
reward_id?string
status?string

Value in

  • "issued"
  • "redeemed"
  • "cancelled"
  • "expired"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reward_issuances"
{  "data": [    {      "id": "string",      "reward_id": "string",      "customer_id": "string",      "status": "issued",      "source_type": "rule_execution",      "source_id": "string",      "cost_entry_id": "string",      "expires_at": "string",      "redeemed_at": "string",      "cancelled_at": "string",      "version": 0,      "created_at": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Issue a reward to a customer manually (counts against availability)

POST
/reward_issuances

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/reward_issuances" \  -H "Content-Type: application/json" \  -d '{    "reward_id": "rw_123",    "customer_id": "cust_123"  }'
{  "id": "string",  "reward_id": "string",  "customer_id": "string",  "status": "issued",  "source_type": "rule_execution",  "source_id": "string",  "cost_entry_id": "string",  "expires_at": "string",  "redeemed_at": "string",  "cancelled_at": "string",  "version": 0,  "created_at": "string"}

One issuance

GET
/reward_issuances/{id}

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/reward_issuances/string"
{  "id": "string",  "reward_id": "string",  "customer_id": "string",  "status": "issued",  "source_type": "rule_execution",  "source_id": "string",  "cost_entry_id": "string",  "expires_at": "string",  "redeemed_at": "string",  "cancelled_at": "string",  "version": 0,  "created_at": "string"}

Redeem: issued → redeemed, spending the reward cost in the same transaction

POST
/reward_issuances/{id}/redeem

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/reward_issuances/string/redeem"
{  "id": "string",  "reward_id": "string",  "customer_id": "string",  "status": "issued",  "source_type": "rule_execution",  "source_id": "string",  "cost_entry_id": "string",  "expires_at": "string",  "redeemed_at": "string",  "cancelled_at": "string",  "version": 0,  "created_at": "string"}

Cancel: refunds a spent cost by reversal and releases availability

POST
/reward_issuances/{id}/cancel

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/reward_issuances/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "reward_id": "string",  "customer_id": "string",  "status": "issued",  "source_type": "rule_execution",  "source_id": "string",  "cost_entry_id": "string",  "expires_at": "string",  "redeemed_at": "string",  "cancelled_at": "string",  "version": 0,  "created_at": "string"}

Management

Organizations, projects, environments, API keys and usage.

Rules

Rules, immutable versions, publish, pause, simulate.