Saltar al contenido principal

menta tech API Documentation (v.1.0)

Download OpenAPI specification:Download

API for managing events, tickets, and marketplace operations. This documentation covers integrating with the menta platform for event creation, ticket management, secondary market operations, and user authentication.

Base URL: https://api.mentatech.io - Authentication requires a valid API Key in the Authorization header.

The menta platform uses a relational data model where endpoints build upon previously created data. For example, ticket creation requires an existing event with defined price types and zones.

We recommend following this documentation sequentially as it follows the logical integration flow.

While our API has minimal required fields, providing optional fields unlocks more powerful features - from enhanced marketplace capabilities to advanced ticket management. For example, detailed seat information enables precise seat selection, while comprehensive event metadata improves the user experience.

Events

Operations related to creating, updating, and managing events and their associated shows. This is the first step of the integration.

Create an Event

Creates a new event in the system with all associated metadata. Events can include multiple shows, ticket options, and configuration settings. This endpoint provides a standardized way to integrate your ticketing system with menta and serves as the foundation for all ticket operations.

header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
title
required
string

The main title of the event that will be displayed to users throughout the platform.

description
required
string

A detailed description of the event, including relevant information for potential attendees. This supports rich text formatting.

externalReferenceId
required
string

The unique identifier of the event in your ticketing system. This ID is used for all future references to this event.

required
object

Detailed information about the shows or performances that make up this event. An event can have multiple shows, each with its own date, time, and ticket options.

required
object

The primary location where the event will take place. If shows occur in different locations, specify the location at the show level instead.

Array of objects

Information about the organizations or individuals producing the event. This is used for communication, reporting, and access control.

required
object

Global configuration settings that apply to all shows in this event. These can be overridden by show-specific configurations.

object

Seating chart configuration for venues with assigned seating. This includes section layouts, seat numbering, and other seating-related settings.

Responses

Request samples

Content type
application/json
{
  • "title": "Coldplay - Music of the Spheres World Tour",
  • "description": "Enjoy the show with your family and friends. Coldplay - Music of the Spheres World Tour is a show not to be missed.",
  • "externalReferenceId": "123",
  • "shows": {
    },
  • "location": {
    },
  • "producers": [
    ],
  • "configuration": {
    },
  • "seating": {
    }
}

Response samples

Content type
application/json
{
  • "title": "Coldplay - Music of the Spheres World Tour",
  • "description": "Enjoy the show with your family and friends. Coldplay - Music of the Spheres World Tour is a show not to be missed.",
  • "externalReferenceId": "123",
  • "shows": {
    },
  • "location": {
    },
  • "producers": [
    ],
  • "configuration": {
    },
  • "seating": {
    }
}

Update an Event

Updates an existing event with new information. This endpoint requires sending the complete updated event object rather than partial updates. All fields will be replaced with the new values provided. Always include the externalReferenceId to identify which event to update. We strongly recommend to send the entire event object rather than partial properties updates.

header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
title
string

The main title of the event that will be displayed to users throughout the platform.

description
string

A detailed description of the event, including relevant information for potential attendees. This supports rich text formatting.

externalReferenceId
required
string

The unique identifier of the event in your ticketing system. This ID is used for all future references to this event.

object

Detailed information about the shows or performances that make up this event. An event can have multiple shows, each with its own date, time, and ticket options.

object

The primary location where the event will take place. If shows occur in different locations, specify the location at the show level instead.

Array of objects

Information about the organizations or individuals producing the event. This is used for communication, reporting, and access control.

object

Global configuration settings that apply to all shows in this event. These can be overridden by show-specific configurations.

object

Seating chart configuration for venues with assigned seating. This includes section layouts, seat numbering, and other seating-related settings.

Responses

Request samples

Content type
application/json
{
  • "title": "Coldplay - Music of the Spheres World Tour",
  • "description": "Enjoy the show with your family and friends. Coldplay - Music of the Spheres World Tour is a show not to be missed.",
  • "externalReferenceId": "123",
  • "shows": {
    },
  • "location": {
    },
  • "producers": [
    ],
  • "configuration": {
    },
  • "seating": {
    }
}

Response samples

