API reference

Fan account & tickets

72 methods. Request fields, an example response, and notes on what comes back in data.

Base https://api.groove.com.na Updated October 2026

GET /api/ads

List or read resources for this path.

Public

Request

Parameter	In	Req.	Description
`placement`	query	Y	Enumerated string.
`city`	query	N	City name.
`triggerAction`	query	N	Text field.
`limit`	query	Y	Maximum number of rows to return (min 1, max 20).
`eventType`	body	Y	One of: "impression", "click".
`context`	body	N	Key/value map.

Example body

{
  "eventType": "\u2026",
  "context": "\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/ads/:id/track

Create a resource or run this action.

Public

Request

Parameter	In	Req.	Description
`id`	path	Y	Path parameter identifying the resource.
`eventType`	body	Y	One of: "impression", "click".
`context`	body	N	Key/value map.

Example body

{
  "eventType": "\u2026",
  "context": "\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/feed

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/feed/:id/comments

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/feed/:id/comments

Create a resource or run this action.

Bearer token

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.

DELETE /api/feed/:id/like

Remove or deactivate this resource.

Bearer token

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/feed/:id/like

Create a resource or run this action.

Bearer token

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/feed/:id/view

Create a resource or run this action.

Bearer token

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/me

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`name`	body	N	Display name (min 2, max 120).
`phone`	body	N	Contact mobile number in international or local form (min 4, max 32).
`preferences`	body	N	Boolean flag.

Example body

{
  "name": "\u2026",
  "phone": "\u2026",
  "preferences": "\u2026"
}

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.

PATCH /api/me

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`name`	body	N	Display name (min 2, max 120).
`phone`	body	N	Contact mobile number in international or local form (min 4, max 32).
`preferences`	body	N	Boolean flag.

Example body

{
  "name": "Test Customer",
  "phone": "+264812345678"
}

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/me/allocations

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/me/allocations

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/me/allocations/:blockId

Fetch one resource by id or token.

Public

Request

Parameter	In	Req.	Description
`blockId`	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/me/allocations/:blockId/codes

Create a resource or run this action.

Public

Request

Parameter	In	Req.	Description
`blockId`	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/me/allocations/:blockId/invite

Create a resource or run this action.

Public

Request

Parameter	In	Req.	Description
`blockId`	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/me/allocations/:blockId/invoice.pdf

List or read resources for this path.

Public

Request

Parameter	In	Req.	Description
`blockId`	path	Y	Path parameter identifying the resource.
`to`	body	Y	Inclusive end of a reporting window (ISO 8601) (max 160).

Example body

{
  "to": "\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/me/allocations/:blockId/invoice/email

Create a resource or run this action.

Public

Request

Parameter	In	Req.	Description
`blockId`	path	Y	Path parameter identifying the resource.
`to`	body	Y	Inclusive end of a reporting window (ISO 8601) (max 160).

Example body

{
  "to": "\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/me/allocations/:blockId/open-link

Create a resource or run this action.

Public

Request

Parameter	In	Req.	Description
`blockId`	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/me/allocations/:blockId/payment-link

Create a resource or run this action.

Public

Request

Parameter	In	Req.	Description
`blockId`	path	Y	Path parameter identifying the resource.
`to`	body	Y	Inclusive end of a reporting window (ISO 8601) (max 160).

Example body

{
  "to": "\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/me/allocations/:blockId/remind

Create a resource or run this action.

Public

Request

Parameter	In	Req.	Description
`blockId`	path	Y	Path parameter identifying the resource.
`to`	body	Y	Inclusive end of a reporting window (ISO 8601) (max 160).

Example body

{
  "to": "\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/me/allocations/:blockId/slots/:slotId/revoke

Create a resource or run this action.

Public

Request

Parameter	In	Req.	Description
`blockId`	path	Y	Path parameter identifying the resource.
`slotId`	path	Y	Path parameter identifying the resource.
`to`	body	Y	Inclusive end of a reporting window (ISO 8601) (max 160).

Example body

{
  "to": "\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/me/allocations/catalog

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/me/allocations/catalog/: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.

POST /api/me/allocations/quote

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.

DELETE /api/me/avatar

Remove or deactivate this resource.

Bearer token

Request

Parameter	In	Req.	Description
`currentPassword`	body	Y	Text field (min 1, max 128).
`newPassword`	body	Y	Text field (min 8, max 128).

Example body

{
  "currentPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022",
  "newPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022"
}

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/me/avatar

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`currentPassword`	body	Y	Text field (min 1, max 128).
`newPassword`	body	Y	Text field (min 8, max 128).

Example body

{
  "currentPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022",
  "newPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022"
}

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/me/delete

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`confirmation`	body	Y	Request field. See Zod schema in the route module for constraints.
`currentPassword`	body	N	Text field (min 1, max 128).

Example body

{
  "confirmation": "\u2026",
  "currentPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022"
}

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/me/favorites

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	body	Y	Mongo ObjectId of the event.

Example body

{
  "eventId": "\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/me/favorites

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	body	Y	Mongo ObjectId of the event.

Example body

{
  "eventId": "\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.

PUT /api/me/favorites

Replace or upsert this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	body	Y	Mongo ObjectId of the event.

Example body

{
  "eventId": "\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/me/favorites/:eventId

Remove or deactivate this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`currentPassword`	body	Y	Text field (min 1, max 128).
`newPassword`	body	Y	Text field (min 8, max 128).

Example body

{
  "currentPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022",
  "newPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022"
}

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/me/password

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`currentPassword`	body	Y	Text field (min 1, max 128).
`newPassword`	body	Y	Text field (min 8, max 128).

Example body

{
  "currentPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022",
  "newPassword": "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022"
}

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/me/push-token

Remove or deactivate this resource.

Bearer token

Request

Parameter	In	Req.	Description
`token`	body	Y	Opaque session or activation token.

Example body

{
  "token": "{{pushToken}}"
}

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/me/push-token

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`token`	body	Y	Opaque session or activation token (min 10, max 200).
`platform`	body	N	One of: "ios", "android", "unknown".
`deviceName`	body	N	Text field (max 120).
`appVersion`	body	N	Text field (max 32).

Example body

{
  "token": "{{pushToken}}",
  "platform": "ios",
  "deviceName": "Postman",
  "appVersion": "1.0.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/me/support/attachments

Create a resource or run this action.

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/me/support/attachments/:messageId

Fetch one resource by id or token.

Bearer token

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.

POST /api/me/support/messages

Create a resource or run this action.

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/me/support/thread

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/me/tickets

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/me/tickets/:ticketId/apple-wallet

Bearer token

Request

Parameter	In	Req.	Description
`ticketId`	path	Y	Path parameter identifying the resource.
`token`	body	Y	Opaque session or activation token (min 10, max 200).
`platform`	body	N	One of: "ios", "android", "unknown".
`deviceName`	body	N	Text field (max 120).
`appVersion`	body	N	Text field (max 32).

Example body

{
  "token": "\u2026",
  "platform": "\u2026",
  "deviceName": "\u2026",
  "appVersion": "\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/me/tickets/:ticketId/share

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`ticketId`	path	Y	Path parameter identifying the resource.
`channel`	body	Y	One of: "email", "whatsapp", "link".
`recipientEmail`	body	N	Email address.
`recipientWhatsapp`	body	N	Text field (min 6, max 24).
`note`	body	N	Free-text note stored with the sale or session (max 180).

Example body

{
  "channel": "\u2026",
  "recipientEmail": "user@example.com",
  "recipientWhatsapp": "\u2026",
  "note": "\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/me/tickets/:ticketId/transfer

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`ticketId`	path	Y	Path parameter identifying the resource.
`channel`	body	Y	One of: "email", "whatsapp", "link".
`recipientName`	body	N	Text field (min 2, max 120).
`recipientEmail`	body	N	Email address.
`recipientWhatsapp`	body	N	Text field (min 6, max 24).

Example body

{
  "channel": "\u2026",
  "recipientName": "\u2026",
  "recipientEmail": "user@example.com",
  "recipientWhatsapp": "\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/me/tickets/:ticketId/transfer/cancel

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`ticketId`	path	Y	Path parameter identifying the resource.
`token`	body	Y	Opaque session or activation token (min 10, max 200).
`platform`	body	N	One of: "ios", "android", "unknown".
`deviceName`	body	N	Text field (max 120).
`appVersion`	body	N	Text field (max 32).

Example body

{
  "token": "\u2026",
  "platform": "\u2026",
  "deviceName": "\u2026",
  "appVersion": "\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/me/tickets/claim

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`channel`	body	Y	One of: "email", "whatsapp", "link".
`recipientEmail`	body	N	Email address.
`recipientWhatsapp`	body	N	Text field (min 6, max 24).
`note`	body	N	Free-text note stored with the sale or session (max 180).

Example body

{
  "channel": "\u2026",
  "recipientEmail": "user@example.com",
  "recipientWhatsapp": "\u2026",
  "note": "\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/me/wallet/apple/status

Bearer token

Request

Parameter	In	Req.	Description
`token`	body	Y	Opaque session or activation token (min 10, max 200).
`platform`	body	N	One of: "ios", "android", "unknown".
`deviceName`	body	N	Text field (max 120).
`appVersion`	body	N	Text field (max 32).

Example body

{
  "token": "\u2026",
  "platform": "\u2026",
  "deviceName": "\u2026",
  "appVersion": "\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/notifications

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/notifications/:id

Remove or deactivate this resource.

Bearer token

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/notifications/read-all

Update selected fields on this resource.

Bearer token

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/public/allocations/claims/: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/public/allocations/claims/preview

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/public/allocations/orders/: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/public/allocations/orders/:token/account

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.

POST /api/public/allocations/orders/:token/account/login

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": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "refreshToken": "rt_8f3c2a1b9e...",
    "expiresIn": 3600,
    "user": {
      "id": "66f0a1b2c3d4e5f678901234",
      "name": "Pat Fan",
      "email": "pat@example.com",
      "roles": [
        "customer"
      ]
    }
  }
}

Response data

Wrapped in the standard envelope (status, success, data, …). See the introduction for envelope fields.

Field	Description
`data.accessToken`	JWT access token. Send as Authorization: Bearer.
`data.refreshToken`	Long-lived refresh token for /api/auth/refresh.
`data.expiresIn`	Access token lifetime in seconds.
`data.user`	Object. Nested fields follow.
`data.user.id`	Resource identifier (Mongo ObjectId string).
`data.user.name`	Human-readable name.
`data.user.email`	Email address.
`data.user.roles`	Array. Element shape shown when sample includes objects.

GET /api/public/allocations/orders/:token/invoice.pdf

List or read resources for this path.

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/public/allocations/orders/:token/pay/card

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.

POST /api/public/allocations/orders/:token/pay/maris

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.

POST /api/public/allocations/orders/:token/pay/maris/confirm

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.

GET /api/public/allocations/workspace/: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/public/allocations/workspace/:token/codes

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.

POST /api/public/allocations/workspace/:token/invite

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.

POST /api/public/allocations/workspace/:token/open-link

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.

POST /api/public/allocations/workspace/:token/remind

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.

POST /api/public/allocations/workspace/:token/slots/:slotId/revoke

Create a resource or run this action.

Public

Request

Parameter	In	Req.	Description
`token`	path	Y	Opaque session or activation token.
`slotId`	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/public/assisted-checkout/: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/public/assisted-checkout/:token/pay

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.

GET /api/public/vendors

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/public/vendors/: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.

GET /api/public/vendors/:merchantId/menu

List or read resources for this path.

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/public/vendors/:merchantId/pay

Create a resource or run this action.

Public

Request

Parameter	In	Req.	Description
`merchantId`	path	Y	Path parameter identifying the resource.
`amountMinor`	body	Y	Amount in the smallest currency unit (NAD cents) (min 100).
`method`	body	Y	One of: "wallet", "card", "mtc_maris".
`note`	body	N	Free-text note stored with the sale or session (max 160).
`marisPhone`	body	N	Text field.
`client`	body	N	One of: "web", "mobile", "android", "ios".
`card`	body	N	Email address (min 1, max 80).

Example body

{
  "amountMinor": 0,
  "method": "\u2026",
  "note": "\u2026",
  "marisPhone": "\u2026",
  "client": "\u2026",
  "card": "\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/public/vendors/pay-sessions/:sessionId/maris/verify

Confirm a Maris one-time password.

Public

Request

Parameter	In	Req.	Description
`sessionId`	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/public/wallet/apple/: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.

GET /api/public/wallet/apple/status

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.

Lock this page again

Fan account & tickets · 72 methods · October 2026

Resolve this before you come in.

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example body

Example response

Response data

Request

Example response

Response data

Request

Example response

Response data

Request