API reference

Events & catalogue

50 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/events

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

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`name`	body	Y	Display name.
`startDate`	body	Y	Request field. See Zod schema in the route module for constraints.
`endDate`	body	Y	Request field. See Zod schema in the route module for constraints.
`venue`	body	Y	Venue name.
`city`	body	Y	City name.
`country`	body	Y	Request field. See Zod schema in the route module for constraints.

Example body

{
  "name": "UAT Festival",
  "startDate": "2026-12-01T18:00:00.000Z",
  "endDate": "2026-12-01T23:00:00.000Z",
  "venue": "Windhoek",
  "city": "Windhoek",
  "country": "Namibia"
}

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/events/:eventId/allocations

List or read resources for this path.

Bearer token

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/events/:eventId/allocations

Create a resource or run this action.

Bearer token

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

Fetch one resource by id or token.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`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/events/:eventId/allocations/:blockId/allocator-link

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`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/events/:eventId/allocations/:blockId/codes

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`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/events/:eventId/allocations/:blockId/invite

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`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/events/:eventId/allocations/:blockId/invoice.pdf

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`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/events/:eventId/allocations/:blockId/invoice/email

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`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/events/:eventId/allocations/:blockId/open-link

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`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/events/:eventId/allocations/:blockId/release-unused

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`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/events/:eventId/allocations/:blockId/remind

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`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/events/:eventId/allocations/:blockId/slots/:slotId/revoke

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`blockId`	path	Y	Path parameter identifying the resource.
`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.

POST /api/events/:eventId/allocations/quote

Create a resource or run this action.

Bearer token

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/events/:eventId/allocations/will-call

List or read resources for this path.