Content type
application/json
{
  • "title": "Coldplay - Music of the Spheres World Tour",
  • "description": "Enjoy the show with your family and friends. Coldplay - Music of the Spheres World Tour is a show not to be missed.",
  • "externalReferenceId": "123",
  • "shows": {
    },
  • "location": {
    },
  • "producers": [
    ],
  • "configuration": {
    },
  • "seating": {
    }
}

Cancel an Event

Cancels an entire event and all associated shows. This action affects all tickets linked to this event and should be used with caution. Once an event is cancelled, all tickets become invalid. Payouts for tickets sold will be cancelled and refunds will be processed for those tickets sold in the secondary market.

header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
required
object
required
object

Responses

Request samples

Content type
application/json
{
  • "params": {
    },
  • "query": {
    }
}

Response samples

Content type
application/json
{
  • "title": "Coldplay - Music of the Spheres World Tour",
  • "description": "Enjoy the show with your family and friends. Coldplay - Music of the Spheres World Tour is a show not to be missed.",
  • "externalReferenceId": "123",
  • "shows": {
    },
  • "location": {
    },
  • "producers": [
    ],
  • "configuration": {
    },
  • "seating": {
    }
}

Define Event Rules

Creates or updates rules for events, specifying behavior for ticket transfers, resales, and other operations. These rules can control various aspects of ticket lifecycle management.

header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
eventId
required
string

The ID of the event in your system.

showId
string

The ID of the show in your system.

ticketOptionId
string

The ID of the ticket option in your system.

priceTypeId
string

The ID of the price type in your system.

number or string or null

The price of the ticket.

ruleType
required
string
Enum: "event" "show" "ticketOption" "priceType" "combination" "override"

The type of rule to create or update.

Responses

Request samples

Content type
application/json
{
  • "eventId": "123",
  • "ruleType": "event"
}

Response samples

Content type
application/json
{
  • "message": "Rules updated successfully",
  • "eventId": "123",
  • "updatedRules": 1
}

Tickets

Operations for ticket creation, management, validation, and admission control.

Create a Ticket

Creates new tickets in the menta system. This operation registers your ticket information in the platform for management and distribution. Each ticket receives a unique identifier that links back to your original ticketId. The request body requires an array of ticket objects with all necessary details. This endpoint is asynchronous and will return a response immediately, while the /v1/sync/tickets endpoint is synchronous. Using this endpoint will put your request in the queue to be processed asynchronously. For high volume of tickets, its recommended to use this endpoint as data will be processed as capacity allows.

header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
externalReferenceEventId
required
string non-empty

The external reference ID of the event this ticket belongs to. This must match an event previously created in the system.

showId
string or null

The ID of the specific show or performance this ticket grants access to.

required
string or string

The email address of the person who purchased the ticket. This is used for communications and to establish initial ownership of the ticket.

ticketId
required
string non-empty

The unique identifier for this ticket in your system. This ID will be used in all future references to this ticket and must be unique for each ticket across your system.

required
object (Ticket Access Specification)

The access information for this ticket, including its unique locator code and the type of access mechanism used.

ticketOptionId
required
string non-empty

The identifier of the ticket option type this ticket belongs to. This links the ticket to its pricing tier and descriptions defined in the event.

priceTypeId
string non-empty

The identifier of the price type applied to this ticket (e.g., Early Bird, Standard, VIP). This is used to track different pricing tiers for the same ticket option.

number or string or null

The original face value price of the ticket in the specified currency. This is the official price set by the event organizer.

buyerEmailExternal
string <email>

(Only use if you are using phone validation) - The email address of the person who purchased the ticket when using phone validation. This is an alternative identifier when email is not the primary contact method.

object
object
object
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Create a Ticket (Sync)

Creates tickets synchronously, returning an immediate response unlike the asynchronous /v1/tickets endpoint. Not suitable for high volume requests. Errors must be handled by your end. Restricted Capacity of 60 requests per minute.

header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
Array ([ 1 .. 100 ] items)
externalReferenceEventId
required
string non-empty

The external reference ID of the event this ticket belongs to. This must match an event previously created in the system.

showId
string or null

The ID of the specific show or performance this ticket grants access to.

required
string or string

The email address of the person who purchased the ticket. This is used for communications and to establish initial ownership of the ticket.

ticketId
required
string non-empty

The unique identifier for this ticket in your system. This ID will be used in all future references to this ticket and must be unique for each ticket across your system.

required
object (Ticket Access Specification)

