Luma API

https://docs.luma.com/
Admin
The Luma API is a JSON-based API that allows programmatic management of events and guests, enabling...
Tokens:1,030,419
Snippets:2,153
Trust Score:9.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### User Authentication API

Source: https://docs.luma.com/reference/getting-started-with-your-api

This endpoint allows you to retrieve information about the currently authenticated user by providing a valid API key.

```APIDOC
## GET /v1/user/get-self

### Description
Retrieves information about the currently authenticated user.

### Method
GET

### Endpoint
`https://public-api.luma.com/v1/user/get-self`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -H "x-luma-api-key: $LUMA_API_KEY" https://public-api.luma.com/v1/user/get-self
```

### Response
#### Success Response (200)
- **user_id** (string) - The unique identifier for the user.
- **email** (string) - The email address of the user.
- **name** (string) - The name of the user.

#### Response Example
```json
{
  "user_id": "usr_12345",
  "email": "user@example.com",
  "name": "John Doe"
}
```
```

--------------------------------

### GET /websites/luma/currency

Source: https://docs.luma.com/reference/post_v1-memberships-members-add

Retrieves a list of supported currencies.

```APIDOC
## GET /websites/luma/currency

### Description
Retrieves a comprehensive list of currency codes supported by the Luma platform.

### Method
GET

### Endpoint
/websites/luma/currency

### Parameters
#### Query Parameters
None

### Request Example
None

### Response
#### Success Response (200)
- **currencies** (array) - A list of currency code strings.

#### Response Example
{
  "currencies": [
    "usd",
    "eur",
    "gbp"
  ]
}
```

--------------------------------

### GET /websites/luma/project

Source: https://docs.luma.com/reference/get_v1-user-get-self

Retrieves information about the Luma website project.

