Get one EventProduct

GET

api

content

eventproducts

{id}

Get one EventProduct

curl --request GET \
  --url https://spaces.nexudus.com/api/content/eventproducts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/eventproducts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/eventproducts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CalendarEventId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "TicketNotes": "<string>",
  "Visible": true,
  "DisplayOrder": 123,
  "StartDate": "<string>",
  "EndDate": "<string>",
  "Allocation": 123,
  "MaxTicketsPerAttendee": 123,
  "Sales": 123,
  "Price": 123,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxRateId": 123,
  "TaxRateName": "<string>",
  "FinancialAccountId": 123,
  "FinancialAccountName": "<string>",
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "Members": [
    123
  ],
  "Teams": [
    123
  ],
  "TariffNames": "<string>",
  "TeamNames": "<string>",
  "CoworkerFullNames": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

An Event Product (internally EventProduct) is a purchasable ticket or RSVP option for an event, with its own price, capacity, availability window, and customer-targeting rules.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the EventProduct-Read role.

Path Parameters

integer

required

The Id of the EventProduct record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/eventproducts/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/eventproducts/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/eventproducts/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the event this ticket belongs to; the event’s location determines the owning location for this record..

string

Required ticket name shown to customers on the Members Portal and app..

string

Optional plain-text description of this ticket shown on the Members Portal and app..

string

Optional plain-text notes appended to the confirmation message sent to customers who purchase this ticket..

boolean

Whether customers can see and purchase this ticket from the Members Portal and app; when false the ticket is hidden from the storefront..

integer

Display position of this ticket among the event’s tickets; lower values appear first..

string

UTC start of the inclusive window during which this ticket can be purchased; must not be after EndDate..

string

UTC end of the inclusive window during which this ticket can be purchased; must not be before StartDate..

integer

Maximum number of this ticket type that can be sold; leave empty for no product-specific cap, while the event’s overall capacity still applies..

integer

Maximum number of this ticket a single customer can purchase; leave empty for no per-customer limit..

integer

Read-only ticket sales count maintained by event-attendee data and used when calculating remaining capacity; cannot be set directly..

number

Price charged per ticket in the selected currency; zero makes the ticket free (RSVP only)..

integer

ID of the ISO 4217 currency used for the ticket price..

string

Display value for Currency.Code..

integer

Optional ID of the tax rate applied when this ticket is invoiced; required when the event’s location requires tax rates..

string

Display value for TaxRate.Name..

integer

Optional ID of the financial account used to record ticket revenue; required when the event’s location requires financial accounts..

string

Display value for FinancialAccount.Name..

boolean

Whether only contacts, meaning customers without an active contract, can purchase this ticket; this combines with every other targeting rule, so setting it with OnlyForMembers makes the ticket unavailable to all customers..

boolean

Whether only members, meaning customers with an active contract, can purchase this ticket; this combines with every other targeting rule, so setting it with OnlyForContacts makes the ticket unavailable to all customers..

integer[]

List of plans a customer’s active contract must use to purchase this ticket; an empty list applies no plan restriction, and a non-empty list is enforced in addition to other targeting rules..

integer[]

List of specific customers who can purchase this ticket; an empty list applies no customer-specific restriction, and a non-empty list is enforced in addition to plan, team, member, and contact rules..

integer[]

List of teams a customer must belong to to purchase this ticket; an empty list applies no team restriction, and a non-empty list is enforced in addition to other targeting rules..

string

Read-only comma-separated display names of the plans in the Tariffs collection; change the Tariffs collection instead..

string

Read-only comma-separated display names of the teams in the Teams collection; change the Teams collection instead..

string

Read-only comma-separated display names of the customers in the Members collection; change the Members collection instead..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "CalendarEventId": 0,
  "Name": "",
  "Description": null,
  "TicketNotes": null,
  "Visible": false,
  "DisplayOrder": 0,
  "StartDate": "2025-01-15T10:30:00Z",
  "EndDate": "2025-01-15T10:30:00Z",
  "Allocation": null,
  "MaxTicketsPerAttendee": null,
  "Sales": null,
  "Price": 0,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxRateId": null,
  "TaxRateName": null,
  "FinancialAccountId": null,
  "FinancialAccountName": null,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Tariffs": [],
  "Members": [],
  "Teams": [],
  "TariffNames": null,
  "TeamNames": null,
  "CoworkerFullNames": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "EventProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one EventProduct

curl --request GET \
  --url https://spaces.nexudus.com/api/content/eventproducts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/eventproducts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/eventproducts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "CalendarEventId": 123,
  "Name": "<string>",
  "Description": "<string>",
  "TicketNotes": "<string>",
  "Visible": true,
  "DisplayOrder": 123,
  "StartDate": "<string>",
  "EndDate": "<string>",
  "Allocation": 123,
  "MaxTicketsPerAttendee": 123,
  "Sales": 123,
  "Price": 123,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxRateId": 123,
  "TaxRateName": "<string>",
  "FinancialAccountId": 123,
  "FinancialAccountName": "<string>",
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "Members": [
    123
  ],
  "Teams": [
    123
  ],
  "TariffNames": "<string>",
  "TeamNames": "<string>",
  "CoworkerFullNames": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200