The access information for this ticket, including its unique locator code and the type of access mechanism used.

ticketOptionId
required
string non-empty

The identifier of the ticket option type this ticket belongs to. This links the ticket to its pricing tier and descriptions defined in the event.

priceTypeId
string non-empty

The identifier of the price type applied to this ticket (e.g., Early Bird, Standard, VIP). This is used to track different pricing tiers for the same ticket option.

number or string or null

The original face value price of the ticket in the specified currency. This is the official price set by the event organizer.

buyerEmailExternal
string <email>

(Only use if you are using phone validation) - The email address of the person who purchased the ticket when using phone validation. This is an alternative identifier when email is not the primary contact method.

object
object
object
object

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get Ticket Public URL

Retrieves a public URL that can be shared with the ticket holder to view and manage their ticket. This URL can optionally include authentication parameters through the loginTrust feature for a seamless user experience. The resulting URL provides access to ticket details, QR codes, and listing options.

path Parameters
ticketId
required
string
query Parameters
loginTrust
string
header Parameters
Authorization
required
string
Example: PUBLIC_2909-bbda-feee-2200-1010

The authentication public api key header. If you are calling from server side, you can also use the Private Key.

Responses

Response samples

Update a Ticket

Updates an existing ticket's properties. This can be used to modify ticket access information, update buyer details, or change other ticket properties after initial creation. The ticket is identified by its ID provided in the path parameter.

path Parameters
ticketId
required
string
header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
required
object
externalReferenceEventId
string non-empty

The external reference ID of the event this ticket belongs to. This must match an event previously created in the system.

showId
string or null

The ID of the specific show or performance this ticket grants access to.

string or string

The email address of the person who purchased the ticket. This is used for communications and to establish initial ownership of the ticket.

object (Ticket Access Specification)

The access information for this ticket, including its unique locator code and the type of access mechanism used.

ticketOptionId
string non-empty

The identifier of the ticket option type this ticket belongs to. This links the ticket to its pricing tier and descriptions defined in the event.

priceTypeId
string non-empty

The identifier of the price type applied to this ticket (e.g., Early Bird, Standard, VIP). This is used to track different pricing tiers for the same ticket option.

number or string or null

The original face value price of the ticket in the specified currency. This is the official price set by the event organizer.

buyerEmailExternal
string <email>

(Only use if you are using phone validation) - The email address of the person who purchased the ticket when using phone validation. This is an alternative identifier when email is not the primary contact method.

object
object
object
object

Responses

Request samples

Content type
application/json
{
  • "UpdateTicketSpecificationBody": {
    }
}

Response samples

Content type
application/json
{
  • "_id": "507f1f77bcf86cd799439011",
  • "ticketId": "444",
  • "showId": "456",
  • "externalReferenceEventId": "123",
  • "ticketOptionId": "789",
  • "price": 100,
  • "currency": "USD",
  • "buyer": {
    },
  • "currentOwnerEmail": "example@email.com",
  • "ticketSellerId": "1010",
  • "status": "ACTIVE"
}

Delete a Ticket

Removes a ticket from the system, invalidating it for all purposes. This operation is typically used for tickets that were issued in error or need to be cancelled for specific reasons. If any listing is active, it will be terminated. Use with caution as this operation cannot be undone.

path Parameters
ticketId
required
string
header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Responses

Register Event Admission

Records a ticket admission at an event, marking the ticket as used. This is typically called by access control systems at venue entrances.

header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
required
object
ticketId
required
string

The ID of the ticket in your system.

Responses

Request samples

Content type
application/json
{
  • "params": {
    }
}

Response samples

Content type
application/json
true

Register Batch Event Admissions

Records multiple ticket admissions at an event in a single request. This is more efficient than making individual calls for each ticket when processing groups of attendees. The response indicates whether all admissions were successfully recorded.

header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
required
Array of objects
Array
ticketId
required
string

The ID of the ticket in your system.

entryDate
required
string

The date of the entry in the event.

Responses

Request samples

Content type
application/json
{
  • "body": [
    ]
}

Response samples

Content type
application/json
true

Get Ticket Sale Public URL

Retrieves the public URL for ticket sales, allowing users to be directed to a page where they can purchase tickets for an event. This URL can be embedded in marketing materials or shared directly with potential customers.