Bearer token

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/events/:eventId/allocations/will-call/:slotId/admit

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`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/events/:eventId/inventory

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`name`	body	Y	Display name (min 1, max 140).
`sku`	body	Y	Stock-keeping unit or internal item code (min 1, max 80).
`imageUrl`	body	N	HTTPS URL of an uploaded image (max 500).
`productType`	body	N	Text field (max 80).
`expiryDate`	body	N	Text field.
`category`	body	N	Text field (max 80).
`brand`	body	N	Text field (max 80).
`supplier`	body	N	Text field (max 120).
`barcode`	body	N	Text field (max 80).
`storageLocation`	body	N	Text field (max 80).
`batchNumber`	body	N	Text field (max 80).
`unit`	body	N	Text field (max 20).
`costPrice`	body	N	Numeric value (min 0).
`sellPrice`	body	N	Numeric value (min 0).
`taxRate`	body	N	Numeric value (min 0, max 100).
`parLevel`	body	Y	Numeric value (min 0).
`minOrderQty`	body	Y	Numeric value (min 0).
`reorderLevel`	body	Y	Numeric value (min 0).
`onHand`	body	Y	Numeric value (min 0).
`reserved`	body	Y	Numeric value (min 0).
`damaged`	body	Y	Numeric value (min 0).
`notes`	body	N	Text field (max 600).

Example body

{
  "name": "\u2026",
  "sku": "\u2026",
  "imageUrl": "\u2026",
  "productType": "\u2026",
  "expiryDate": "\u2026",
  "category": "\u2026",
  "brand": "\u2026",
  "supplier": "\u2026",
  "barcode": "\u2026",
  "storageLocation": "\u2026",
  "batchNumber": "\u2026",
  "unit": "\u2026",
  "costPrice": "\u2026",
  "sellPrice": "\u2026",
  "taxRate": "\u2026",
  "parLevel": "\u2026",
  "minOrderQty": "\u2026",
  "reorderLevel": "\u2026",
  "onHand": "\u2026",
  "reserved": "\u2026",
  "damaged": "\u2026",
  "notes": "\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/events/:eventId/inventory/export.csv

List or read resources for this path.

Bearer token

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/events/:eventId/inventory/import

Create a resource or run this action.

Bearer token

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/events/:eventId/inventory/items

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`name`	body	Y	Display name (min 1, max 140).
`sku`	body	Y	Stock-keeping unit or internal item code (min 1, max 80).
`imageUrl`	body	N	HTTPS URL of an uploaded image (max 500).
`productType`	body	N	Text field (max 80).
`expiryDate`	body	N	Text field.
`category`	body	N	Text field (max 80).
`brand`	body	N	Text field (max 80).
`supplier`	body	N	Text field (max 120).
`barcode`	body	N	Text field (max 80).
`storageLocation`	body	N	Text field (max 80).
`batchNumber`	body	N	Text field (max 80).
`unit`	body	N	Text field (max 20).
`costPrice`	body	N	Numeric value (min 0).
`sellPrice`	body	N	Numeric value (min 0).
`taxRate`	body	N	Numeric value (min 0, max 100).
`parLevel`	body	Y	Numeric value (min 0).
`minOrderQty`	body	Y	Numeric value (min 0).
`reorderLevel`	body	Y	Numeric value (min 0).
`onHand`	body	Y	Numeric value (min 0).
`reserved`	body	Y	Numeric value (min 0).
`damaged`	body	Y	Numeric value (min 0).
`notes`	body	N	Text field (max 600).

Example body

{
  "name": "\u2026",
  "sku": "\u2026",
  "imageUrl": "\u2026",
  "productType": "\u2026",
  "expiryDate": "\u2026",
  "category": "\u2026",
  "brand": "\u2026",
  "supplier": "\u2026",
  "barcode": "\u2026",
  "storageLocation": "\u2026",
  "batchNumber": "\u2026",
  "unit": "\u2026",
  "costPrice": "\u2026",
  "sellPrice": "\u2026",
  "taxRate": "\u2026",
  "parLevel": "\u2026",
  "minOrderQty": "\u2026",
  "reorderLevel": "\u2026",
  "onHand": "\u2026",
  "reserved": "\u2026",
  "damaged": "\u2026",
  "notes": "\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.

PATCH /api/events/:eventId/inventory/items/:itemId

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`itemId`	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/events/:eventId/inventory/items/:itemId/adjust

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`itemId`	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/events/:eventId/inventory/reminder

List or read resources for this path.

Bearer token

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.

PATCH /api/events/:eventId/inventory/reminder

Update selected fields on this resource.

Bearer token

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/events/:eventId/inventory/reminder/trigger

Create a resource or run this action.

Bearer token

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/events/:eventId/inventory/reorder/apply

Create a resource or run this action.

Bearer token

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/events/:eventId/inventory/reports

List or read resources for this path.

Bearer token

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/events/:eventId/inventory/stream

List or read resources for this path.

Bearer token

Request

Parameter	In	Req.	Description
`eventId`	path	Y	Mongo ObjectId of the event.
`name`	body	Y	Display name (min 1, max 140).
`sku`	body	Y	Stock-keeping unit or internal item code (min 1, max 80).
`imageUrl`	body	N	HTTPS URL of an uploaded image (max 500).
`productType`	body	N	Text field (max 80).
`expiryDate`	body	N	Text field.
`category`	body	N	Text field (max 80).
`brand`	body	N	Text field (max 80).
`supplier`	body	N	Text field (max 120).
`barcode`	body	N	Text field (max 80).
`storageLocation`	body	N	Text field (max 80).
`batchNumber`	body	N	Text field (max 80).
`unit`	body	N	Text field (max 20).
`costPrice`	body	N	Numeric value (min 0).
`sellPrice`	body	N	Numeric value (min 0).
`taxRate`	body	N	Numeric value (min 0, max 100).
`parLevel`	body	Y	Numeric value (min 0).
`minOrderQty`	body	Y	Numeric value (min 0).
`reorderLevel`	body	Y	Numeric value (min 0).
`onHand`	body	Y	Numeric value (min 0).
`reserved`	body	Y	Numeric value (min 0).
`damaged`	body	Y	Numeric value (min 0).
`notes`	body	N	Text field (max 600).

Example body

{
  "name": "\u2026",
  "sku": "\u2026",
  "imageUrl": "\u2026",
  "productType": "\u2026",
  "expiryDate": "\u2026",
  "category": "\u2026",
  "brand": "\u2026",
  "supplier": "\u2026",
  "barcode": "\u2026",
  "storageLocation": "\u2026",
  "batchNumber": "\u2026",
  "unit": "\u2026",
  "costPrice": "\u2026",
  "sellPrice": "\u2026",
  "taxRate": "\u2026",
  "parLevel": "\u2026",
  "minOrderQty": "\u2026",
  "reorderLevel": "\u2026",
  "onHand": "\u2026",
  "reserved": "\u2026",
  "damaged": "\u2026",
  "notes": "\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/events/:eventId/inventory/variance

List or read resources for this path.

Bearer token

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/events/:eventId/inventory/variance.csv

List or read resources for this path.

Bearer token

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.

DELETE /api/events/: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.

GET /api/events/:id

Fetch one resource by id or token.

Bearer token

Request

Parameter	In	Req.	Description
`id`	path	Y	Path parameter identifying the resource.
`name`	body	N	Display name (min 2, max 200).
`description`	body	N	Text field (min 1, max 2000).
`coverImageUrl`	body	N	Event cover image URL (max 2048).
`posterImageUrl`	body	N	Text field (max 2048).
`city`	body	N	City name (min 2, max 120).
`venue`	body	N	Venue name (min 2, max 200).
`latitude`	body	N	Numeric value (max 90).
`longitude`	body	N	Numeric value (max 180).
`timezone`	body	N	IANA timezone (e.g. Africa/Windhoek) (max 64).
`startsAt`	body	N	Event or window start time (ISO 8601).
`endsAt`	body	N	Event or window end time (ISO 8601).
`salesEndAt`	body	N	Request field. See Zod schema in the route module for constraints.
`visibility`	body	N	Publication state such as draft or published.
`publishAt`	body	N	Request field. See Zod schema in the route module for constraints.
`capacity`	body	N	Maximum tickets or seats.
`category`	body	N	Request field. See Zod schema in the route module for constraints.
`keywords`	body	N	Text field (min 1, max 80).
`isCashless`	body	N	Whether cashless wallets are enabled for the event.
`allowedPaymentOptionSlugs`	body	N	Text field (min 1, max 80).
`ticketTypes`	body	N	Ticket type definitions with phases and prices.
`promoCodes`	body	N	Array of values. See nested schema in source when complex.
`bulkDiscounts`	body	N	Array of values. See nested schema in source when complex.
`paymentMethodDiscounts`	body	N	Array of values. See nested schema in source when complex.
`sponsors`	body	N	Array of values. See nested schema in source when complex.
`stallTypes`	body	N	Array of values. See nested schema in source when complex.
`tables`	body	N	Array of values. See nested schema in source when complex.
`lineup`	body	N	Array of values. See nested schema in source when complex (max 80).
`promotion`	body	N	Request field. See Zod schema in the route module for constraints.

Example body

{
  "name": "\u2026",
  "description": "\u2026",
  "coverImageUrl": "\u2026",
  "posterImageUrl": "\u2026",
  "city": "\u2026",
  "venue": "\u2026",
  "latitude": "\u2026",
  "longitude": "\u2026",
  "timezone": "\u2026",
  "startsAt": "\u2026",
  "endsAt": "\u2026",
  "salesEndAt": "\u2026",
  "visibility": "\u2026",
  "publishAt": "\u2026",
  "capacity": 0,
  "category": "\u2026",
  "keywords": "\u2026",
  "isCashless": true,
  "allowedPaymentOptionSlugs": "\u2026",
  "ticketTypes": "\u2026",
  "promoCodes": "\u2026",
  "bulkDiscounts": "\u2026",
  "paymentMethodDiscounts": "\u2026",
  "sponsors": "\u2026",
  "stallTypes": "\u2026",
  "tables": "\u2026",
  "lineup": "\u2026",
  "promotion": "\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.

PATCH /api/events/:id

Update selected fields on this resource.

Bearer token

Request

Parameter	In	Req.	Description
`id`	path	Y	Path parameter identifying the resource.
`name`	body	N	Display name (min 2, max 200).
`description`	body	N	Text field (min 1, max 2000).
`coverImageUrl`	body	N	Event cover image URL (max 2048).
`posterImageUrl`	body	N	Text field (max 2048).
`city`	body	N	City name (min 2, max 120).
`venue`	body	N	Venue name (min 2, max 200).
`latitude`	body	N	Numeric value (max 90).
`longitude`	body	N	Numeric value (max 180).
`timezone`	body	N	IANA timezone (e.g. Africa/Windhoek) (max 64).
`startsAt`	body	N	Event or window start time (ISO 8601).
`endsAt`	body	N	Event or window end time (ISO 8601).
`salesEndAt`	body	N	Request field. See Zod schema in the route module for constraints.
`visibility`	body	N	Publication state such as draft or published.
`publishAt`	body	N	Request field. See Zod schema in the route module for constraints.
`capacity`	body	N	Maximum tickets or seats.
`category`	body	N	Request field. See Zod schema in the route module for constraints.
`keywords`	body	N	Text field (min 1, max 80).
`isCashless`	body	N	Whether cashless wallets are enabled for the event.
`allowedPaymentOptionSlugs`	body	N	Text field (min 1, max 80).
`ticketTypes`	body	N	Ticket type definitions with phases and prices.
`promoCodes`	body	N	Array of values. See nested schema in source when complex.
`bulkDiscounts`	body	N	Array of values. See nested schema in source when complex.
`paymentMethodDiscounts`	body	N	Array of values. See nested schema in source when complex.
`sponsors`	body	N	Array of values. See nested schema in source when complex.
`stallTypes`	body	N	Array of values. See nested schema in source when complex.
`tables`	body	N	Array of values. See nested schema in source when complex.
`lineup`	body	N	Array of values. See nested schema in source when complex (max 80).
`promotion`	body	N	Request field. See Zod schema in the route module for constraints.

Example body

{
  "name": "\u2026",
  "description": "\u2026",
  "coverImageUrl": "\u2026",
  "posterImageUrl": "\u2026",
  "city": "\u2026",
  "venue": "\u2026",
  "latitude": "\u2026",
  "longitude": "\u2026",
  "timezone": "\u2026",
  "startsAt": "\u2026",
  "endsAt": "\u2026",
  "salesEndAt": "\u2026",
  "visibility": "\u2026",
  "publishAt": "\u2026",
  "capacity": 0,
  "category": "\u2026",
  "keywords": "\u2026",
  "isCashless": true,
  "allowedPaymentOptionSlugs": "\u2026",
  "ticketTypes": "\u2026",
  "promoCodes": "\u2026",
  "bulkDiscounts": "\u2026",
  "paymentMethodDiscounts": "\u2026",
  "sponsors": "\u2026",
  "stallTypes": "\u2026",
  "tables": "\u2026",
  "lineup": "\u2026",
  "promotion": "\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/events/:id/directory-invites

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/events/:id/merchant-directory

Fetch one resource by id or token.

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/events/:id/merchant-invite

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

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

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`id`	path	Y	Path parameter identifying the resource.
`name`	body	Y	Display name (min 2, max 120).
`templateId`	body	Y	Text field (min 1, max 64).
`title`	body	Y	Job title shown on the admin profile (min 1, max 160).
`body`	body	Y	Text field (min 1, max 600).
`href`	body	N	Text field (max 300).
`imageUrl`	body	N	HTTPS URL of an uploaded image (max 2048).
`bannerUrl`	body	N	Text field (max 2048).
`channels`	body	Y	Request field. See Zod schema in the route module for constraints.
`abTestEnabled`	body	N	Boolean flag.
`variantBTitle`	body	N	Text field (max 160).
`variantBBody`	body	N	Text field (max 600).
`abSplitPercent`	body	N	Numeric value (min 10, max 90).
`scheduledAt`	body	N	Text field.
`sendNow`	body	Y	Boolean flag.
`audienceType`	body	Y	One of: "event_ticket_holders", "specific_users".
`userIds`	body	N	Text field (max 500).
`respectPreferences`	body	Y	Boolean flag.

Example body

{
  "name": "\u2026",
  "templateId": "\u2026",
  "title": "\u2026",
  "body": "\u2026",
  "href": "\u2026",
  "imageUrl": "\u2026",
  "bannerUrl": "\u2026",
  "channels": "\u2026",
  "abTestEnabled": "\u2026",
  "variantBTitle": "\u2026",
  "variantBBody": "\u2026",
  "abSplitPercent": "\u2026",
  "scheduledAt": "\u2026",
  "sendNow": "\u2026",
  "audienceType": "\u2026",
  "userIds": "\u2026",
  "respectPreferences": "\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/events/:id/notifications/campaigns

Fetch one resource by id or token.

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/events/:id/notifications/campaigns/:campaignId/duplicate

Create a resource or run this action.

Bearer token

Request

Parameter	In	Req.	Description
`id`	path	Y	Path parameter identifying the resource.
`campaignId`	path	Y	Path parameter identifying the resource.
`name`	body	Y	Display name (min 2, max 120).
`templateId`	body	Y	Text field (min 1, max 64).
`title`	body	Y	Job title shown on the admin profile (min 1, max 160).
`body`	body	Y	Text field (min 1, max 600).
`href`	body	N	Text field (max 300).
`imageUrl`	body	N	HTTPS URL of an uploaded image (max 2048).
`bannerUrl`	body	N	Text field (max 2048).
`channels`	body	Y	Request field. See Zod schema in the route module for constraints.
`abTestEnabled`	body	N	Boolean flag.
`variantBTitle`	body	N	Text field (max 160).
`variantBBody`	body	N	Text field (max 600).
`abSplitPercent`	body	N	Numeric value (min 10, max 90).
`scheduledAt`	body	N	Text field.
`sendNow`	body	Y	Boolean flag.
`audienceType`	body	Y	One of: "event_ticket_holders", "specific_users".
`userIds`	body	N	Text field (max 500).
`respectPreferences`	body	Y	Boolean flag.

Example body

{
  "name": "\u2026",
  "templateId": "\u2026",
  "title": "\u2026",
  "body": "\u2026",
  "href": "\u2026",
  "imageUrl": "\u2026",
  "bannerUrl": "\u2026",
  "channels": "\u2026",
  "abTestEnabled": "\u2026",
  "variantBTitle": "\u2026",
  "variantBBody": "\u2026",
  "abSplitPercent": "\u2026",
  "scheduledAt": "\u2026",
  "sendNow": "\u2026",
  "audienceType": "\u2026",
  "userIds": "\u2026",
  "respectPreferences": "\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/events/:id/notifications/templates

Fetch one resource by id or token.

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

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

Fetch one resource by id or token.

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/events/:id/ticket-stats

Fetch one resource by id or token.

Bearer token

Request

Parameter	In	Req.	Description
`id`	path	Y	Path parameter identifying the resource.
`name`	body	N	Display name (min 2, max 200).
`description`	body	N	Text field (min 1, max 2000).
`coverImageUrl`	body	N	Event cover image URL (max 2048).
`posterImageUrl`	body	N	Text field (max 2048).
`city`	body	N	City name (min 2, max 120).
`venue`	body	N	Venue name (min 2, max 200).
`latitude`	body	N	Numeric value (max 90).
`longitude`	body	N	Numeric value (max 180).
`timezone`	body	N	IANA timezone (e.g. Africa/Windhoek) (max 64).
`startsAt`	body	N	Event or window start time (ISO 8601).
`endsAt`	body	N	Event or window end time (ISO 8601).
`salesEndAt`	body	N	Request field. See Zod schema in the route module for constraints.
`visibility`	body	N	Publication state such as draft or published.
`publishAt`	body	N	Request field. See Zod schema in the route module for constraints.
`capacity`	body	N	Maximum tickets or seats.
`category`	body	N	Request field. See Zod schema in the route module for constraints.
`keywords`	body	N	Text field (min 1, max 80).
`isCashless`	body	N	Whether cashless wallets are enabled for the event.
`allowedPaymentOptionSlugs`	body	N	Text field (min 1, max 80).
`ticketTypes`	body	N	Ticket type definitions with phases and prices.
`promoCodes`	body	N	Array of values. See nested schema in source when complex.
`bulkDiscounts`	body	N	Array of values. See nested schema in source when complex.
`paymentMethodDiscounts`	body	N	Array of values. See nested schema in source when complex.
`sponsors`	body	N	Array of values. See nested schema in source when complex.
`stallTypes`	body	N	Array of values. See nested schema in source when complex.
`tables`	body	N	Array of values. See nested schema in source when complex.
`lineup`	body	N	Array of values. See nested schema in source when complex (max 80).
`promotion`	body	N	Request field. See Zod schema in the route module for constraints.

Example body

{
  "name": "\u2026",
  "description": "\u2026",
  "coverImageUrl": "\u2026",
  "posterImageUrl": "\u2026",
  "city": "\u2026",
  "venue": "\u2026",
  "latitude": "\u2026",
  "longitude": "\u2026",
  "timezone": "\u2026",
  "startsAt": "\u2026",
  "endsAt": "\u2026",
  "salesEndAt": "\u2026",
  "visibility": "\u2026",
  "publishAt": "\u2026",
  "capacity": 0,
  "category": "\u2026",
  "keywords": "\u2026",
  "isCashless": true,
  "allowedPaymentOptionSlugs": "\u2026",
  "ticketTypes": "\u2026",
  "promoCodes": "\u2026",
  "bulkDiscounts": "\u2026",
  "paymentMethodDiscounts": "\u2026",
  "sponsors": "\u2026",
  "stallTypes": "\u2026",
  "tables": "\u2026",
  "lineup": "\u2026",
  "promotion": "\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/events/merchant-invite/:slug

Fetch one resource by id or token.

Public

Request

Parameter	In	Req.	Description
`slug`	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/events/public/: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.

GET /api/events/public/:id/ticket-inventory

Return public ticket availability for an event.

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/events/public/discover

List publicly discoverable events.

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": {
    "events": [
      {
        "id": "66f0event0001",
        "name": "Sunset Fest 2026",
        "city": "Windhoek",
        "venue": "Independence Stadium",
        "startsAt": "2026-10-31T12:00:00.000Z",
        "coverImageUrl": "https://cdn.example/cover.jpg",
        "isCashless": true
      }
    ]
  }
}

Response data

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

Field	Description
`data.events`	Array. Element shape shown when sample includes objects.
`data.events[].id`	Resource identifier (Mongo ObjectId string).
`data.events[].name`	Human-readable name.
`data.events[].city`	City for the event.
`data.events[].venue`	Venue name.
`data.events[].startsAt`	Start timestamp (ISO 8601).
`data.events[].coverImageUrl`	Public cover image URL.
`data.events[].isCashless`	Whether cashless is enabled for the event.

POST /api/events/upload-cover

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.

Lock this page again

Events & catalogue · 50 methods · October 2026

Resolve this before you come in.

Request

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 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 response

Response data

Request

Example response

Response data

Request

Example body

Example response

Response data

Request

Example response

Response data

Request

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