List or read resources for this path.
Public
Request
| Parameter | In | Req. | Description |
|---|
name | body | Y | Display name (min 2, max 120). |
placement | body | Y | Enumerated string. |
status | body | Y | Lifecycle status for the resource. |
headline | body | Y | Text field (min 2, max 120). |
subheadline | body | N | Text field (max 220). |
ctaLabel | body | N | Text field (max 32). |
imageUrl | body | Y | HTTPS URL of an uploaded image (min 1). |
deeplinkUrl | body | N | Text field. |
webUrl | body | N | Text field. |
cityTargets | body | Y | Text field (min 1, max 50). |
maxImpressions | body | N | Numeric value. |
maxClicks | body | N | Numeric value. |
priority | body | Y | Numeric value (min 0, max 1000). |
triggerActions | body | Y | Text field (min 1, max 20). |
publishAt | body | N | Request field. See Zod schema in the route module for constraints. |
expireAt | body | N | Request field. See Zod schema in the route module for constraints. |
schedule | body | Y | Text field (min 1, max 6). |
Example body
{
"name": "\u2026",
"placement": "\u2026",
"status": "\u2026",
"headline": "\u2026",
"subheadline": "\u2026",
"ctaLabel": "\u2026",
"imageUrl": "\u2026",
"deeplinkUrl": "\u2026",
"webUrl": "\u2026",
"cityTargets": "\u2026",
"maxImpressions": "\u2026",
"maxClicks": "\u2026",
"priority": "\u2026",
"triggerActions": "\u2026",
"publishAt": "\u2026",
"expireAt": "\u2026",
"schedule": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
name | body | Y | Display name (min 2, max 120). |
placement | body | Y | Enumerated string. |
status | body | Y | Lifecycle status for the resource. |
headline | body | Y | Text field (min 2, max 120). |
subheadline | body | N | Text field (max 220). |
ctaLabel | body | N | Text field (max 32). |
imageUrl | body | Y | HTTPS URL of an uploaded image (min 1). |
deeplinkUrl | body | N | Text field. |
webUrl | body | N | Text field. |
cityTargets | body | Y | Text field (min 1, max 50). |
maxImpressions | body | N | Numeric value. |
maxClicks | body | N | Numeric value. |
priority | body | Y | Numeric value (min 0, max 1000). |
triggerActions | body | Y | Text field (min 1, max 20). |
publishAt | body | N | Request field. See Zod schema in the route module for constraints. |
expireAt | body | N | Request field. See Zod schema in the route module for constraints. |
schedule | body | Y | Text field (min 1, max 6). |
Example body
{
"title": "UAT Ad",
"placement": "home"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
DELETE
/api/admin/ads/:id
Remove or deactivate this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
publishAt | body | N | Request field. See Zod schema in the route module for constraints. |
expireAt | body | N | Request field. See Zod schema in the route module for constraints. |
Example body
{
"publishAt": "\u2026",
"expireAt": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/ads/:id/pause
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/ads/:id/publish
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
publishAt | body | N | Request field. See Zod schema in the route module for constraints. |
expireAt | body | N | Request field. See Zod schema in the route module for constraints. |
Example body
{
"publishAt": "\u2026",
"expireAt": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/ads/analytics/overview
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/ads/upload-image
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
name | body | Y | Display name (min 2, max 120). |
placement | body | Y | Enumerated string. |
status | body | Y | Lifecycle status for the resource. |
headline | body | Y | Text field (min 2, max 120). |
subheadline | body | N | Text field (max 220). |
ctaLabel | body | N | Text field (max 32). |
imageUrl | body | Y | HTTPS URL of an uploaded image (min 1). |
deeplinkUrl | body | N | Text field. |
webUrl | body | N | Text field. |
cityTargets | body | Y | Text field (min 1, max 50). |
maxImpressions | body | N | Numeric value. |
maxClicks | body | N | Numeric value. |
priority | body | Y | Numeric value (min 0, max 1000). |
triggerActions | body | Y | Text field (min 1, max 20). |
publishAt | body | N | Request field. See Zod schema in the route module for constraints. |
expireAt | body | N | Request field. See Zod schema in the route module for constraints. |
schedule | body | Y | Text field (min 1, max 6). |
Example body
{
"name": "\u2026",
"placement": "\u2026",
"status": "\u2026",
"headline": "\u2026",
"subheadline": "\u2026",
"ctaLabel": "\u2026",
"imageUrl": "\u2026",
"deeplinkUrl": "\u2026",
"webUrl": "\u2026",
"cityTargets": "\u2026",
"maxImpressions": "\u2026",
"maxClicks": "\u2026",
"priority": "\u2026",
"triggerActions": "\u2026",
"publishAt": "\u2026",
"expireAt": "\u2026",
"schedule": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/assisted-checkouts
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
eventId | body | Y | Mongo ObjectId of the event. |
customerEmail | body | Y | Request field. See Zod schema in the route module for constraints. |
customerName | body | Y | Request field. See Zod schema in the route module for constraints. |
lines | body | Y | Request field. See Zod schema in the route module for constraints. |
Example body
{
"eventId": "{{eventId}}",
"customerEmail": "buyer@example.com",
"customerName": "Buyer",
"lines": []
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/assisted-checkouts/preview
Price a ticket cart before opening checkout.
Public
Request
| Parameter | In | Req. | Description |
|---|
eventId | body | Y | Mongo ObjectId of the event. |
lines | body | Y | Array of values. See nested schema in source when complex (min 1, max 40). |
promoCode | body | N | Text field (max 64). |
Example body
{
"lines": [
{ "eventId": "{{eventId}}", "ticketTypeId": "{{ticketTypeId}}", "quantity": 2 }
],
"promoCode": "",
"paymentOptionSlug": "maris"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/commissions/overview
List or read resources for this path.
Bearer token
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/customers/:userId
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/customers/:userId/account
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/customers/:userId/activity
List or read resources for this path.
Public
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/customers/:userId/tickets
List or read resources for this path.
Public
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/customers/:userId/tickets/:purchaseId/resend-email
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
purchaseId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/customers/:userId/tickets/manual
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/customers/:userId/wallets
List or read resources for this path.
Public
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/customers/activity-stream
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/customers/metrics
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/diagnostics/affected-users
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/diagnostics/alerts
List or read resources for this path.
Public
Request
| Parameter | In | Req. | Description |
|---|
name | body | Y | Display name (min 2, max 120). |
enabled | body | N | Boolean flag. |
matchLevel | body | N | One of: ...DIAGNOSTIC_LEVELS, "any". |
matchCategory | body | N | One of: ...DIAGNOSTIC_CATEGORIES, "any". |
matchMessage | body | Y | Text field (min 1, max 2000). |
messageMode | body | N | One of: "exact", "contains". |
channels | body | Y | Boolean flag. |
audience | body | Y | One of: "self", "all_admins", "role". |
audienceTier | body | N | Enumerated string. |
additionalEmails | body | N | Email address (max 20). |
cooldownMinutes | body | N | Numeric value (min 1, max 1440). |
Example body
{
"name": "\u2026",
"enabled": "\u2026",
"matchLevel": "\u2026",
"matchCategory": "\u2026",
"matchMessage": "\u2026",
"messageMode": "\u2026",
"channels": "\u2026",
"audience": "\u2026",
"audienceTier": "\u2026",
"additionalEmails": "user@example.com",
"cooldownMinutes": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/diagnostics/alerts
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
name | body | Y | Display name (min 2, max 120). |
enabled | body | N | Boolean flag. |
matchLevel | body | N | One of: ...DIAGNOSTIC_LEVELS, "any". |
matchCategory | body | N | One of: ...DIAGNOSTIC_CATEGORIES, "any". |
matchMessage | body | Y | Text field (min 1, max 2000). |
messageMode | body | N | One of: "exact", "contains". |
channels | body | Y | Boolean flag. |
audience | body | Y | One of: "self", "all_admins", "role". |
audienceTier | body | N | Enumerated string. |
additionalEmails | body | N | Email address (max 20). |
cooldownMinutes | body | N | Numeric value (min 1, max 1440). |
Example body
{
"name": "\u2026",
"enabled": "\u2026",
"matchLevel": "\u2026",
"matchCategory": "\u2026",
"matchMessage": "\u2026",
"messageMode": "\u2026",
"channels": "\u2026",
"audience": "\u2026",
"audienceTier": "\u2026",
"additionalEmails": "user@example.com",
"cooldownMinutes": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
DELETE
/api/admin/diagnostics/alerts/:id
Remove or deactivate this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/diagnostics/alerts/:id
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/diagnostics/alerts/:id/test
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/diagnostics/logs
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/diagnostics/stream
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/diagnostics/summary
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/diagnostics/timeline
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/diagnostics/top-issues
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/events/analytics
List or read resources for this path.
Bearer token
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/events/for-merchant-invite
List or read resources for this path.
Bearer token
Request
| Parameter | In | Req. | Description |
|---|
eventId | body | Y | Mongo ObjectId of the event (min 1). |
email | body | Y | Account email address (stored lowercase). |
businessName | body | Y | Merchant business / trading name (min 2, max 200). |
contactName | body | N | Text field (min 1, max 120). |
phone | body | N | Contact mobile number in international or local form (min 4, max 32). |
stallName | body | N | Stall label shown on the floor and in reports (max 100). |
Example body
{
"eventId": "\u2026",
"email": "user@example.com",
"businessName": "\u2026",
"contactName": "\u2026",
"phone": "\u2026",
"stallName": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/events/upcoming-for-assist
List or read resources for this path.
Public
Request
| Parameter | In | Req. | Description |
|---|
eventId | body | Y | Mongo ObjectId of the event. |
lines | body | Y | Array of values. See nested schema in source when complex (min 1, max 40). |
promoCode | body | N | Text field (max 64). |
Example body
{
"eventId": "\u2026",
"lines": "\u2026",
"promoCode": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
List or read resources for this path.
Public
Request
| Parameter | In | Req. | Description |
|---|
internalName | body | Y | Text field (min 2, max 120). |
caption | body | Y | Text field (min 1, max 600). |
mediaType | body | Y | Enumerated string. |
mediaUrl | body | Y | Text field (min 1). |
posterUrl | body | N | Text field. |
status | body | Y | Lifecycle status for the resource. |
publishAt | body | N | Request field. See Zod schema in the route module for constraints. |
cutoffAt | body | N | Request field. See Zod schema in the route module for constraints. |
eventId | body | N | Mongo ObjectId of the event. |
ctaLabel | body | N | Text field (max 40). |
ctaDeeplink | body | N | Text field. |
authorHandle | body | Y | Text field (min 1, max 64). |
authorAvatarUrl | body | N | Text field. |
priority | body | Y | Numeric value (min 0, max 1000). |
Example body
{
"internalName": "\u2026",
"caption": "\u2026",
"mediaType": "\u2026",
"mediaUrl": "\u2026",
"posterUrl": "\u2026",
"status": "\u2026",
"publishAt": "\u2026",
"cutoffAt": "\u2026",
"eventId": "\u2026",
"ctaLabel": "\u2026",
"ctaDeeplink": "\u2026",
"authorHandle": "\u2026",
"authorAvatarUrl": "\u2026",
"priority": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
internalName | body | Y | Text field (min 2, max 120). |
caption | body | Y | Text field (min 1, max 600). |
mediaType | body | Y | Enumerated string. |
mediaUrl | body | Y | Text field (min 1). |
posterUrl | body | N | Text field. |
status | body | Y | Lifecycle status for the resource. |
publishAt | body | N | Request field. See Zod schema in the route module for constraints. |
cutoffAt | body | N | Request field. See Zod schema in the route module for constraints. |
eventId | body | N | Mongo ObjectId of the event. |
ctaLabel | body | N | Text field (max 40). |
ctaDeeplink | body | N | Text field. |
authorHandle | body | Y | Text field (min 1, max 64). |
authorAvatarUrl | body | N | Text field. |
priority | body | Y | Numeric value (min 0, max 1000). |
Example body
{
"internalName": "\u2026",
"caption": "\u2026",
"mediaType": "\u2026",
"mediaUrl": "\u2026",
"posterUrl": "\u2026",
"status": "\u2026",
"publishAt": "\u2026",
"cutoffAt": "\u2026",
"eventId": "\u2026",
"ctaLabel": "\u2026",
"ctaDeeplink": "\u2026",
"authorHandle": "\u2026",
"authorAvatarUrl": "\u2026",
"priority": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
DELETE
/api/admin/feed/:id
Remove or deactivate this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/feed/:id
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/feed/upload-media
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
internalName | body | Y | Text field (min 2, max 120). |
caption | body | Y | Text field (min 1, max 600). |
mediaType | body | Y | Enumerated string. |
mediaUrl | body | Y | Text field (min 1). |
posterUrl | body | N | Text field. |
status | body | Y | Lifecycle status for the resource. |
publishAt | body | N | Request field. See Zod schema in the route module for constraints. |
cutoffAt | body | N | Request field. See Zod schema in the route module for constraints. |
eventId | body | N | Mongo ObjectId of the event. |
ctaLabel | body | N | Text field (max 40). |
ctaDeeplink | body | N | Text field. |
authorHandle | body | Y | Text field (min 1, max 64). |
authorAvatarUrl | body | N | Text field. |
priority | body | Y | Numeric value (min 0, max 1000). |
Example body
{
"internalName": "\u2026",
"caption": "\u2026",
"mediaType": "\u2026",
"mediaUrl": "\u2026",
"posterUrl": "\u2026",
"status": "\u2026",
"publishAt": "\u2026",
"cutoffAt": "\u2026",
"eventId": "\u2026",
"ctaLabel": "\u2026",
"ctaDeeplink": "\u2026",
"authorHandle": "\u2026",
"authorAvatarUrl": "\u2026",
"priority": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/audit
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/fees
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/finance/fees/:key
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
key | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/finance/fees/seed
Create a resource or run this action.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/reports
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/reports/catalogue
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/reports/events/:eventId
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
eventId | path | Y | Mongo ObjectId of the event. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/reports/events/:eventId/export
List or read resources for this path.
Public
Request
| Parameter | In | Req. | Description |
|---|
eventId | path | Y | Mongo ObjectId of the event. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/reports/export
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/reports/overview
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/schedules
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/finance/schedules
Create a resource or run this action.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/finance/schedules/:id
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/finance/schedules/run-due
Create a resource or run this action.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/settlements
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/settlements/:id
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/finance/settlements/:id/approve
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/finance/settlements/:id/email
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/finance/settlements/:id/export
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/finance/settlements/:id/reject
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/finance/settlements/:id/remit
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/finance/settlements/:id/submit
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/finance/settlements/generate
Create a resource or run this action.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
List or read resources for this path.
Bearer token
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {
"id": "66f0a1b2c3d4e5f678901234",
"name": "Pat Fan",
"email": "pat@example.com",
"roles": [
"customer"
],
"phone": "+264811234567"
}
}
Response data
Wrapped in the standard envelope (status, success, data, …). See the introduction for envelope fields.
| Field | Description |
|---|
data.id | Resource identifier (Mongo ObjectId string). |
data.name | Human-readable name. |
data.email | Email address. |
data.roles | Array. Element shape shown when sample includes objects. |
data.phone | Phone number when present on the profile. |
GET
/api/admin/merchant-account-audit/events
List or read resources for this path.
Public
Request
| Parameter | In | Req. | Description |
|---|
action | query | N | One of: "account_paused", "account_resumed", "account_deleted". |
merchantId | query | N | Text field. |
limit | query | N | Maximum number of rows to return (min 1, max 200). |
skip | query | N | Numeric value (min 0). |
from | query | N | Inclusive start of a reporting window (ISO 8601). |
to | query | N | Inclusive end of a reporting window (ISO 8601). |
events | query | Y | Request field. See Zod schema in the route module for constraints. |
typeIndex | query | Y | Numeric value (min 0, max 200). |
phaseIndex | query | Y | Numeric value (min 0, max 200). |
quantity | query | Y | Numeric value (min 1, max 50). |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/merchant-account-audit/stats
List or read resources for this path.
Public
Request
| Parameter | In | Req. | Description |
|---|
action | query | N | One of: "account_paused", "account_resumed", "account_deleted". |
merchantId | query | N | Text field. |
limit | query | N | Maximum number of rows to return (min 1, max 200). |
skip | query | N | Numeric value (min 0). |
from | query | N | Inclusive start of a reporting window (ISO 8601). |
to | query | N | Inclusive end of a reporting window (ISO 8601). |
events | query | Y | Request field. See Zod schema in the route module for constraints. |
typeIndex | query | Y | Numeric value (min 0, max 200). |
phaseIndex | query | Y | Numeric value (min 0, max 200). |
quantity | query | Y | Numeric value (min 1, max 50). |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/merchant-invites
List or read resources for this path.
Bearer token
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/merchant-invites
Create a resource or run this action.
Bearer token
Request
| Parameter | In | Req. | Description |
|---|
eventId | body | Y | Mongo ObjectId of the event (min 1). |
email | body | Y | Account email address (stored lowercase). |
businessName | body | Y | Merchant business / trading name (min 2, max 200). |
contactName | body | N | Text field (min 1, max 120). |
phone | body | N | Contact mobile number in international or local form (min 4, max 32). |
stallName | body | N | Stall label shown on the floor and in reports (max 100). |
Example body
{
"email": "vendor@example.com",
"eventId": "{{eventId}}",
"businessName": "Street Eats",
"stallName": "Taco Truck",
"contactName": "Vendor Contact",
"phone": "+264812222222"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/merchant-invites/:token
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
token | path | Y | Opaque session or activation token. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/merchant-invites/:token/complete
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
token | path | Y | Opaque session or activation token. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/merchants/:merchantId
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
merchantId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/merchants/:merchantId
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
merchantId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/notifications/audience-preview
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
audience | body | Y | Request field. See Zod schema in the route module for constraints. |
Example body
{
"audience": { "type": "all_customers" }
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/notifications/campaigns
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/notifications/campaigns
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
title | body | Y | Job title shown on the admin profile. |
body | body | Y | Request field. See Zod schema in the route module for constraints. |
channels | body | Y | Request field. See Zod schema in the route module for constraints. |
audience | body | Y | Request field. See Zod schema in the route module for constraints. |
Example body
{
"title": "Weekend picks",
"body": "New events this weekend on Groove.",
"channels": ["push", "in_app"],
"audience": { "type": "all_customers" }
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/notifications/campaigns/:id
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/notifications/campaigns/:id/duplicate
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/notifications/campaigns/:id/send
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/notifications/capabilities
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/notifications/templates
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/notifications/upload-image
Create a resource or run this action.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/notifications/users/search
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/organisers
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/organisers/:organiserId
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
organiserId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/organisers/:organiserId
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
organiserId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
List or read resources for this path.
Bearer token
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/payment-options
List or read resources for this path.
Bearer token
Request
| Parameter | In | Req. | Description |
|---|
status | query | N | Lifecycle status for the resource. |
paymentOptionSlug | query | N | Payment rail slug from the payment-options catalogue (e.g. maris, card). |
provider | query | N | Text field. |
channel | query | N | Text field. |
q | query | N | Free-text search query. |
since | query | N | Text field. |
until | query | N | Text field. |
limit | query | N | Maximum number of rows to return (min 1, max 100). |
skip | query | N | Numeric value (min 0). |
slug | body | Y | Text field (min 2, max 64). |
name | body | Y | Display name (min 1, max 120). |
subtitle | body | N | Text field (max 240). |
handler | body | Y | Enumerated string. |
enabled | body | N | Boolean flag. |
sortOrder | body | N | Numeric value. |
showOnMobile | body | N | Boolean flag. |
showOnWeb | body | N | Boolean flag. |
iconType | body | N | Enumerated string. |
iconKey | body | N | Text field (max 120). |
payButtonLabel | body | N | Text field (max 120). |
providerConfig | body | N | Key/value map. |
Example body
{
"slug": "\u2026",
"name": "\u2026",
"subtitle": "\u2026",
"handler": "\u2026",
"enabled": "\u2026",
"sortOrder": "\u2026",
"showOnMobile": "\u2026",
"showOnWeb": "\u2026",
"iconType": "\u2026",
"iconKey": "\u2026",
"payButtonLabel": "\u2026",
"providerConfig": "\u2026"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/payment-options
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
status | query | N | Lifecycle status for the resource. |
paymentOptionSlug | query | N | Payment rail slug from the payment-options catalogue (e.g. maris, card). |
provider | query | N | Text field. |
channel | query | N | Text field. |
q | query | N | Free-text search query. |
since | query | N | Text field. |
until | query | N | Text field. |
limit | query | N | Maximum number of rows to return (min 1, max 100). |
skip | query | N | Numeric value (min 0). |
slug | body | Y | Text field (min 2, max 64). |
name | body | Y | Display name (min 1, max 120). |
subtitle | body | N | Text field (max 240). |
handler | body | Y | Enumerated string. |
enabled | body | N | Boolean flag. |
sortOrder | body | N | Numeric value. |
showOnMobile | body | N | Boolean flag. |
showOnWeb | body | N | Boolean flag. |
iconType | body | N | Enumerated string. |
iconKey | body | N | Text field (max 120). |
payButtonLabel | body | N | Text field (max 120). |
providerConfig | body | N | Key/value map. |
Example body
{
"name": "Example Pay",
"slug": "example_pay",
"enabled": true,
"showOnMobile": true,
"showOnWeb": true,
"handler": "maris_otp",
"sortOrder": 10
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
DELETE
/api/admin/payment-options/:id
Remove or deactivate this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/payment-options/:id
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/payment-options/logs
List or read resources for this path.
Bearer token
Request
| Parameter | In | Req. | Description |
|---|
status | query | N | Lifecycle status for the resource. |
paymentOptionSlug | query | N | Payment rail slug from the payment-options catalogue (e.g. maris, card). |
provider | query | N | Text field. |
channel | query | N | Text field. |
q | query | N | Free-text search query. |
since | query | N | Text field. |
until | query | N | Text field. |
limit | query | N | Maximum number of rows to return (min 1, max 100). |
skip | query | N | Numeric value (min 0). |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/payment-options/seed
Create a resource or run this action.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example body
{}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/payment-options/stats/overview
List or read resources for this path.
Bearer token
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/payout-requests
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/payout-requests/:id/decline
Request a merchant payout.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/payout-requests/:id/process
Request a merchant payout.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/payout-requests/run-due
Request a merchant payout.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/support/attachments/:messageId
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
messageId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/support/canned
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/support/conversations
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/support/conversations/:id
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/support/conversations/:id
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/support/conversations/:id/messages
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/support/conversations/:id/notes
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/support/conversations/:id/tickets
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/support/live
List or read resources for this path.
Public
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/support/tickets/:id
Update selected fields on this resource.
Public
Request
| Parameter | In | Req. | Description |
|---|
id | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
List or read resources for this path.
Bearer token
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
DELETE
/api/admin/team/:userId
Remove or deactivate this resource.
Bearer token
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/team/:userId
Fetch one resource by id or token.
Bearer token
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/team/:userId/audit
List or read resources for this path.
Bearer token
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/team/:userId/status
Update selected fields on this resource.
Bearer token
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
PATCH
/api/admin/team/:userId/tier
Update selected fields on this resource.
Bearer token
Request
| Parameter | In | Req. | Description |
|---|
userId | path | Y | Path parameter identifying the resource. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/team/invites
List or read resources for this path.
Bearer token
Request
No body or query parameters. Path values above, if any, are enough.
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/team/invites
Create a resource or run this action.
Bearer token
Request
| Parameter | In | Req. | Description |
|---|
email | body | Y | Account email address (stored lowercase). |
name | body | N | Display name (min 1, max 120). |
adminTier | body | Y | Enumerated string. |
title | body | N | Job title shown on the admin profile (min 1, max 120). |
Example body
{
"email": "new.admin@example.com",
"name": "New Admin",
"adminTier": "admin",
"title": "Ops"
}
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
GET
/api/admin/team/invites/:token
Fetch one resource by id or token.
Public
Request
| Parameter | In | Req. | Description |
|---|
token | path | Y | Opaque session or activation token. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
POST
/api/admin/team/invites/:token/complete
Create a resource or run this action.
Public
Request
| Parameter | In | Req. | Description |
|---|
token | path | Y | Opaque session or activation token. |
Example response
{
"status": "success",
"success": true,
"statusCode": "00000",
"message": "OK",
"shortMessage": "SUCCESS",
"timestamp": "2026-10-10T21:00:00.000Z",
"requestId": "a1b2c3d4e5f6g7h8",
"data": {}
}
Response data
Success returns the standard envelope. data holds the payload for this method — confirm the shape in your client when integrating.
Lock this page again