query Parameters
ticketId
required
string
lang
required
string
header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Responses

Response samples

Get My Tickets URL

This endpoint provides a convenient way for users to access all their tickets from your platform through a menta-hosted interface. The URL can include authentication parameters for a seamless experience.

header Parameters
Authorization
required
string
Example: PUBLIC_2909-bbda-feee-2200-1010

The authentication public api key header. If you are calling from server side, you can also use the Private Key.

Responses

Response samples

Marketplace

Operations for the secondary market, including listing tickets for sale and purchasing tickets.

Get Secondary Market Buying Flow URL

Retrieves the entry URL for the ticket buying flow. This URL directs users to the marketplace interface where they can browse and purchase available tickets. The marketplace provides a secure environment for secondary ticket sales with buyer and seller protections.

query Parameters
externalReferenceEventId
required
string
showId
required
string
lang
required
string
returnTo
required
string
ticketOptionId
required
string
header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Responses

Response samples

Get Start Sell Ticket URL

Retrieves the URL to begin the process of selling tickets in the marketplace. This URL directs users to an interface where they can set pricing, listing conditions, and other parameters for their ticket listings. The process includes verification steps to ensure ticket validity.

query Parameters
ticketId
required
string
lang
string
header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Responses

Get Start Sell Order URL

Retrieves the URL to start the sales order process for multiple tickets in a single transaction. This is particularly useful for selling groups of tickets or complete orders from the primary market. The generated URL leads to a specialized interface for creating these bulk listings.

query Parameters
orderId
required
string
lang
string
header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Responses

Get Sell Ticket Details URL

Retrieves the URL for viewing and managing details of a ticket listing. This allows ticket owners to check the status of their listings, modify pricing, or remove listings from the marketplace. The URL can include authentication parameters for direct access.

query Parameters
ticketId
required
string
header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Responses

Create Marketplace Checkout URL

Creates and retrieves a checkout URL for marketplace purchases. This URL directs users to complete their purchase of selected tickets from the secondary market. The checkout process handles payment processing, buyer verification, and ticket transfer in a secure environment. The request requires a list of ticket listing IDs to purchase that you can get from the Get Listed Tickets for Event endpoint.

header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
listingIds
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "listingIds": [
    ]
}

Terminate Listing

Removes a ticket from the marketplace listings, making it unavailable for purchase. This is typically used when a seller wants to cancel their listing without completing a sale. The ticket reverts to its unlisted state and can be used by the owner or listed again later.

path Parameters
ticketId
required
string
header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Responses

Response samples

Content type
application/json
{
  • "_id": "507f1f77bcf86cd799439011"
}

Build Your Own Buyingflow

Streamlined checkout experience for marketplace purchases

Get Listed Tickets for Event

Retrieves all tickets currently listed for sale for a specific event. This allows integration with your platform to display available secondary market tickets. The response includes pricing, seat information, and other details necessary for presenting the listings to potential buyers.

path Parameters
eventId
required
string
header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Responses

Response samples

Content type
application/json
{
  • "totalCount": 15,
  • "bestListing": {
    },
  • "results": [
    ]
}

Create Buy Intention

A Buy Intention is a representation of a user's intention to purchase specific tickets. This creates a temporary reservation to prevent conflicts during the checkout process. Buy intentions have a limited lifetime and will expire if the purchase is not completed within a certain timeframe. You can use this endpoint to create a buy intention for specific tickets and retrieve the payment URL to complete the purchase.

header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Request Body schema: application/json
items
required
Array of strings
user
required
string

The email address of the person who purchased the ticket.

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "user": "example@email.com"
}

Response samples

Content type
application/json
{
  • "_id": "12432423",
  • "attachedCart": {
    },
  • "details": {
    }
}

Auth

Authentication operations for secure user access and verification.

Generate One-Time Token

Creates a one-time authentication token for a specific user. This token can be appended to any menta URL to provide temporary authenticated access. It's useful for redirecting users from your platform to specific menta functions while maintaining their authenticated state. The token is designed for single use and will expire after being used or after a predetermined time period.

query Parameters
user
required
string
method
string
header Parameters
Authorization
required
string
Example: 09deff-2341-ade92341-7090-ff11

The authentication private api key header.

Responses

Response samples

Content type
application/json
{
  • "oneTimeToken": "4238421843090481938491834"
}