```APIDOC
## GET /websites/luma/project

### Description
Retrieves comprehensive details about the Luma website project.

### Method
GET

### Endpoint
/websites/luma/project

### Parameters
#### Query Parameters
None

### Request Example
```json
{
  "example": "No request body needed for GET request"
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the project.
- **amount** (number) - The total amount associated with the project.
- **amount_discount** (number) - The amount of discount applied.
- **amount_tax** (number) - The amount of tax applied.
- **currency** (string) - The currency used for amounts.
- **coupon_info** (object) - Information about any applied coupon.
- **is_captured** (boolean) - Indicates if the amount has been captured.
- **api_id** (string) - The API identifier for the project.

#### Response Example
```json
{
  "id": "proj_12345",
  "amount": 100.00,
  "amount_discount": 10.00,
  "amount_tax": 5.00,
  "currency": "USD",
  "coupon_info": {
    "code": "SUMMER20",
    "discount": 20.00
  },
  "is_captured": true,
  "api_id": "api_abcde"
}
```
```

--------------------------------

### Get Self API Request (Node.js)

Source: https://docs.luma.com/reference/miscellaneous

Provides an example of making a GET request to the 'Get Self' endpoint using Node.js. This snippet assumes you have a library like 'node-fetch' or 'axios' installed for making HTTP requests.

```javascript
// Assumes 'node-fetch' or similar is installed
// import fetch from 'node-fetch';

fetch('https://public-api.luma.com/v1/user/get-self', {
  method: 'GET',
  headers: {
    'accept': 'application/json'
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error('Error:', error));
```

--------------------------------

### Create Website Configuration

Source: https://docs.luma.com/reference/post_v1-event-ticket-types-create

This endpoint allows for the creation of website configurations, including details about payment types, currency, and flexibility options.

```APIDOC
## POST /websites/luma

### Description
Creates a new website configuration with specified payment and currency settings.

### Method
POST

### Endpoint
/websites/luma

### Parameters
#### Request Body
- **name** (string) - Required - The name of the website configuration.
- **require_approval** (boolean) - Required - Indicates if approval is required for this configuration.
- **ethereum_token_requirements** (array) - Required - A list of Ethereum token requirements.
  - **type** (string) - Required - The type of token requirement.
  - **currency** (string) - Required - The currency associated with the token.
  - **cents** (integer) - Required - The amount in cents.
  - **is_flexible** (boolean) - Required - Flexibility option for the requirement.
  - **min_cents** (integer or null) - Optional - Minimum amount in cents.
- **type** (string) - Required - The type of the website configuration.
- **cents** (integer) - Required - The default amount in cents.
- **currency** (string) - Required - The default currency for the configuration. Example: "usd"
- **is_flexible** (boolean) - Required - Indicates if the configuration is flexible.
- **min_cents** (integer or null) - Optional - The minimum amount in cents for transactions.

### Request Example
```json
{
  "name": "Example Website",
  "require_approval": true,
  "ethereum_token_requirements": [
    {
      "type": "deposit",
      "currency": "eth",
      "cents": 10000,
      "is_flexible": false,
      "min_cents": 5000
    }
  ],
  "type": "payment",
  "cents": 5000,
  "currency": "usd",
  "is_flexible": true,
  "min_cents": 1000
}
```

### Response
#### Success Response (200)
- **message** (string) - A success message indicating the configuration was created.

#### Response Example
```json
{
  "message": "Website configuration created successfully."
}
```
```

--------------------------------

### GET /websites/luma/products

Source: https://docs.luma.com/reference/get_v1-calendar-coupons

Retrieves a list of products available on the Luma website. Includes details such as product ID, name, description, price, and currency.

```APIDOC
## GET /websites/luma/products

### Description
Retrieves a list of products available on the Luma website. Includes details such as product ID, name, description, price, and currency.

### Method
GET

### Endpoint
/websites/luma/products

### Parameters
#### Query Parameters
- **currency** (string) - Optional - Filters products by a specific currency code (e.g., 'USD', 'EUR').

### Request Example
```bash
GET /websites/luma/products?currency=USD
```

### Response
#### Success Response (200)
- **products** (array) - An array of product objects.
  - **id** (string) - The unique identifier for the product.
  - **name** (string) - The name of the product.
  - **description** (string) - A detailed description of the product.
  - **price** (number) - The price of the product.
  - **currency** (string) - The currency code for the product's price.

#### Response Example
```json
{
  "products": [
    {
      "id": "prod-123",
      "name": "Example Product",
      "description": "This is a sample product description.",
      "price": 19.99,
      "currency": "USD"
    }
  ]
}
```
```

--------------------------------

### User Authentication API

Source: https://docs.luma.com/index

This endpoint is used to test the validity of your API key by retrieving information about the authenticated user. It requires your API key to be included in the request headers.

```APIDOC
## GET /v1/user/get-self

### Description
Retrieves information about the currently authenticated user.

### Method
GET

### Endpoint
/v1/user/get-self

### Parameters
#### Headers
- **x-luma-api-key** (string) - Required - Your Luma API key for authentication.

### Request Example
```bash
curl -H "x-luma-api-key: $LUMA_API_KEY" https://public-api.luma.com/v1/user/get-self
```

### Response
#### Success Response (200)
- **user_info** (object) - Contains details about the authenticated user.
  - **id** (string) - The unique identifier of the user.
  - **name** (string) - The name of the user.
  - **email** (string) - The email address of the user.

#### Response Example
```json
{
  "user_info": {
    "id": "user_123",
    "name": "John Doe",
    "email": "john.doe@example.com"
  }
}
```
```

--------------------------------

### Test API Authentication with cURL

Source: https://docs.luma.com/index

This snippet demonstrates how to authenticate your API requests using a cURL command. It includes the necessary header for your API key and the endpoint for retrieving user information. Ensure you have a Luma Plus subscription and a valid API key.

```bash
curl -H "x-luma-api-key: $LUMA_API_KEY" https://public-api.luma.com/v1/user/get-self
```

--------------------------------

### Discount Application API

Source: https://docs.luma.com/reference/post_v1-event-add-guests

This section outlines the structure for applying discounts, including details about the coupon, percentage off, cents off, currency, and the associated API ID.

```APIDOC
## Discount Object Structure

### Description
Represents a discount applied to an order or transaction.

### Properties
- **api_id** (string) - The API identifier for the discount. (Deprecated)
- **percent_off** (number) - The percentage discount applied.
- **cents_off** (number) - The discount amount in cents.
- **currency** (string) - The currency code for the discount (e.g., USD, EUR). Valid codes include: `"usd", "eur", "gbp", "cad", "aud", "jpy", "cny", "inr", "brl", "mxn", "rub", "try", "sek", "chf", "sgd", "hkd", "nzd", "krw", "twd", "nok", "dkk", "pln", "czk", "huf", "ils", "myr", "php", "thb", "idr", "vnd", "uah", "zar", "pkr", "sar", "qar", "ron", "rsd", "bgf", "bgn", "hrk", "isk", "ltl", "lvl", "mdl", "mkd", "pen", "pyg", "uyu", "vef", "yer`, `"afn", "all", "amd", "ang", "aoa", "ars", "awg", "azn", "bam", "bbd", "BDT", "bgn", "bhd", "bif", "bmd", "bnd", "bob", "bwp", "byr", "bzd", "cdf", "clf", "clp", "cop", "crc", "cup", "cve", "djf", "dop", "dzd", "egp", "ERN", "ETB", "fkp", "frm", "gbp", "gel", "ggp", "GHS", "GIP", "gmd", "gnf", "gtq", "gyd", "HNL", "hrk", "htg", "huf", "idr", "ils", "inr", "iqd", "irr", "isk", "jmd", "jod", "kes", "kgs", "KHR", "kmf", "kpw", "krw", "kwd", "kyd", "kzt", "lak", "lbp", "lkr", "lrd", "lsl", "ltl", "lvl", "lyd", "mad", "mdl", "mga", "mkd", "mmk", "mnt", "mop", "mro", "mur", "mvr", "mwk", "mxn", "myr", "mzn", "nad", "ngn", "nio", "npr", "omr", "pab", "pen", "pgk", "php", "pkr", "pln", "pyg", "qar", "ron", "rub", "rwf", "sar", "sbd", "scr", "sek", "sgd", "shp", "sle", "sos", "srd", "std", "szl", "thb", "tjs", "tnd", "top", "try", "ttd", "twd", "tzs", "uah", "ugx", "usd", "uyu", "uzs", "vnd", "vuv", "wst", "xaf", "xcd", "xof", "xpf", "yer", "zar", "zmw"
- **code** (string) - The discount code itself.
- **coupon_info** (object) - Additional information about the coupon.
  - **api_id** (string) - The API identifier for the coupon. (Deprecated)
  - **percent_off** (number) - The percentage discount applied.
  - **cents_off** (number) - The discount amount in cents.
  - **currency** (string) - The currency code for the discount.
  - **code** (string) - The discount code itself.
- **is_captured** (boolean) - Indicates if the discount has been captured.

### Required Fields
`api_id`, `percent_off`, `cents_off`, `currency`, `code`
```

--------------------------------

### GET /products

Source: https://docs.luma.com/reference/get_v1-calendar-lookup-event

Retrieves a list of all products available on the Luma platform. Supports filtering by currency.

```APIDOC
## GET /products

### Description
Retrieves a list of all products available on the Luma platform. Supports filtering by currency.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **currency** (string) - Optional - Filters products by the specified currency code. Accepted values include: 'usd', 'eur', 'gbp', and many others.

### Request Example
```
GET /products?currency=usd
```

### Response
#### Success Response (200)
- **products** (array) - A list of product objects.
  - **id** (string) - The unique identifier for the product.
  - **name** (string) - The name of the product.
  - **description** (string) - A detailed description of the product.
  - **price** (number) - The price of the product.
  - **currency** (string) - The currency of the product's price.

#### Response Example
```json
{
  "products": [
    {
      "id": "prod_123",
      "name": "Luma T-Shirt",
      "description": "A comfortable cotton t-shirt.",
      "price": 25.00,
      "currency": "usd"
    }
  ]
}
```
```

--------------------------------

### Get Self API Request (PHP)

Source: https://docs.luma.com/reference/miscellaneous

An example of how to retrieve user information from the 'Get Self' endpoint using PHP. This uses cURL to make the HTTP GET request.

```php
$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://public-api.luma.com/v1/user/get-self');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'accept: application/json'
]);

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo $response;
}

curl_close($ch);
```

--------------------------------

### Project Luma - Website Configuration

Source: https://docs.luma.com/reference/post_v1-calendar-create-person-tag

This section describes the structure of the website configuration, particularly focusing on registration answers.

```APIDOC
## Website Configuration

### Description
This endpoint provides configuration details for the Luma website, including specifics about user registration answers.

### Method
GET

### Endpoint
/websites/luma

### Parameters
This endpoint does not have any path or query parameters.

### Request Body
This endpoint does not have a request body.

### Response
#### Success Response (200)
- **registration_answers** (array) - An array of registration answers, each containing details about the question and the user's response.
  - **label** (string) - The label of the registration question.
  - **question_id** (string) - The unique identifier for the question.
  - **value** (boolean or object) - The user's answer to the question. Can be a boolean for agreement checks or an object for company-related questions.
    - **company** (string or null) - The company name provided by the user.
    - **job_title** (string or null) - The job title provided by the user.
  - **answer** (boolean or string or null) - The user's response to the question.
  - **question_type** (string) - The type of question (e.g., 'agree-check', 'company').
  - **answer_company** (string or null) - The company name as part of the answer.
  - **answer_job_title** (string or null) - The job title as part of the answer.

#### Response Example
```json
{
  "registration_answers": [
    {
      "label": "Agree to terms",
      "question_id": "terms_agreement",
      "value": true,
      "answer": true,
      "question_type": "agree-check"
    },
    {
      "label": "Company Information",
      "question_id": "company_details",
      "value": {
        "company": "Example Corp",
        "job_title": "Software Engineer"
      },
      "answer": "Example Corp",
      "answer_company": "Example Corp",
      "answer_job_title": "Software Engineer",
      "question_type": "company"
    }
  ]
}
```
```

--------------------------------

### Get Self API Request (Ruby)

Source: https://docs.luma.com/reference/miscellaneous

Demonstrates making a GET request to the 'Get Self' endpoint using Ruby's built-in Net::HTTP library. This example fetches and prints the JSON response.

```ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://public-api.luma.com/v1/user/get-self')
request = Net::HTTP::Get.new(uri)
request['accept'] = 'application/json'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body
```

--------------------------------

### POST /websites/luma

Source: https://docs.luma.com/reference/post_v1-event-create

Creates a new Luma website.

```APIDOC
## POST /websites/luma

### Description
Creates a new Luma website with the provided details.

### Method
POST

### Endpoint
/websites/luma

### Parameters
#### Request Body
- **name** (string) - Required - The name of the website.
- **url** (string) - Required - The URL of the website.
- **location** (object) - Required - Details about the website's location.
  - **address** (string) - Required - The street address.
  - **city** (string) - Required - The city.
  - **region** (string) - Required - The region or state.
  - **country** (string) - Required - The country.
  - **city_state** (string) - Required - Combined city and state.
  - **full_address** (string) - Required - The complete address string.
  - **google_maps_place_id** (string) - Required - Google Maps place ID.
  - **apple_maps_place_id** (string) - Required - Apple Maps place ID.
  - **description** (string) - Required - A description of the location.
- **geo_latitude** (string) - Optional - The geographical latitude.
- **geo_longitude** (string) - Optional - The geographical longitude.
- **meeting_url** (string) - Optional - URL for virtual meetings.
- **cover_url** (string) - Required - URL of the website's cover image.
- **registration_questions** (array) - Optional - List of questions for user registration.
  - **id** (string) - Required - The ID of the question.
  - **label** (string) - Required - The text of the question.
  - **required** (boolean) - Required - Whether the question is mandatory.
  - **question_type** (string) - Required - The type of the question.

### Request Example
```json
{
  "name": "New Luma Site",
  "url": "https://newsite.com",
  "location": {
    "address": "456 Oak Ave",
    "city": "Otherville",
    "region": "NY",
    "country": "USA",
    "city_state": "Otherville, NY",
    "full_address": "456 Oak Ave, Otherville, NY, USA",
    "google_maps_place_id": "ChIJ...",
    "apple_maps_place_id": "456...",
    "description": "Branch office"
  },
  "geo_latitude": "40.7128",
  "geo_longitude": "-74.0060",
  "cover_url": "https://newsite.com/cover.png",
  "registration_questions": [
    {
      "id": "q2",
      "label": "What is your favorite animal?",
      "required": true,
      "question_type": "dropdown"
    }
  ]
}
```

### Response
#### Success Response (201)
- **id** (string) - The unique identifier of the newly created website.
- **name** (string) - The name of the website.
- **url** (string) - The URL of the website.
- **location** (object) - Details about the website's location.
- **geo_latitude** (string) - The geographical latitude.
- **geo_longitude** (string) - The geographical longitude.
- **meeting_url** (string) - URL for virtual meetings.
- **cover_url** (string) - URL of the website's cover image.
- **registration_questions** (array) - List of questions for user registration.

#### Response Example
```json
{
  "id": "abcdef12-3456-7890-abcd-ef1234567890",
  "name": "New Luma Site",
  "url": "https://newsite.com",
  "location": {
    "address": "456 Oak Ave",
    "city": "Otherville",
    "region": "NY",
    "country": "USA",
    "city_state": "Otherville, NY",
    "full_address": "456 Oak Ave, Otherville, NY, USA",
    "google_maps_place_id": "ChIJ...",
    "apple_maps_place_id": "456...",
    "description": "Branch office"
  },
  "geo_latitude": "40.7128",
  "geo_longitude": "-74.0060",
  "meeting_url": null,
  "cover_url": "https://newsite.com/cover.png",
  "registration_questions": [
    {
      "id": "q2",
      "label": "What is your favorite animal?",
      "required": true,
      "question_type": "dropdown"
    }
  ]
}
```
```

--------------------------------

### Get Event Details (PHP)

Source: https://docs.luma.com/reference/events

A PHP example for calling the Luma API to get event data. This snippet would likely utilize cURL functions or a Guzzle HTTP client to send the GET request.

```php
// Placeholder for PHP code example
// $ch = curl_init();
// 
// curl_setopt($ch, CURLOPT_URL, 'https://public-api.luma.com/v1/event/get');
// curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
// curl_setopt($ch, CURLOPT_HTTPHEADER, array('accept: application/json'));
// 
// $response = curl_exec($ch);
// curl_close($ch);
// 
// echo $response;
```

--------------------------------

### Get Event Details (Node.js)

Source: https://docs.luma.com/reference/events

Example of fetching event details using Node.js, likely with a library like 'axios' or the built-in 'https' module. It constructs the GET request to the Luma API endpoint.

```javascript
// Placeholder for Node.js code example
// const axios = require('axios');
// 
// axios.get('https://public-api.luma.com/v1/event/get', {
//   headers: {
//     'accept': 'application/json'
//   }
// })
// .then(response => {
//   console.log(response.data);
// })
// .catch(error => {
//   console.error(error);
// });
```

--------------------------------

### Website Configuration and Content

Source: https://docs.luma.com/reference/get_v1-event-ticket-types-list

This section details the structure for website configuration, including question types and tags, and provides examples of how these might be used within the API.

```APIDOC
## Website Content Schema

### Description
Defines the structure for various question types and tag objects used within the Luma website API.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
#### Request Body
- **question_type** (string) - Required - The type of question (e.g., "twitter", "text", "url", "youtube").
- **id** (string) - Required - Unique identifier for the question or tag.
- **label** (string) - Required - The text label for the question.
- **required** (boolean) - Required - Indicates if the field is mandatory.
- **url** (string) - Optional - The URL associated with the content.
- **visibility** (string) - Optional - Controls the visibility of the content (enum: "public", "members-only", "private").
- **tags** (array) - Optional - A list of tags associated with the content, where each tag has an `id` and `name`.

### Request Example
```json
{
  "question_type": "twitter",
  "id": "q123",
  "label": "Your Twitter Handle?",
  "required": true,
  "tags": [
    {
      "id": "t001",
      "name": "social-media"
    }
  ]
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the content.
- **label** (string) - The label associated with the content.
- **required** (boolean) - Indicates if the field was required.
- **question_type** (string) - The type of question.
- **url** (string) - The URL if applicable.
- **visibility** (string) - The visibility setting.
- **tags** (array) - A list of associated tags.

#### Response Example
```json
{
  "id": "content_abc",
  "label": "Welcome Message",
  "required": false,
  "question_type": "text",
  "visibility": "public"
}
```
```

--------------------------------

### Create Website Plan

Source: https://docs.luma.com/reference/post_v1-event-ticket-types-update

This endpoint allows for the creation of a new website plan within the Luma project. It requires various details about the plan, including its name, approval requirements, token specifics, type, pricing, currency, flexibility, and minimum cents.

```APIDOC
## POST /websites/luma/plans

### Description
Creates a new website plan with specified attributes.

### Method
POST

### Endpoint
/websites/luma/plans

### Parameters
#### Request Body
- **name** (string) - Required - The name of the plan.
- **require_approval** (boolean) - Required - Indicates if approval is required for this plan.
- **ethereum_token_requirements** (object) - Required - Requirements related to Ethereum tokens.
  - **amount** (integer) - Required - The amount of tokens required.
  - **token_address** (string) - Required - The address of the token.
- **type** (string) - Required - The type of the plan (e.g., 'token', 'credit').
- **cents** (integer) - Required - The price of the plan in cents.
- **currency** (string) - Required - The currency of the plan (e.g., 'usd', 'eur').
  - Accepted values include: 'usd', 'eur', 'gbp', 'cad', 'aud', 'jpy', 'cny', 'inr', 'brl', 'mxn', 'rub', 'krw', 'try', 'sgd', 'hkd', 'nzd', 'chf', 'sek', 'dkk', 'nok', 'czk', 'huf', 'ils', 'php', 'twd', 'myr', 'idr', 'thb', 'vnd', 'pln', 'zar', 'pkr', 'uah', 'kwd', 'sar', 'qar', 'omr', 'bhd', 'amd', 'azn', 'bdt', 'bmd', 'bob', 'bwp', 'byn', 'cdf', 'clp', 'cop', 'crc', 'cve', 'djf', 'dop', 'dzn', 'egp', 'etb', 'fkp', 'gel', 'gmd', 'gnf', 'gtq', 'gyd', 'hnl', 'hrk', 'htg', 'jmd', 'jod', 'kes', 'kgs', 'khr', 'kmf', 'kyd', 'lak', 'lbp', 'lkr', 'lrd', 'lsl', 'mad', 'mdl', 'mga', 'mkd', 'mmk', 'mnt', 'mop', 'mur', 'mvr', 'mwk', 'mzn', 'nad', 'ngn', 'nio', 'nok', 'npr', 'pab', 'pen', 'pgk', 'pyg', 'ron', 'rsd', 'sos', 'srd', 'std', 'szl', 'tjs', 'tnd', 'top', 'ttd', 'tzs', 'ugx', 'uyu', 'uzs', 'vuv', 'wst', 'xaf', 'xcd', 'xof', 'xpf', 'yer', 'zmw'.
- **is_flexible** (boolean) - Required - Indicates if the plan is flexible.
- **min_cents** (integer or null) - Required - The minimum price in cents if the plan is flexible.

### Request Example
```json
{
  "name": "Starter Plan",
  "require_approval": false,
  "ethereum_token_requirements": {
    "amount": 10,
    "token_address": "0x1234567890abcdef1234567890abcdef12345678"
  },
  "type": "token",
  "cents": 5000,
  "currency": "usd",
  "is_flexible": true,
  "min_cents": 4000
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the created plan.
- **name** (string) - The name of the plan.
- **require_approval** (boolean) - Indicates if approval is required.
- **ethereum_token_requirements** (object) - Details about Ethereum token requirements.
  - **amount** (integer) - Amount of tokens.
  - **token_address** (string) - Address of the token.
- **type** (string) - Type of the plan.
- **cents** (integer) - Price in cents.
- **currency** (string) - Currency of the plan.
- **is_flexible** (boolean) - Indicates if the plan is flexible.
- **min_cents** (integer or null) - Minimum price in cents.

#### Response Example
```json
{
  "id": "plan_abc123",
  "name": "Starter Plan",
  "require_approval": false,
  "ethereum_token_requirements": {
    "amount": 10,
    "token_address": "0x1234567890abcdef1234567890abcdef12345678"
  },
  "type": "token",
  "cents": 5000,
  "currency": "usd",
  "is_flexible": true,
  "min_cents": 4000
}
```
```

--------------------------------

### List Events using Python

Source: https://docs.luma.com/reference/calendars

This Python script utilizes the 'requests' library to fetch a list of events from the Luma public API. It performs a GET request and prints the JSON response. Ensure you have the 'requests' library installed (`pip install requests`).

```python
import requests

url = "https://public-api.luma.com/v1/calendar/list-events"

headers = {
  "accept": "application/json"
}

try:
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # Raise an exception for bad status codes
    print(response.json())
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
```

--------------------------------

### Project Configuration Details

Source: https://docs.luma.com/reference/get_v1-event-ticket-types-get

This section details the configuration schema for projects within the Luma platform, including pricing and membership restrictions.

```APIDOC
## Project Configuration Details

### Description
Provides a detailed schema for project configurations, including pricing models, approval workflows, and flexible event settings.

### Method
N/A (Schema Definition)

### Endpoint
N/A (Schema Definition)

### Parameters
#### Request Body Schema
This schema outlines the structure of a project configuration object.

- **name** (string) - Required - The name of the project.
- **require_approval** (boolean) - Required - Indicates if approval is required for project entries.
- **ethereum_token_requirements** (object) - Required - Specifies requirements related to Ethereum tokens.
- **type** (string) - Required - The type of project.
- **cents** (integer) - Required - The base price in cents.
- **currency** (string) - Required - The currency code (e.g., USD).
- **is_flexible** (boolean) - Required - Indicates if the pricing is flexible, must be false.
- **min_cents** (null) - Required - Minimum price in cents, currently defined as null.

- **is_hidden** (boolean) - Optional - Default: false. Indicates if the project is hidden.
- **description** (string | null) - Optional - A description for the project.
- **valid_start_at** (string | null) - Optional - The start date/time for project validity.
- **valid_end_at** (string | null) - Optional - The end date/time for project validity.
- **max_capacity** (number | null) - Optional - The maximum capacity for the project.
- **membership_restriction** (object | null) - Optional - Restriction based on membership tiers.
  - **type** (string) - Required - The type of membership restriction ('all-members' or 'memberships').
  - **calendar_membership_tier_api_ids** (array[string]) - Required (if type is 'memberships') - List of membership tier IDs.

### Request Example
```json
{
  "name": "Example Project",
  "require_approval": true,
  "ethereum_token_requirements": {},
  "type": "event",
  "cents": 1000,
  "currency": "USD",
  "is_flexible": false,
  "min_cents": null,
  "is_hidden": false,
  "description": "An example project for demonstration.",
  "valid_start_at": "2023-10-27T10:00:00Z",
  "valid_end_at": null,
  "max_capacity": 50,
  "membership_restriction": {
    "type": "memberships",
    "calendar_membership_tier_api_ids": ["tier_abc", "tier_xyz"]
  }
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Project Configuration

Source: https://docs.luma.com/reference/get_v1-event-get-guests

This section details the structure for defining project configurations, including question types and their properties.

```APIDOC
## Project Configuration Details

### Description
Defines the schema for project configurations, including various question types and their associated properties.

### Method
N/A (Schema definition)

### Endpoint
N/A (Schema definition)

### Parameters
#### Request Body (Schema Definition)
This describes the structure of the request body for defining project configurations. It includes an array of objects, each representing a question type with its properties.

- **type** (string) - Description of the schema type (e.g., 'object').
- **properties** (object) - An object detailing the properties of each question type.
  - **id** (string) - Unique identifier for the question.
  - **label** (string) - The display label for the question.
  - **required** (boolean) - Indicates if the question is mandatory.
  - **question_type** (string) - The type of question (e.g., 'linkedin', 'long-text', 'multi-select', 'phone-number').
  - **options** (array of strings, optional) - Available options for 'multi-select' question types.
- **required** (array of strings) - List of fields that are required for each question type object.

### Request Example (Schema Structure)
```json
{
  "type": "object",
  "properties": {
    "id": {"type": "string"},
    "label": {"type": "string"},
    "required": {"type": "boolean"},
    "question_type": {"type": "string"}
  },
  "required": ["id", "label", "required", "question_type"]
}
```

### Response
#### Success Response (200)
N/A (Schema definition)

#### Response Example
N/A (Schema definition)
```

--------------------------------

### List Events using Node.js

Source: https://docs.luma.com/reference/calendars

This Node.js example shows how to fetch a list of events from the Luma API using the 'node-fetch' library. It makes a GET request to the 'list-events' endpoint and expects a JSON response.

```javascript
import fetch from 'node-fetch';

const url = "https://public-api.luma.com/v1/calendar/list-events";

fetch(url, {
  method: "GET",
  headers: {
    "accept": "application/json"
  }
})
  .then(response => response.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

--------------------------------

### POST /websites/luma

Source: https://docs.luma.com/reference/post_v1-calendar-import-people

This endpoint is used to create a new website entry within the Luma project. It accepts website details and returns the created website object.

```APIDOC
## POST /websites/luma

### Description
This endpoint creates a new website entry. It requires a request body containing website details and returns the newly created website object upon successful creation.

### Method
POST

### Endpoint
/websites/luma

### Parameters
#### Request Body
- **id** (string) - Required - The unique identifier for the website.
- **amount** (number) - Required - The amount associated with the website.
- **amount_discount** (number) - Required - The discounted amount.
- **amount_tax** (number) - Required - The tax amount.
- **currency** (string) - Required - The currency code for the amounts.
- **coupon_info** (object) - Required - Information about any applied coupons.
  - **coupon_info.coupon_code** (string) - Required - The code of the coupon.
  - **coupon_info.coupon_amount_off** (number) - Required - The amount discounted by the coupon.
- **is_captured** (boolean) - Required - Indicates if the payment has been captured.
- **api_id** (string) - Required - The API identifier for the transaction (deprecated).
- **event** (object) - Optional - Details about an associated event.
  - **event.id** (string) - Required - The unique identifier for the event.
  - **event.user_id** (string) - Required - The ID of the user who created the event.
  - **event.calendar_id** (string) - Required - The ID of the calendar the event belongs to.
  - **event.start_at** (string) - Required - The start date and time of the event in ISO 8601 format.
  - **event.duration_interval** (string) - Required - The duration of the event.
  - **event.end_at** (string) - Required - The end date and time of the event in ISO 8601 format.
  - **event.created_at** (string) - Required - The creation date and time of the event in ISO 8601 format.
  - **event.timezone** (string) - Required - The IANA timezone for the event.
  - **event.name** (string) - Required - The name of the event.
  - **event.description** (string) - Optional - A plain text description of the event.
  - **event.description_md** (string) - Optional - A Markdown description of the event.
  - **event.geo_address_json** (object) - Optional - Geographic address details for the event.
    - **event.geo_address_json.address** (string) - Required - The street address.
    - **event.geo_address_json.city** (string or null) - Optional - The city of the address.
    - **event.geo_address_json.region** (string or null) - Optional - The region or state of the address.

### Request Example
```json
{
  "id": "website123",
  "amount": 100.00,
  "amount_discount": 0.00,
  "amount_tax": 10.00,
  "currency": "USD",
  "coupon_info": {
    "coupon_code": "SUMMER20",
    "coupon_amount_off": 20.00
  },
  "is_captured": true,
  "api_id": "api_abc123",
  "event": {
    "id": "event789",
    "user_id": "user456",
    "calendar_id": "cal001",
    "start_at": "2023-10-27T10:00:00Z",
    "duration_interval": "1h",
    "end_at": "2023-10-27T11:00:00Z",
    "created_at": "2023-10-26T15:30:00Z",
    "timezone": "America/New_York",
    "name": "Project Kickoff Meeting",
    "description": "Initial meeting to discuss project goals.",
    "description_md": "**Initial meeting** to discuss project goals.",
    "geo_address_json": {
      "address": "123 Main St",
      "city": "Anytown",
      "region": "CA"
    }
  }
}
```

### Response
#### Success Response (200)
- **id** (string) - The unique identifier for the website.
- **amount** (number) - The amount associated with the website.
- **amount_discount** (number) - The discounted amount.
- **amount_tax** (number) - The tax amount.
- **currency** (string) - The currency code for the amounts.
- **coupon_info** (object) - Information about any applied coupons.
- **is_captured** (boolean) - Indicates if the payment has been captured.
- **api_id** (string) - The API identifier for the transaction (deprecated).
- **event** (object) - Details about the associated event.

#### Response Example
```json
{
  "id": "website123",
  "amount": 100.00,
  "amount_discount": 0.00,
  "amount_tax": 10.00,
  "currency": "USD",
  "coupon_info": {
    "coupon_code": "SUMMER20",
    "coupon_amount_off": 20.00
  },
  "is_captured": true,
  "api_id": "api_abc123",
  "event": {
    "id": "event789",
    "user_id": "user456",
    "calendar_id": "cal001",
    "start_at": "2023-10-27T10:00:00Z",
    "duration_interval": "1h",
    "end_at": "2023-10-27T11:00:00Z",
    "created_at": "2023-10-26T15:30:00Z",
    "timezone": "America/New_York",
    "name": "Project Kickoff Meeting",
    "description": "Initial meeting to discuss project goals.",
    "description_md": "**Initial meeting** to discuss project goals.",
    "geo_address_json": {
      "address": "123 Main St",
      "city": "Anytown",
      "region": "CA"
    }
  }
}
```
```

--------------------------------

### List Membership Tiers API Request (PHP)

Source: https://docs.luma.com/reference/memberships

Provides a PHP example for fetching membership tiers using cURL. It configures the cURL request to perform a GET operation and set the appropriate 'accept' header.

```php
<?php

$url = 'https://public-api.luma.com/v1/memberships/tiers/list';

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');

$headers = array();
$headers[] = 'Accept: application/json';
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$result = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
}

curl_close($ch);

echo $result;
?>
```

--------------------------------

### List Membership Tiers API Request (Ruby)

Source: https://docs.luma.com/reference/memberships

Shows how to retrieve membership tiers using Ruby with the 'net/http' library. This example makes a GET request to the specified API endpoint and prints the JSON response.

```ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://public-api.luma.com/v1/memberships/tiers/list')
request = Net::HTTP::Get.new(uri)
request['accept'] = 'application/json'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

puts response.body
```
Tokens:
Raw