Getting started
Welcome to EventBookings API Reference Documentation. The EventBooking API simplifies the process of integrating and extending your event ticketing requirements. This information should give you everything that you need to gather event ticketing data for reporting.
a. Introduction to APIs
What does the term API mean ?
API stands for Application Programming Interface. API is a set of protocols, routines, and tools that enable different software systems to communicate and exchange data with each other.
How does using an API benefit both developers and end-users ?
Using an API can benefit both developers and end-users in several ways, as demonstrated in the following example:
Consider a fitness app that provides users with personalized workout plans and tracks their progress over time. By using an API to integrate with a popular wearable fitness tracker, such as a Fitbit or Apple Watch, the fitness app can benefit in several ways:
- For developers, the API provides a standard interface to access the user’s fitness data (such as heart rate, step count, and activity duration), which can be used to create personalized workout plans that are tailored to the user’s current fitness level. This saves time and effort compared to developing a custom integration with each fitness tracker on the market.
- For end-users, the integration with the fitness tracker means that their workout data is automatically synchronized with the app, eliminating the need to manually enter data or switch between different apps. This provides a seamless user experience and can help to motivate users to continue using the app to track their fitness goals.
Overall, using an API in this scenario benefits both developers and end-users by providing a standard interface to access fitness data from a popular wearable device, which can be used to create a personalized workout experience for the user. This leads to a more efficient development process and a better user experience, ultimately resulting in a more successful and engaging fitness app.
b. Generate API Key
What can you do with the EventBookings API ?
the EventBookings APIs provide developers a standardized way to access the functionality and data of the software web application. Here are some of the functionalities you can do with the Eventbookings APIs.
HTTP Methods | Functionalities |
|---|---|
GET | retrieves a representation of the resource identified by the URL. This is usually used to read or retrieve data from a server. |
POST | submits an entity to be processed by the resource identified by the URL. This is usually used to create new resources or submit data to be processed by a server. |
PUT | replaces the resource identified by the URL with the entity provided in the request. This is usually used to update or replace existing resources on a server. |
PATCH | applies a partial update to the resource identified by the URL. This is usually used to modify a specific part of a resource on a server. |
DELETE | deletes the resource identified by the URL. This is usually used to remove a resource from a server. |
c. Premium Membership
EventBookings website is a hassle-free solution for selling tickets online. It provides a paid API access, where the premium organization can only create application to integrate functionalities to their own system, generate client_id and client_secret etc.
d. Authentication
What is Authentication ?
Authentication is the process of verifying the identity of a user or system that is making a request to access an API (Application Programming Interface). It is a critical security measure that helps to ensure that only authorized users or systems are able to access the API’s resources or data.
There are several different authentication methods that can be used with APIs, including basic authentication, OAuth, JSON Web Tokens (JWTs), and more.
API authentication is a critical security measure that helps to prevent unauthorized access to an API’s resources or data, and ensures that only authorized users or systems are able to access them.
Concept of OAuth
OAuth (Open Authorization) is an open standard protocol that allows secure authorization of third-party access to a user’s resources, without giving away their credentials or having to share unnecessary sensitive information.
An OAuth token can also be called a private token. It is a unique identifier that allows the third-party application to access the user’s resources on the original site, such as their profile information or other data, without having to know the user’s username or password. It provides a secure and convenient way for users to grant third-party applications access to their resources, without having to share their login credentials or other sensitive information.
Getting started with EventBooking Authentication
EventBookings APIs need an authorization bearer token to verify the authenticity of incoming HTTP requests.
- Login to EventBookings
- Create an application. Each application has a client id and a client secret.
- Generate an authorization token
To get an authorization token, you must submit an HTTP POST request to the identity token endpoint of EventBookings.
curl --location --request POST 'https://identity.eventbookings.com/connect/token' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'client_id=your_client_id' \
--data-urlencode 'client_secret=your_client_secret' \
--data-urlencode 'grant_type=client_credentials'Please replace your_client_id and your_client_secret with the client id and client secret associated with your application. Follow the following process to generate a token. The token expires after 1 hour for security purpose. To get a new token please resend the POST request.
1. Click More>My Application
2. Add Application
4. Get the client id & client secret & use them to get the access token
5. Copy the token & paste it to get the access
{
"access_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjJERDUwNUE3OTMxNUUyNjc4NkQwNEFENkMyQUU4RjRFRDBGOTM5Q0ZSUzI1NiIsInR5cCI6ImF0K2p3dCIsIng1dCI6IkxkVUZwNU1WNG1lRzBFcld3cTZQVHRENU9jOCJ9.eyJuYmYiOjE2Nzg3MDY3MzMsImV4cCI6MTY3ODcxMDMzMywiaXNzIjoiaHR0cHM6Ly9pZGVudGl0eS5kaXl3ZWJzaXRlLm5ldC5hdSIsImF1ZCI6IkV2ZW50Qm9va2luZ3NBcGkiLCJjbGllbnRfaWQiOiI0OTViMmE5Mi1iZTZiLTQ3Y2MtYWViNC0xOTkwYWU2NWU5MTYiLCJjbGllbnRfT3JnSWQiOiIzOWJhZDdiNi1kZWNjLTQyYzItOGMwYS00YWJkOTk2NzA5YjIiLCJjbGllbnRfQ3JlYXRvciI6IjhkZDQzYWRkLTA1NWEtNGMzZS1hOGY2LTNhZTI5MWE5ODZlYiIsImp0aSI6IjQ1NkQyRjlGRDFEQUI1QTYxNzNDODFEQkREMjNBNkM3IiwiaWF0IjoxNjc4NzA2NzMzLCJzY29wZSI6WyJhbGwiLCJJZGVudGl0eVNlcnZlckFwaSJdfQ.t3QBwLZR5-0HrYlmhf6RazitkwHEUV9XuqT9sukv5wBOa11NvJZSCTU2FmlZGsFm37p8PEUhdhHV2lspHELZnxa5uhYG1PNOlgzWSJMemlwfokL8ypomLdMJ6p7ZenV9alDpAbGom8IeofB29mu8ZoLQHm-MgFuqHkzXNlbNLX8p188Igd6cF1oeCh6fAyPyx8s9PxfyXgkTUWMblcHmQmsn1iOjtxMyA8_N-5QIc7dxN7PkSO46VlJbwaGdOWe5NazJjs0XFJKEHrRVPLVlBKam0kG1Ua1eAMzmOMrll6DjEwuff72ZKJ8nSdl3kwLjlJZQ3ktgPtvxZWh860A1ah9e2vKnZ6UK5fixg_eQQ958fsxpFkiKdYbGvLQ7Lpsul1LDNwG3dPurun8uQvyZSEjJJtN9FYkYqKLABTj29JI3uB7BnJWQbbKk6QR3pE_u688eymTU5Xbgf_vBp6TtlUdt3FphQvl09sVKw85yhiW6oyfvmaLGssHLTAGEZyTWWq_zRQfLqLA-TIn5yj8D84-5DGmWPmk4WnUqVnB7f98K7ecOWwrVrnyTvlKsPHQmc9Pr96IvBbmdjaZZpqcBRXFFXASFhhye9vb8sSVjswDUvlRe8LWGSDqImAJWtY60QstzZTvUrJOSK8uqxd1e9vjAO0vHef-PRQ32oYVIbP4",
"expires_in": 3600,
"token_type": "Bearer",
"scope": "all IdentityServerApi"
} If your request is successful, you will receive a 200 status code with the following parameters.
Parameter name | Type | Description |
|---|---|---|
access_token | string | The authorization token that should be sent to APIs via request headers. |
expires_in | int | The lifetime (in seconds) of the access token. Always one hour. |
token_type | string | The type of the token. You must include the token in the authorization header as a bearer. So the token_type is always Bearer. |
scope | string (separated by space) | A space-separated list of scopes allowed your application |
Once you receive a token, it is advised that you reuse it for subsequent requests until it expires.
This token must be sent within the authorization header with each API request.
curl --location --request GET 'https://eventbooking.com/api/events' \
--header 'Authorization: Bearer authorization_access_token
Please replace authorization_access_token with the token you received from the token endpoint.
You will receive the following error response if your request to the token endpoint is not successful:
Response code | Payload | Description |
|---|
Response code | Payload | Description |
|---|---|---|
| 400 Bad Request | | If your client ID and/or secret is wrong. |
| 400 Bad Request | | If you misspelled client_credentials |
| 400 Bad Request | | If you try to use a grant type other than client_credentials |
d. Basic
Valid Data Types
In JSON, values must be one of the following data types:
- a string
- a number
- an object (JSON object)
- an array
- a boolean
- null
JSON Strings
Strings in JSON must be written in double quotes
{"name":"John"}JSON Numbers
a. Integer :
4
A standard JSON integer.
b. Float :
43.2134
A standard JSON floating-point decimal.
c. Decimal :
42.2134
An arbitrary-precision decimal number encoded as a standard JSON string. Decimals are used in cases where floating-point arithmetic inaccuracies could arise with standard JSON floating-point decimals.
JSON Objects
Values in JSON can be objects.
{"employee":{"name":"Someone", "age":30, "city":"Melbourne"}JSON Arrays
Values in JSON can be arrays.
{"employees":["X", "Y", "Z"]}JSON Booleans
Values in JSON can be true/false.
{"sale":true}JSON Null
Values in JSON can be null.
{"lastname":null}Query String
None
Request
No data
Response
Me
End Point | Methods | Scope | Purpose | |
|---|---|---|---|---|
| 1 | /me/passwd | POST | me.change_password | Facilitates my password change Validates if the client is authenticated as user as part of authorization |
| 2 | /me/receive_verification_email | POST | me.receive_verification_email | Resends me the email containing email verification link // quota test required // do not send if verified Validates if the client is authenticated as user as part of authorization |
| 3 | /me/mute | POST | me.mute | Mutes user or org Validates if the client is authenticated as user as part of authorization |
| 4 | /me/unmute | POST | me.unmute | Unmutes user or org Validates if the client is authenticated as user as part of authorization |
| 5 | /me/change_email | POST |
| Changes my email |
| 6 | /me/change_phone | POST |
| Changes my phone number |
| 7 | /me/verify_otp | POST |
| Verifies OTP of email or phone |
| 8 | /me | PATCH | me.update | Updates my user information Validates if the client is authenticated as user as part of authorization |
| 9 | /me | GET | me.read | Retrieves my account information // no privacy test required Validates if the client is authenticated as user as part of authorization |
| 10 | /me/mutes | GET | me.read_mutes | Retrieves list of entities muted by me or my orgs Validates if the client is authenticated as user as part of authorization |
| 11 | /me/saves | GET | me.list_save | Retrieves all my event saves Validates if the client is authenticated as user as part of authorization |
| 12 | /me/{uuid}/tickets | GET | me.list_ticket | Retrieves all tickets belonging to me Validates if the client is authenticated as user as part of authorization |
| 13 | /me/{uuid}/tickets/{uuid} | GET | me.read_ticket | Retrieves a specific ticket belonging to me Validates if the client is authenticated as user as part of authorization |
| 14 | /me/orders | GET | me.list_order | Retrieves all my orders Validates if the client is authenticated as user as part of authorization |
| 15 | /me/orders/{uuid} | GET | me.read_order | Retrieves a specific order placed by me Validates if the client is authenticated as user as part of authorization |
1. GET /me
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
{
"me": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"parent": "",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "suspended",
"value": ""
}
],
"first_name": "John",
"last_name": "Doe",
"display_name": "Johnny",
"bio": "No bio to write",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"timezone": "Australia/Melbourne",
"currency": "AUD",
"latitude": "",
"longitude": "",
"created_on": "",
"updated_on": "",
"email": {
"address": "john@doe.com",
"verified": "true"
},
"phone": {
"number": "",
"verified": "true"
},
"addresses": [
{
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
],
"activities": [
{
"name": "events_attendeed",
"value": "40"
},
{
"name": "events_attended_as_guest",
"value": "20"
},
{
"name": "events_attended_as_speaker",
"value": "20"
}
],
"privacy_settings": [
{
"name": "lock_my_user_profile",
"value": "false"
},
{
"name": "allow_people_to_see_my_join_date",
"value": "false"
},
{
"name": "hide_review_interactions_from_public",
"value": "false"
},
{
"name": "allow_people_to_contact_me",
"value": "true"
},
{
"name": "allow_people_to_find_and_invite_me_to_relevant_events",
"value": "false"
},
{
"name": "allow_people_to_follow_me",
"value": "false"
},
{
"name": "allow_people_to_see_my_followings",
"value": "false"
},
{
"name": "allow_people_to_see_the_events_i_attend",
"value": "false"
},
{
"name": "allow_people_to_see_the_events_i_attend_as_speaker",
"value": "false"
},
{
"name": "allow_people_to_see_the_events_i_share",
"value": "false"
}
],
"email_preferences": [
{
"name": "receive_order_confirmation",
"value": "false",
"read-only": "true"
},
{
"name": "receive_communication_from_event_organisers_for_my_purchased_events",
"value": "true",
"read-only": "true"
},
{
"name": "receive_event_invitations_from_event_organisers_sent_to_my_email_address",
"value": "true",
"read-only": "true"
},
{
"name": "receive_reminder_from_eventbookings_for_my_purchased_events",
"value": "false",
"read-only": "false"
},
{
"name": "receive_critical_notifications_on_eventbookings_service_status_and_product_updates",
"value": "false",
"read-only": "false"
},
{
"name": "receive_newsletters_from_eventbookings_with_general_and_other_information",
"value": "false",
"read-only": "false"
},
{
"name": "receive_notification_when_someone_follows_me_or_my_organisation",
"value": "false",
"read-only": "false"
},
{
"name": "recieve_notification_when_someone_shares_my_events",
"value": "false",
"read-only": "false"
},
{
"name": "receive_notification_on_review_related_activities",
"value": "false",
"read-only": "false"
}
],
"phone_preferences": [
{
"name": "receive_order_confirmation",
"value": "false",
"read-only": "false"
},
{
"name": "receive_communication_from_event_organisers_for_my_purchased_events",
"value": "true",
"read-only": "true"
},
{
"name": "receive_event_invitations_from_event_organisers_sent_to_my_email_address",
"value": "true",
"read-only": "true"
},
{
"name": "receive_reminder_from_eventbookings_for_my_purchased_events",
"value": "false",
"read-only": "false"
},
{
"name": "receive_critical_notifications_on_eventbookings_service_status_and_product_updates",
"value": "false",
"read-only": "false"
},
{
"name": "receive_newsletters_from_eventbookings_with_general_and_other_information",
"value": "false",
"read-only": "false"
},
{
"name": "receive_notification_when_someone_follows_me_or_my_organisation",
"value": "false",
"read-only": "false"
},
{
"name": "recieve_notification_when_someone_shares_my_events",
"value": "false",
"read-only": "false"
},
{
"name": "receive_notification_on_review_related_activities",
"value": "false",
"read-only": "false"
}
],
"organisations": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"parent": "",
"owner": "true",
"status": "",
"name": "Web Mascot",
"display_name": "webalive",
"info": "",
"slug": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"email": "masumul@bitmascot.com",
"phone": "",
"timezone": "",
"currency": "",
"payment_method": "Securepay"
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
],
"created_on": "",
"updated_on": "",
"addresses": [
{
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"privacy_settings": [
{
"name": "lock_my_organisation_profile",
"value": "false"
},
{
"name": "hide_address_on_my_organisation_profile",
"value": "true"
},
{
"name": "hide_reviews_on_my_organisation_profile",
"value": "false"
},
{
"name": "hide_review_interactions_from_public",
"value": "false"
},
{
"name": "allow_people_to_contact_my_organisation",
"value": "false"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "false"
}
],
"subscriptions": [
{
"type": "core",
"package": "basic",
"starts_on": "",
"renews_on": "",
"expires_on": "",
"order_id": "",
"is_current": ""
},
{
"type": "add-on",
"package": "campaign",
"starts_on": "",
"renews_on": "",
"expires_on": "",
"order_id": "",
"is_current": ""
}
],
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"activities": [
{
"name": "events_hosted",
"value": "304",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "revenue_earned",
"value": "50000",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "orders_received",
"value": "302",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "pages_viewed",
"value": "4,670",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "tickets_sold",
"value": "302",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
}
]
}
]
}
]
}2. PATCH /me
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
first_name | String | Maximum character = 40 | first_name can not exceed 40 characters |
last_name | String | Maximum character = 40 | last_name should be less than or equal to 40 characters |
bio | String | Maximum character = 2500 | bio should be less than or equal to 2500 characters |
image | File |
.jpg, .jpeg, .png |
|
phone | String | Valid phone number | phone number is invalid |
addresses > address_line1 | String | Maximum character = 75 | address_line1 should be less than or equal to 75 characters |
addresses > address_line2 | String | Maximum character = 75 | address_line2 should be less than or equal to 75 characters |
addresses > country | String | Valid country | country is invalid |
addresses > state | String | Valid state | state is invalid |
addresses > city | String | Valid city | city is invalid |
addresses > post_code | String | Valid postcode | zip/post code invalid |
timezone | String | Valid timezone | timezone is invalid |
links > website | String | Must be a valid link | website link is invalid |
links > facebook | String | Must have a valid facebook link format | facebook link is invalid |
links > twitter | String | Must have a valid twitter link format | twitter link is invalid |
links > linkedin | String | Must have a valid linkedin link format | linkedin link is invalid |
links > instagram | String | Must have a valid instagram link format | instagram link is invalid |
privacy_settings > name | String | Accepts a value from a set of pre-defined objects (stated in the payload) | invalid privacy settings name |
privacy_settings > value | Boolean | Accepts only true /false value | value only accept ‘true/false’ |
email_preferences > name | String | Accepts a value from a set of pre-defined objects (stated in the payload) | invalid email preferences name
|
email_preferences > value | Boolean | Accepts only true/false value | value only accept ‘true/false’ |
phone_preferences > name | String | Accepts a value from a set of pre-defined objects (stated in the payload) | invalid phone preferences name |
phone_preferences > value | Boolean | Accepts only true/false value | value only accept ‘true/false’ |
{
"me": [
{
"first_name": "John",
"last_name": "Doe",
"bio": "No bio to write",
"image": "uploads/users/afedf6a97791e196439bab441ba1da95/myprofile/a84e8408-1b31-4bd1-9f44-ff8c5e28da46.jpg",
"phone": "61489046935",
"addresses": [
{
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"privacy_settings": [
{
"name": "lock_my_user_profile",
"value": "false"
},
{
"name": "allow_people_to_see_my_join_date",
"value": "false"
},
{
"name": "hide_review_interactions_from_public",
"value": "false"
},
{
"name": "allow_people_to_contact_me",
"value": "true"
},
{
"name": "allow_people_to_find_and_invite_me_to_relevant_events",
"value": "false"
},
{
"name": "allow_people_to_follow_me",
"value": "false"
},
{
"name": "allow_people_to_see_my_followings",
"value": "false"
},
{
"name": "allow_people_to_see_the_events_i_attend",
"value": "false"
},
{
"name": "allow_people_to_see_the_events_i_attend_as_speaker",
"value": "false"
},
{
"name": "allow_people_to_see_the_events_i_share",
"value": "false"
}
],
"email_preferences": [
{
"name": "receive_order_confirmation",
"value": "false"
},
{
"name": "receive_communication_from_event_organisers_for_my_purchased_events",
"value": "true"
},
{
"name": "receive_event_invitations_from_event_organisers_sent_to_my_email_address",
"value": "true"
},
{
"name": "receive_reminder_from_eventbookings_for_my_purchased_events",
"value": "false"
},
{
"name": "receive_critical_notifications_on_eventbookings_service_status_and_product_updates",
"value": "false"
},
{
"name": "receive_newsletters_from_eventbookings_with_general_and_other_information",
"value": "false"
},
{
"name": "receive_notification_when_someone_follows_me_or_my_organisation",
"value": "false"
},
{
"name": "recieve_notification_when_someone_shares_my_events",
"value": "false"
},
{
"name": "receive_notification_on_review_related_activities",
"value": "false"
}
]
}
],
"phone_preferences": [
{
"name": "receive_order_confirmation",
"value": "false"
},
{
"name": "receive_communication_from_event_organisers_for_my_purchased_events",
"value": "true"
},
{
"name": "receive_event_invitations_from_event_organisers_sent_to_my_email_address",
"value": "true"
},
{
"name": "receive_reminder_from_eventbookings_for_my_purchased_events",
"value": "false"
},
{
"name": "receive_critical_notifications_on_eventbookings_service_status_and_product_updates",
"value": "false"
},
{
"name": "receive_newsletters_from_eventbookings_with_general_and_other_information",
"value": "false"
},
{
"name": "receive_notification_when_someone_follows_me_or_my_organisation",
"value": "false"
},
{
"name": "recieve_notification_when_someone_shares_my_events",
"value": "false"
},
{
"name": "receive_notification_on_review_related_activities",
"value": "false"
}
]
}
Response
{
"me": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"parent": "",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "suspended",
"value": ""
}
],
"first_name": "John",
"last_name": "Doe",
"display_name": "Johnny",
"bio": "No bio to write",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"timezone": "Australia/Melbourne",
"currency": "AUD",
"latitude": "",
"longitude": "",
"created_on": "",
"updated_on": "",
"email": {
"address": "john@doe.com",
"verified": "true"
},
"phone": {
"number": "",
"verified": "true"
},
"addresses": [
{
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
],
"activities": [
{
"name": "events_attendeed",
"value": "40"
},
{
"name": "events_attended_as_guest",
"value": "20"
},
{
"name": "events_attended_as_speaker",
"value": "20"
}
],
"privacy_settings": [
{
"name": "lock_my_user_profile",
"value": "false"
},
{
"name": "allow_people_to_see_my_join_date",
"value": "false"
},
{
"name": "hide_review_interactions_from_public",
"value": "false"
},
{
"name": "allow_people_to_contact_me",
"value": "true"
},
{
"name": "allow_people_to_find_and_invite_me_to_relevant_events",
"value": "false"
},
{
"name": "allow_people_to_follow_me",
"value": "false"
},
{
"name": "allow_people_to_see_my_followings",
"value": "false"
},
{
"name": "allow_people_to_see_the_events_i_attend",
"value": "false"
},
{
"name": "allow_people_to_see_the_events_i_attend_as_speaker",
"value": "false"
},
{
"name": "allow_people_to_see_the_events_i_share",
"value": "false"
}
],
"email_preferences": [
{
"name": "receive_order_confirmation",
"value": "false",
"read-only": "true"
},
{
"name": "receive_communication_from_event_organisers_for_my_purchased_events",
"value": "true",
"read-only": "true"
},
{
"name": "receive_event_invitations_from_event_organisers_sent_to_my_email_address",
"value": "true",
"read-only": "true"
},
{
"name": "receive_reminder_from_eventbookings_for_my_purchased_events",
"value": "false",
"read-only": "false"
},
{
"name": "receive_critical_notifications_on_eventbookings_service_status_and_product_updates",
"value": "false",
"read-only": "false"
},
{
"name": "receive_newsletters_from_eventbookings_with_general_and_other_information",
"value": "false",
"read-only": "false"
},
{
"name": "receive_notification_when_someone_follows_me_or_my_organisation",
"value": "false",
"read-only": "false"
},
{
"name": "recieve_notification_when_someone_shares_my_events",
"value": "false",
"read-only": "false"
},
{
"name": "receive_notification_on_review_related_activities",
"value": "false",
"read-only": "false"
}
],
"phone_preferences": [
{
"name": "receive_order_confirmation",
"value": "false",
"read-only": "false"
},
{
"name": "receive_communication_from_event_organisers_for_my_purchased_events",
"value": "true",
"read-only": "true"
},
{
"name": "receive_event_invitations_from_event_organisers_sent_to_my_email_address",
"value": "true",
"read-only": "true"
},
{
"name": "receive_reminder_from_eventbookings_for_my_purchased_events",
"value": "false",
"read-only": "false"
},
{
"name": "receive_critical_notifications_on_eventbookings_service_status_and_product_updates",
"value": "false",
"read-only": "false"
},
{
"name": "receive_newsletters_from_eventbookings_with_general_and_other_information",
"value": "false",
"read-only": "false"
},
{
"name": "receive_notification_when_someone_follows_me_or_my_organisation",
"value": "false",
"read-only": "false"
},
{
"name": "recieve_notification_when_someone_shares_my_events",
"value": "false",
"read-only": "false"
},
{
"name": "receive_notification_on_review_related_activities",
"value": "false",
"read-only": "false"
}
],
"organisations": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"parent": "",
"owner": "true",
"status": "",
"name": "Web Mascot",
"display_name": "webalive",
"info": "",
"slug": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"email": "masumul@bitmascot.com",
"phone": "",
"timezone": "",
"currency": "",
"payment_method": "Securepay"
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
],
"created_on": "",
"updated_on": "",
"addresses": [
{
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"privacy_settings": [
{
"name": "lock_my_organisation_profile",
"value": "false"
},
{
"name": "hide_address_on_my_organisation_profile",
"value": "true"
},
{
"name": "hide_reviews_on_my_organisation_profile",
"value": "false"
},
{
"name": "hide_review_interactions_from_public",
"value": "false"
},
{
"name": "allow_people_to_contact_my_organisation",
"value": "false"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "false"
}
],
"subscriptions": [
{
"type": "core",
"package": "basic",
"starts_on": "",
"renews_on": "",
"expires_on": "",
"order_id": "",
"is_current": ""
},
{
"type": "add-on",
"package": "campaign",
"starts_on": "",
"renews_on": "",
"expires_on": "",
"order_id": "",
"is_current": ""
}
],
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"activities": [
{
"name": "events_hosted",
"value": "304",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "revenue_earned",
"value": "50000",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "orders_received",
"value": "302",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "pages_viewed",
"value": "4,670",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "tickets_sold",
"value": "302",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
}
]
}
]
}
]
}3. POST /me/passwd
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
current_password * | String | should match with existing password | incorrect password |
new_password * | String |
| if password is not 8 characters → password should be at least 8 characters long if password is 8 characters but doesn’t contain constrains 2-5→ password should contain at least one special character, one lowercase letter, one uppercase letter and one numeric character |
confirm_password * | String | should match with new_password | confirm password does not match |
{
"current_password": "Yarra@123*",
"new_password": "Richie123*",
"confirm_password": "Richie123*"
}Response
No data
4. POST /me/receive_verification_email
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
No data
5. GET /me/mutes
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
Parameter | Type | Allowed value | Note |
|---|---|---|---|
position | number |
|
|
rows | number | 20 to 100 |
|
order_by |
|
|
|
Request
No data
Response
{
"mutes": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": "",
"muted_by": "6a3a2eec-bfa2-4975-be73-2fb7ff9850cd",
"muted": [
{
"name": "entity_type",
"value": "user"
},
{
"name": "uuid",
"value": ""
},
{
"name": "first_name",
"value": ""
},
{
"name": "last_name",
"value": ""
},
{
"name": "display_name",
"value": ""
},
{
"name": "image",
"value": ""
},
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
]
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": "",
"muted_by": "3f3a2eec-bfa2-4975-be73-2fb7ff9850dd",
"muted": [
{
"name": "entity_type",
"value": "org"
},
{
"name": "uuid",
"value": ""
},
{
"name": "name",
"value": ""
},
{
"name": "slug",
"value": ""
},
{
"name": "image",
"value": ""
}
]
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}6. POST /me/mute
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
uuid | String | Valid user uuid | invalid user uuid |
{
"uuid": ""
}Response
No data7. POST /me/unmute
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
uuid | String | Valid user uuid | invalid user uuid |
{
"uuid": ""
}Response
No data13. POST /me/change_email
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
new_email * | String | Valid new email address |
|
{
"new_email": "something@yopmail.com"
}{
"statusCode": 201,
"result": {
"message": "A verification code has been sent to your email. Please verify your email address with OTP"
}
}14. POST /me/change_phone
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
new_phone * | String | Valid new phone number |
|
{
"new_phone": "614598736"
}Response
{
"statusCode": 201,
"result": {
"message": "A verification code has been sent to your phone number. Please verify with the OTP"
}
}POST /me/verify_otp
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
otp * | String | Valid OTP |
|
new_email * (for email) | String | Valid new email address |
|
new_phone * (for phone) | String | Valid phone number |
|
For verifying email,
{
"otp": "xe739u",
"new_email": "something@yopmail.com"
}For verifying phone,
{
"otp": "xe739u",
"new_phone": "6148624832"
}Response
For verifying email,
{
"statusCode": 201,
"result": {
"message": "your new email address is verified"
}
}For verifying phone,
{
"statusCode": 201,
"result": {
"message": "your new phone number is verified"
}
}Users
End Point | Methods | Scope | Purpose | |
|---|---|---|---|---|
| 1 | /users/{uuid} | GET | user.read_information | Retrieves user’s public information // privacy test required lock_my_user_profile
allow_people_to_see_my_followings
allow_people_to_follow_me
Public Show interactions upon validation if client is authenticated as the user who is subject of the interaction Show role upon validation if client is authenticated as owner (or a member of owner team) of the org |
| 2 | /users/{uuid}/contact | POST | user.contact | Sends email to user // privacy test required lock_my_user_profile
allow_people_to_contact_me
// quota test required Note that “related” users are treated differently than “not related” Public |
| 3 | /users/{uuid}/invite_to_book | POST | user.invite_to_book | Sends event invitation to user // privacy test required lock_my_user_profile
allow_people_to_find_and_invite_me_to_relevant_events
// quota test required Validate if client is authenticated as owner (or a member of owner team) of the org |
| 4 | /users/{uuid}/follows | POST | user.follow | Follows user // privacy test required lock_my_user_profile
allow_people_to_follow_me
// quota test required Public |
| 5 | /users/{uuid}/unfollow | POST | user.unfollow | Unfollows user if not following
// quota test required Public |
| 6 | /users/{uuid}/follows | GET | user.read_follows | Retrieves list of entities who the user follows // privacy test required lock_my_user_profile
allow_people_to_see_my_followings
Public |
| 7 | /users/{uuid}/followed_by | GET | user.read_followed_by | Retrieves list of entities who follow the user // privacy test required lock_my_user_profile
allow_people_to_see_my_followings
Public |
| 8 | /users/{uuid}/attending | GET | user.list_event_attending | Retrieves list of events the user will be attending as attendee // privacy test required // privacy test required for the org block lock_my_user_profile
allow_people_to_see_the_events_i_attend
Public |
| 9 | /users/{uuid}/speaking | GET | user.list_event_speaking | Retrieves list of events the user will be attending as speaker // privacy test required // privacy test required for the org block lock_my_user_profile
allow_people_to_see_the_events_i_attend_as_speaker
Public |
| 10 | /users/{uuid}/shares | GET | user.list_share | Retrieves list of events that the user shared // privacy test required lock_my_user_profile
allow_people_to_see_the_events_i_share
Public |
| 11 | /users/{uuid} | DELETE | user.delete | Delete user account for GDPR compliance Special permission and condition required |
Response
{
"users": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "locked",
"value": ""
}
],
"first_name": "John",
"last_name": "Doe",
"display_name": "Johnny",
"bio": "No bio to write",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"timezone": "",
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
],
"organisations": [
{
"uuid": "1d3a2eec-bfa2-4975-be73-2fb7ff9850ff",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "locked",
"value": ""
},
{
"name": "verified",
"value": ""
},
{
"name": "transaction_on_hold",
"value": ""
}
],
"name": "Web Mascot",
"display_name": "",
"info": "",
"slug": "webalive",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"role": {
"owner": true,
"active": true,
"pending": false,
"last_accessed_on": ""
}
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "locked",
"value": ""
},
{
"name": "verified",
"value": ""
},
{
"name": "transaction_on_hold",
"value": ""
}
],
"name": "Bit Mascot",
"display_name": "",
"info": "",
"slug": "bitmascot",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"role": {
"owner": "false",
"active": "true",
"last_accessed_on": ""
}
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_me",
"value": "true"
},
{
"name": "allow_people_to_follow_me",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
1. GET /users/{uuid}
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Response
{
"users": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "locked",
"value": ""
}
],
"first_name": "John",
"last_name": "Doe",
"display_name": "Johnny",
"bio": "No bio to write",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"timezone": "",
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
],
"organisations": [
{
"uuid": "1d3a2eec-bfa2-4975-be73-2fb7ff9850ff",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "locked",
"value": ""
},
{
"name": "verified",
"value": ""
},
{
"name": "transaction_on_hold",
"value": ""
}
],
"name": "Web Mascot",
"display_name": "",
"info": "",
"slug": "webalive",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"role": {
"owner": true,
"active": true,
"pending": false,
"last_accessed_on": ""
}
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "locked",
"value": ""
},
{
"name": "verified",
"value": ""
},
{
"name": "transaction_on_hold",
"value": ""
}
],
"name": "Bit Mascot",
"display_name": "",
"info": "",
"slug": "bitmascot",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"role": {
"owner": "false",
"active": "true",
"last_accessed_on": ""
}
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_me",
"value": "true"
},
{
"name": "allow_people_to_follow_me",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}2. POST /users/{uuid}/contact
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
subject * | string | Maximum character = 2500 | subject should be less than or equal to 2500 characters |
message * | string | Maximum character =10000 | message should be less than or equal to 10000 characters |
{
"messages": [
{
"subject": "",
"message": ""
}
]
}Response
No data
3. POST /users/{uuid}/invite_to_book
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
event * | String | Valid event uuid | invalid event uuid |
source * | String | waiting_list, booking | invalid source |
event_start_on | Datetime (local) | yyyy-mm-dd | invalid datetime |
{
"event": ""
"event_start_on": "2022-11-28 10:00"
"source": "waiting_list"
}Response
{
"invitations": [
{
"uuid": "",
"status": "",
"type": "invitation_to_book",
"attributes": [
{
"name": "email",
"value": "ashiq@webalive.com.au"
},
{
"name": "first_name",
"value": "Ashiq"
},
{
"name": "last_name",
"value": "Rahman"
}
]
}
]
}
4. POST /users/{uuid}/follow
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
Request Parameters
Response
No data
5. POST /users/{uuid}/unfollow
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Response
No data
6. GET /users/{uuid}/follows
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
|
Parameter |
Type |
Allowed value |
Note |
|---|---|---|---|
|
position |
number |
||
|
rows |
number |
20 to 100 |
|
|
order_by |
Request
No data
Response
{
"follows": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": "",
"entity": [
{
"name": "entity_type",
"value": "user"
},
{
"name": "uuid",
"value": ""
},
{
"name": "first_name",
"value": ""
},
{
"name": "last_name",
"value": ""
},
{
"name": "display_name",
"value": ""
},
{
"name": "image",
"value": ""
},
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
],
"interactions": {
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": "",
"entity": [
{
"name": "entity_type",
"value": "org"
},
{
"name": "uuid",
"value": ""
},
{
"name": "name",
"value": ""
},
{
"name": "slug",
"value": ""
},
{
"name": "image",
"value": ""
},
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
],
"interactions": {
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}7. GET /users/{uuid}/followed_by
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
|
Parameter |
Type |
Allowed value |
Note |
|---|---|---|---|
|
position |
number |
||
|
rows |
number |
20 to 100 |
|
|
order_by |
Request
No data
Response
{
"followed_by": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": "",
"entity": [
{
"name": "entity_type",
"value": "user"
},
{
"name": "uuid",
"value": ""
},
{
"name": "first_name",
"value": ""
},
{
"name": "last_name",
"value": ""
},
{
"name": "display_name",
"value": ""
},
{
"name": "image",
"value": ""
},
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
],
"interactions": {
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": "",
"entity": [
{
"name": "entity_type",
"value": "org"
},
{
"name": "uuid",
"value": ""
},
{
"name": "name",
"value": ""
},
{
"name": "slug",
"value": ""
},
{
"name": "image",
"value": ""
},
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
],
"interactions": {
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}10. DELETE /users/{uuid}
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Response
No data
Common
End Point | Methods | Scope | Purpose | |
|---|---|---|---|---|
| 1 | /common/address | GET |
| Generates all the common address of country, state, city and its postcodes |
| 2 | /common/categories | GET |
| Gets list of category information used for event creation/update |
| 3 | /common/tags | GET |
| Generates all the tags and their information |
| 4 | /common/banners | GET |
| Gets all event banner information |
| 5 | /common/files | POST |
| Uploads a file |
| 6 | /common/files | DELETE |
| Deletes a file |
1. GET /common/address
Generates all the common address of country, state and city
|
Path |
|
|
Request Header |
application/json |
|
Query String |
country, state, city |
|
Success |
200 |
|
Special Error |
Scope
empty
Request
Parameter | Type | Allowed Value | NOTE |
country | string | Any valid country name | To get list of state: Example: v1/common/address?country=Australia |
state | string | Any valid state name | To get list of city:
|
city | string | Any valid city name | To get list of postcode:
|
Response
{
"success": true,
"statusCode": 200,
"result": {
"address": {
"location_country": "Australia",
"location_state": "Victoria",
"location_city": "Melbourne",
"location_postcode": "3000",
"countries": {
"Aaland Islands": "Aaland Islands",
"Afghanistan": "Afghanistan",
"Albania": "Albania",
"Algeria": "Algeria",
"United Arab Emirates": "United Arab Emirates",
"United Kingdom": "United Kingdom",
"United States": "United States",
"Yemen": "Yemen",
"Zambia": "Zambia",
"Zimbabwe": "Zimbabwe"
},
"states": {
"Australian Capital Territory": "Australian Capital Territory",
"New South Wales": "New South Wales",
"": "None",
"Northern Territory": "Northern Territory",
"Queensland": "Queensland",
"South Australia": "South Australia",
"Tasmania": "Tasmania",
"Victoria": "Victoria",
"Western Australia": "Western Australia"
},
"cities": {
"Abbeyard": "Abbeyard",
"Yuulong": "Yuulong",
"Zeerust": "Zeerust",
"Zumsteins": "Zumsteins"
},
"postcodes": {
"3000": "3000",
"3001": "3001",
"3004": "3004",
"": "None"
}
}
}
}
{
"success": true,
"statusCode": 200,
"result": {
"postcode": [
{
"postcode": "36720"
}
]
}
}
2. GET /common/categories
Path |
|
Request Header | application/json |
Query String | None |
Success | 200 |
Special Error |
|
Scope
empty
Request
No data
Response
{
"success": true,
"statusCode": 200,
"result": {
"categories": [
{
"title": "Music and Theater",
"slug": "music-and-theater",
"id": "11f5980b-1da3-4050-acef-762360d423ec"
},
{
"title": "Health and Wellbeing",
"slug": "health-and-well-being",
"id": "4748087d-1d9e-43c5-ae4d-48f5aebf5445"
}
]
}
}
4. GET /common/banners
Gets all event banner information
|
Path |
|
|
Request Header |
application/json |
|
Query String |
None |
|
Success |
200 |
|
Special Error |
Scope
keep it empty
Request
No data
Response
{
"success": true,
"statusCode": 200,
"result": {
"banners": [
{
"id": "1d8e69cc-4d92-4c11-9386-cba2b55c848a",
"user_id": "1d1143ff-988c-491f-b9c6-b6220de1d733",
"f_path": "51a472c08e21aef54ed749806e3e6490/myprofile/ec968cd3-f674-4f2b-9853-31189e081719.jpg"
},
{
"id": "259138c3-5738-4af8-ae0b-a165f961918a",
"user_id": "1d1143ff-988c-491f-b9c6-b6220de1d733",
"f_path": "6548722df992e788e87622db2c99c570/session/d8baca60-8330-4e6c-b2fa-062162451a61.jpg"
}
]
}
5. POST /common/files
Gets all event banner information
Path |
|
Request Header | application/json |
Query String | None |
Success | 200 |
Special Error |
|
Scope
empty
Request
Query param (for events entity)
Parameter | value |
|---|---|
org_uuid | string |
Form-data
Parameter | Type | Allowed value | Image |
|---|---|---|---|
| file |
| Failed to load
|
| string |
|
Response
{
"statusCode": 201,
"result": {
"file_name": "uploads/users/afedf6a97791e196439bab441ba1da95/myprofile/a84e8408-1b31-4bd1-9f44-ff8c5e28da46.jpg"
}
}
Orgs
End point | Method | Scope | Purpose | |
|---|---|---|---|---|
| 1 | /orgs/{uuid} | GET | org.read_information | Retrieves org’s public information // privacy test required lock_my_urganisation_profile
hide_address_on_my_organisation_profile
allow_people_to_follow_my_organisation
hide_reviews_on_my_organisation_profile
Do not send privacy_settings, subscriptions and activities Public Show interactions upon validation if client is authenticated as the user who is subject of the interaction |
| 2 | /orgs | POST | org.create | Creates a new organisation with supplied uuid Validate if client is authenticated as owner (or a member of owner team) of the org |
| 3 | /orgs/{uuid} | PATCH | org.update_information | Updates org information Validate if client is authenticated as owner (or a member of owner team) of the org |
| 4 | /orgs/{uuid}/contact | POST | org.contact | Sends email to org // privacy test required lock_my_organisation_profile
allow_people_to_contact_my_organisation
// quota test required Note that “related” users are treated differently than “not related” Public |
| 5 | /orgs/{uuid}/follow | POST | org.follow | Follows org // privacy test reqired lock_my_organisation_profile
allow_people_to_follow_my_organisation
// quota test required Public |
| 6 | /orgs/{uuid}/unfollow | POST | org.unfollow | Unfollows org if not following
// quota test required Public |
| 7 | /orgs/{uuid}/follows | GET | org.read_follows | Retrieves list of entities who the org follows // privacy test reqired lock_my_organisation_profile
// quota test required Public |
| 8 | /orgs/{uuid}/followed_by | GET | org.read_followed_by | Retrieves list of entities who follow the org // privacy test reqired lock_my_organisation_profile
Public |
| 9 | /orgs/{uuid}/privacy_settings | GET | org.read_privacy_settings | Retrieves org’s privacy settings Validate if client is authenticated as owner (or a member of owner team) of the org |
| 10 | /orgs/{uuid}/privacy_settings | PATCH | org.update_privacy_settings | Updates org’s privacy settings Validate if client is authenticated as owner (or a member of owner team) of the org |
| 11 | /orgs/{uuid}/billing_information | GET | org.read_billing_information | Retrieves org’s billing information Validate if client is authenticated as owner of the org |
| 12 | /orgs/{uuid}/billing_information | PUT | org.update_billing_information | Updates org’s billing information Validate if client is authenticated as owner of the org |
| 13 | /orgs/{uuid}/payout_information | GET | org.read_payout_information | Retrieves org’s payout information Validate if client is authenticated as owner (or a member of owner team) of the org |
| 14 | /orgs/{uuid}/payout_information | PUT | org.update_payout_information | Updates org’s payout information Validate if client is authenticated as owner (or a member of owner team) of the org |
| 15 | /orgs/{uuid}/metrics | GET | org.read_metrics | Retrieves org’s metrics Validate if client is authenticated as owner (or a member of owner team) of the org |
| 16 | /orgs/{uuid}/activities | GET | org.read_activities | Retrieves org’s activities Validate if client is authenticated as owner (or a member of owner team) of the org |
| 17 | /orgs/{uuid}/events /orgs/{uuid}/events/{uuid} | GET | org.list_event | Retrieves org’s events // publishing and listing test required // privacy test required for the org block Show interactions upon validation if client is authenticated as the user who is subject of the interaction |
| 18 | /orgs/{uuid}/reviews | GET | org.list_review | Retrieves org’s reviews // privacy test required Public |
| 19 | /orgs/{uuid}/stripe | GET | org.read_stripe | Retrieves org’s stripe connect information Validate if client is authenticated as owner (or a member of owner team) of the org |
| 20 | /orgs/{uuid}/stripe_connect | POST | org.connect_stripe | Connects with org’s stripe account Validate if client is authenticated as owner (or a member of owner team) of the org |
| 21 | /orgs/{uuid}/stripe/disconnect | POST | org.disconnect_stripe | Disconnect with org’s stripe account Validate if client is authenticated as owner (or a member of owner team) of the org |
| 22 | /orgs/{uuid}/subscriptions | GET | org.read_subscription | Retrieves org’s subscriptions Validate if client is authenticated as owner of the org |
| 23 | /orgs/{uuid}/subscriptions | POST | org.add_subscription | Updates org’s subscription Validate if client is authenticated as owner of the org |
| 24 | /orgs/{uuid}/subscriptions/{uuid}/cancel | POST | org.cancel_subscription | Cancels org’s subscription Validate if client is authenticated as owner of the org |
| 25 | /orgs/{uuid}/subscriptions/{uuid}/reactivate | POST | org.reactivate_subscription | Reactivates org’s subscription Validate if client is authenticated as owner of the org |
| 26 | /orgs/{uuid}/team_members | GET | org.list_team_member | Retrieves list of org’s team members Validate if client is authenticated as owner of the org |
| 27 | /orgs/{uuid}/team_members/{uuid} | GET | org.read_team_member | Retrieves a specific team members from org Validate if client is authenticated as owner of the org |
| 28 | /orgs/{uuid}/team_members/{uuid}/disable | POST | org.disable_team_member | Disables a specific team members from org Validate if client is authenticated as owner of the org |
| 29 | /orgs/{uuid}/team_members/{uuid}/enable | POST | org.enable_team_member | Enables a specific team members from org Validate if client is authenticated as owner of the org |
| 30 | /orgs/{uuid}/team_members/{uuid} | DELETE | org.remove_team_member | Deletes a specific team members from org Validate if client is authenticated as owner of the org |
| 31 | /orgs/{uuid}/invitations | GET | org.list_invitation | Retrieves list of org’s team member invitations Validate if client is authenticated as owner of the org |
| 32 | /orgs/{uuid}/invitate_to_join
| POST | org.send_invitation_to_join | Sends invitation to an email address to join team Validate if client is authenticated as owner of the org |
| 33 | /orgs/{uuid}/invitations/{uuid}
| GET | org.read_invitation | Retrieves list of org’s team member invitations Validate if client is authenticated as owner of the org |
| 34 | /orgs/{uuid}/invitations/{uuid}/accept_invite | POST | org.accept_invitation | Accepts team member invitation from an org Validates if the client is authenticated as user as part of authorization |
| 35 | /orgs/{uuid}/invitations/{uuid} | DELETE | org.delete_invitation | Deletes as specific team member invitation Validate if client is authenticated as owner of the org |
| 36 | /orgs/{uuid}/invitations/{uuid}/resend_invite
| POST | org.resend_invitation_to_join | Resends invitation to an email address to join team Validate if client is authenticated as owner of the org |
| 37 | /orgs/{uuid}/payout_information | DELETE | org.delete_payout_information | Deletes org’s payout information Validate if client is authenticated as owner (or a member of owner team) of the org |
| 38 | /orgs/{uuid}/payout_information | POST | org.create_payout_information | Creates an org’s payout information Validate if client is authenticated as owner (or a member of owner team) of the org |
| 39 | /orgs/{uuid}/products | GET |
| Retrieves a list of products of an organisation |
| 40 | /orgs/{uuid}/products | POST |
| Add product in an organisation |
| 41 | /orgs/{uuid}/products/{uuid} | PATCH |
| Updates a product in an organisation |
| 42 | /orgs/{uuid}/products/{uuid} | DELETE |
| Deletes a product in an organisation |
| 43 | /orgs/{uuid}/events | POST | event.create | Adds a new event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 44 | /orgs/{uuid}/events/{uuid} | PATCH | event.update | Updates an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 45 | /orgs/{uuid}/tags | GET |
| Generates all the tags and their information |
1. GET /orgs/{uuid}
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
{
"orgs": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "locked",
"value": ""
},
{
"name": "verified",
"value": ""
},
{
"name": "transaction_on_hold",
"value": ""
}
],
"name": "Web Mascot",
"display_name": "webalive",
"info": "",
"slug": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"email": "masumul@bitmascot.com",
"phone": "",
"addresses": [
{
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"timezone": "",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"value": "https://john.doe/li"
}
],
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_my_organisation",
"value": "true"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
}
]
}
2. POST /orgs/{uuid}
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
name * | String |
|
|
info | String | Maximum character = 2500 | info should be less than or equal to 2500 characters |
image | File |
.jpg, .jpeg, .png |
|
String | Valid email address | email address is invalid | |
phone | String | Valid phone number | phone number is invalid |
address > timezone | Timezone | Valid timezone | timezone is invalid |
address > address_line1 | String | Maximum character = 75 | address_line1 should be less than or equal to 75 characters |
address > address_line2 | String | Maximum character = 75 | address_line2 should be less than or equal to 75 characters |
address > country | String | Valid country | country is invalid |
address > state | String | Valid state | state is invalid |
address > city | String | Valid city | city is invalid |
address > post_code | String | Valid postcode | zip/post code invalid |
links > website | String | Must be a valid link | website link is invalid |
links > facebook | String | Must have a valid facebook link format | facebook link is invalid |
links > twitter | String | Must have a valid twitter link format | twitter link is invalid |
links > linkedin | String | Must have a valid linkedin link format | linkedin link is invalid |
links > instagram | String | Must have a valid instagram link format | instagram link is invalid |
{
"orgs": {
"name": "Web Mascot",
"info": "",
"image": "uploads/orgs/afedf6a97791e196439bab441ba1da95/organizers/c4899bae-5b58-42ce-ae96-f019ca3a5a17.jpg",
"email": "eb@bitmascot.com",
"phone": "051518516156",
"addresses": [
{
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141",
"timezone": "Australia/Melbourne"
}
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://instagram.com/foe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"value": "https://linkedin.com/li/"
}
]
}
}
Response
{
"orgs": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "locked",
"value": ""
},
{
"name": "verified",
"value": ""
},
{
"name": "transaction_on_hold",
"value": ""
}
],
"name": "Web Mascot",
"display_name": "webalive",
"info": "",
"slug": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"email": "masumul@bitmascot.com",
"phone": "",
"addresses": [
{
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"timezone": "",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"value": "https://john.doe/li"
}
],
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_my_organisation",
"value": "true"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
}
]
}
3. PATCH /orgs/{uuid}
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
|
Parameter |
Type |
Constrains |
Validation Message |
|---|---|---|---|
|
name * |
String |
|
|
|
info |
String |
Maximum character = 2500 |
info should be less than or equal to 2500 characters |
|
image |
File |
.jpg, .jpeg, .png |
|
|
|
String |
Valid email address |
email address is invalid |
|
phone |
String |
Valid phone number |
phone number is invalid |
|
address > timezone |
Timezone |
Valid timezone |
timezone is invalid |
|
address > address_line1 |
String |
Maximum character = 75 |
address_line1 should be less than or equal to 75 characters |
|
address > address_line2 |
String |
Maximum character = 75 |
address_line2 should be less than or equal to 75 characters |
|
address > country |
String |
Valid country |
country is invalid |
|
address > state |
String |
Valid state |
state is invalid |
|
address > city |
String |
Valid city |
city is invalid |
|
address > post_code |
String |
Valid postcode |
zip/post code invalid |
|
links > website |
String |
Must be a valid link |
website link is invalid |
|
links > facebook |
String |
Must have a valid facebook link format |
facebook link is invalid |
|
links > twitter |
String |
Must have a valid twitter link format |
twitter link is invalid |
|
links > linkedin |
String |
Must have a valid linkedin link format |
linkedin link is invalid |
|
links > instagram |
String |
Must have a valid instagram link format |
instagram link is invalid |
{
"orgs": {
"name": "Web Mascot",
"info": "",
"image": "uploads/orgs/afedf6a97791e196439bab441ba1da95/organizers/c4899bae-5b58-42ce-ae96-f019ca3a5a17.jpg",
"email": "eb@bitmascot.com",
"phone": "051518516156",
"addresses": [
{
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141",
"timezone": "Australia/Melbourne"
}
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://instagram.com/foe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"value": "https://linkedin.com/li/"
}
]
}
}
Response
{
"orgs": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "",
"extended_status": [
{
"name": "muted",
"value": ""
},
{
"name": "locked",
"value": ""
},
{
"name": "verified",
"value": ""
},
{
"name": "transaction_on_hold",
"value": ""
}
],
"name": "Web Mascot",
"display_name": "webalive",
"info": "",
"slug": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"email": "masumul@bitmascot.com",
"phone": "",
"addresses": [
{
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"timezone": "",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": ""
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": ""
},
{
"name": "linkedin",
"value": "https://john.doe/li"
}
],
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_my_organisation",
"value": "true"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
}
]
}
4. POST /orgs/{uuid}/contact
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
subject * | String | Maximum character = 2500 | subject should be less than or equal to 2500 characters |
message * | String | Maximum character =10000 | message should be less than or equal to 10000 characters |
{
"messages": [
{
"subject": "",
"message": ""
}
]
}Response
No data
5. POST /orgs/{uuid}/follow
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
No data
6. POST /orgs/{uuid}/unfollow
Path |
|
Request Header | application/json |
Success | 200 |
Special Error |
|
Query String
None
Request
No data
7. GET /orgs/{uuid}/follows
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
Parameter | Type | Allowed value | Note |
|---|---|---|---|
position | number |
|
|
rows | number | 20 to 100 |
|
order_by |
|
|
|
Request
No data
Response
{
"follows": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": "",
"entity": [
{
"name": "entity_type",
"value": "user"
},
{
"name": "uuid",
"value": ""
},
{
"name": "first_name",
"value": ""
},
{
"name": "last_name",
"value": ""
},
{
"name": "display_name",
"value": ""
},
{
"name": "image",
"value": ""
},
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
],
"interactions": {
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
}
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": "",
"entity": [
{
"name": "entity_type",
"value": "org"
},
{
"name": "uuid",
"value": ""
},
{
"name": "name",
"value": ""
},
{
"name": "slug",
"value": ""
},
{
"name": "image",
"value": ""
},
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
],
"interactions": {
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
}
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
8. GET /orgs/{uuid}/followed_by
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
Parameter | Type | Allowed value | Note |
|---|---|---|---|
position | number |
|
|
rows | number | 20 to 100 |
|
order_by |
|
|
|
Request
No data
Response
{
"followed_by": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": "",
"entity": [
{
"name": "entity_type",
"value": "user"
},
{
"name": "uuid",
"value": ""
},
{
"name": "first_name",
"value": ""
},
{
"name": "last_name",
"value": ""
},
{
"name": "display_name",
"value": ""
},
{
"name": "image",
"value": ""
},
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
]
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": "",
"entity": [
{
"name": "entity_type",
"value": "org"
},
{
"name": "uuid",
"value": ""
},
{
"name": "name",
"value": ""
},
{
"name": "slug",
"value": ""
},
{
"name": "image",
"value": ""
},
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
}
]
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
9. GET /orgs/{uuid}/privacy_settings
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
{
"privacy_settings": [
{
"name": "lock_my_organisation_profile",
"value": "false"
},
{
"name": "hide_address_on_my_organisation_profile",
"value": "true"
},
{
"name": "hide_reviews_on_my_organisation_profile",
"value": "false"
},
{
"name": "hide_review_interactions_from_public",
"value": "false"
},
{
"name": "allow_people_to_contact_my_organisation",
"value": "false"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "false"
}
]
}
10. PATCH /orgs/{uuid}/privacy_settings
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
privacy_settings > name * | String | Accepts a value from a set of pre-defined objects (stated in the payload) | invalid privacy settings name
|
privacy_settings > value * | Boolean | Accepts only true /false value | invalid privacy settings value |
{
"privacy_settings": [
{
"name": "lock_my_organisation_profile",
"value": "false"
},
{
"name": "hide_address_on_my_organisation_profile",
"value": "true"
},
{
"name": "hide_reviews_on_my_organisation_profile",
"value": "false"
},
{
"name": "hide_review_interactions_from_public",
"value": "false"
},
{
"name": "allow_people_to_contact_my_organisation",
"value": "false"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "false"
}
]
}Response
{
"privacy_settings": [
{
"name": "lock_my_organisation_profile",
"value": "false"
},
{
"name": "hide_address_on_my_organisation_profile",
"value": "true"
},
{
"name": "hide_reviews_on_my_organisation_profile",
"value": "false"
},
{
"name": "hide_review_interactions_from_public",
"value": "false"
},
{
"name": "allow_people_to_contact_my_organisation",
"value": "false"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "false"
}
]
}
11. GET /orgs/{uuid}/billing_information
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
{
"orgs": [
{
"billing_information": {
"first_name": "Masumul",
"last_name": "Hassan",
"email": "masumul@bitmascot.com",
"phone": "",
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
]
}
12. PUT /orgs/{uuid}/billing_information
|
Path |
|
|
Request Header |
application/json |
|
Success |
200 |
|
Special Error |
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
first_name | String | N/A | N/A |
last_name | String | N/A | N/A |
country * | String | Valid country | country is invalid |
state * | String | Valid state | state is invalid |
city * | String | Valid city | city is invalid |
postcode * | String | Valid postcode | zip/post code invalid |
address_line1 * | String | Maximum character = 75 | address_line1 should be less than or equal to 75 characters |
address_line2 | String | Maximum character = 75 | address_line1 should be less than or equal to 75 characters |
{
"orgs": [
{
"billing_information": {
"first_name": "Masumul",
"last_name": "Hassan",
"email": "masumul@bitmascot.com",
"phone": "",
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
]
}
Response
{
"orgs": [
{
"billing_information": {
"first_name": "Masumul",
"last_name": "Hassan",
"email": "masumul@bitmascot.com",
"phone": "",
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
]
}
13. GET /orgs/{uuid}/payout_information
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
No data
Response
{
"orgs": [
{
"payout_information": {
"account_name": "",
"account_number": "",
"bank_name": "",
"bsb_code": "",
"swift_or_bic_code": "",
"aba_routing": "",
"iban": ""
}
}
]
}
14. PUT /orgs/{uuid}/payout_information
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
account_name * | String | Maximum character = 200 | account_name should be less than or equal to 200 characters |
account_number * | String | Maximum character = 200 | account_number should be less than or equal to 200 characters |
bank_name * | String | Maximum character = 200 | bank_name should be less than or equal to 200 characters |
bsb_code * | String |
|
|
swift_or_bic_code | String | Maximum character = 200 | swift_or_bic_code should be less than or equal to 200 characters |
aba_routing | String | Maximum character = 200 | aba_routing should be less than or equal to 200 characters |
iban | String | Maximum character = 200 | iban should be less than or equal to 200 characters |
{
"orgs": [
{
"payout_information": {
"account_name": "",
"account_number": "",
"bank_name": "",
"bsb_code": "",
"swift_or_bic_code": "",
"aba_routing": "",
"iban": ""
}
}
]
}
Response
{
"orgs": [
{
"payout_information": {
"account_name": "",
"account_number": "",
"bank_name": "",
"bsb_code": "",
"swift_or_bic_code": "",
"aba_routing": "",
"iban": ""
}
}
]
}
15. GET /orgs/{uuid}/metrics
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
{
"orgs": [
{
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
]
}
]
}
16. GET /orgs/{uuid}/activities
Path |
|
Request Header | application/json |
Success | 200 |
Special Error |
|
Query String
Parameter | Type | Allowed value | Note |
|---|---|---|---|
events | list | list of uuids | Leaving null means the last 5 published events |
start_date | date | Special condition applies | Leaving null means all time |
end_date | date | Special condition applies | Leaving null means all time |
interval | enum | daily, weekly, monthly | Sends arrays of data if an interval is set along with the cumulative. See dashboard requirement |
group_by_event | bool | true, false | Combine or not combine data by multiple events |
Request
No data
Response
{
"orgs": [
{
"activities": [
{
"name": "events_hosted",
"value": "304",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "revenue_earned",
"value": "50000",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "orders_received",
"value": "302",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "pages_viewed",
"value": "4,670",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
},
{
"name": "tickets_sold",
"value": "302",
"meta": {
"start_date": "",
"end_date": "",
"events": [
{
"uuid": "",
"name": ""
},
{
"uuid": "",
"name": ""
}
]
}
}
]
}
]
}
19. GET /orgs/{uuid}/stripe
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
{
"uuid": "6906611f-9ff9-4fec-8a19-5879bb54d215",
"organisation_name": "API9630",
"default_payment_method": "stripe",
"stripe_connect_id": "acct_1KhZSN2EsxkzuaPJ",
"stripe_connect_email": "nahidahena888@gmail.com",
"stripe_setting_complete": true,
"stripe_charges_enabled": true,
"stripe_account_link": ""
}
20. POST /orgs/{uuid}/stripe_connect
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
No data
Response
{
"connect_url": "https://connect.stripe.com/oauth/authorize?response_type=code&client_id=ca_AfCqpjCWNLZaiWBSJzRDmw3yPgJxwCz3&state=YToyOntzOjU6InRva2VuIjtzOjI1NjoiYVVObGRtZDBZVFpRVVhaYU9TdE9jRWhSYkdOMVl6VlhOV05ZYWxGdFdXMVdPVTFqYm14TloycHJPRkV5WjFsRFVFVnhkemhKYlU1RmNtOW1TelZhWW1jeWEzaGlVWEp1TTFCTWJWSXhZa014Ym14MlFXeFhMMU5MWVhObGJDczNValZLWTFsWVZGUllVbXN2VDBNM1UyTlBjV3R0UzJWemVUaHdZVFJ4TTJoNmNuSm1SV0pHZEhwclEyWnBlbHBoU1RCclJsaG9RMG8xVEZaTkx6WllSMll2YVhaNFN5dHpTM1p5ZFRWM2MwbHJZbTF1TURkbFlWRlpZMFJGYW14NSI7czo1OiJzY29wZSI7czoxMDoicmVhZF93cml0ZSI7fQ==&scope=read_write&redirect_uri=https%3A%2F%2Fwww.diywebsite.net.au%2Fb%2Fwebhook%2Fstripe-integration%2Fconnect-account"
}
Note: After creating stripe account by the connect URL, Stripe account details could be found by this endpoint “GET /orgs/{uuid}/stripe”
21. POST /orgs/{uuid}/stripe_disconnect
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query Strings
No data
Request
No data
Response
No data
22. GET /orgs/{uuid}/subscriptions
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
Parameter | Type | Allowed value | Note |
|---|---|---|---|
is_current | boolean | true, false |
|
type | enum | subscription, add-on |
|
Request
No data
Response
{
"subscriptions": [
{
"type": "core",
"package": "basic",
"starts_on": "",
"renews_on": "",
"expires_on": "",
"order_id": "",
"is_current": ""
},
{
"type": "add-on",
"package": "campaign",
"starts_on": "",
"renews_on": "",
"expires_on": "",
"order_id": "",
"is_current": ""
}
]
}
23. POST /orgs/{uuid}/subscriptions
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
TBA
Request
TBA
Response
TBA
24. POST /orgs/{uuid}/subscriptions/{uuid}/cancel
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
No data
25. POST /orgs/{uuid}/subscriptions/{uuid}/reactivate
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
No data
26. GET /orgs/{uuid}/team_members
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Parameter | Type | Allowed value | Note |
|---|---|---|---|
search_q |
|
|
|
feature |
|
|
|
action |
|
|
|
Response
{
"users": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "",
"attributes": [
{
"name": "email",
"value": "ashiq@webalive.com.au"
},
{
"name": "first_name",
"value": "Ashiq"
},
{
"name": "last_name",
"value": "Rahman"
}
],
"access": [
{
"role": "",
"extentded_access": {
"type": "deny_all",
"exclusions": [
{
"feature": "order",
"action": "view"
}
]
}
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
]
}
28. POST /orgs/{uuid}/team_members/{uuid}/disable
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
No data
Response
No data
29. POST /orgs/{uuid}/team_members/{uuid}/enable
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
No data
Response
No data
30. DELETE /orgs/{uuid}/team_members/{uuid}
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
No data
31. GET /orgs/{uuid}/invitations
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
Parameter | Type | Allowed value | Note |
|---|---|---|---|
status | enum | Active, Pending |
|
search_q |
|
|
|
position |
|
|
|
rows |
|
|
|
order_by |
|
|
|
Request
No data
Response
{
"invitations": [
{
"uuid": "",
"status": "",
"created_on": "",
"accepted_on": "",
"type": "invitation_to_join_team",
"access": [
{
"role": "",
"extentded_access": {
"type": "deny_all",
"exclusions": [
{
"org": "",
"feature": "order",
"action": "view"
}
]
}
}
],
"attributes": [
{
"name": "team_member_uuid",
"value": " "
},
{
"name": "email",
"value": "ashiq@webalive.com.au"
},
{
"name": "first_name",
"value": "Ashiq"
},
{
"name": "last_name",
"value": "Rahman"
}
]
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
32. POST /orgs/{uuid}/invite_to_join
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
email * | String | Valid email address | email address is invalid |
first_name * | String | Maximum character = 40 | first_name can not exceed 40 characters |
last_name * | String | Maximum character = 40 | last_name should be less than or equal to 40 characters |
{
"email": "checkweb21@yopmail.com",
"first_name": "Robert",
"last_name": "Hudson"
}Response
// Same as “GET /orgs/{uuid}/team_members/invitations/{uuid}”
33. GET /orgs/{uuid}/invitations/{uuid}
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
{
"invitations": [
{
"uuid": "",
"status": "",
"created_on": "",
"accepted_on": "",
"type": "invitation_to_join_team",
"access": [
{
"role": "",
"extentded_access": {
"type": "deny_all",
"exclusions": [
{
"org": "",
"feature": "order",
"action": "view"
}
]
}
}
],
"attributes": [
{
"name": "team_member_uuid",
"value": " "
},
{
"name": "email",
"value": "ashiq@webalive.com.au"
},
{
"name": "first_name",
"value": "Ashiq"
},
{
"name": "last_name",
"value": "Rahman"
}
]
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
34. POST /orgs/{uuid}/invitations/{uuid}/accept_invite
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
No data
35. DELETE /orgs/{uuid}/invitations/{uuid}
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
No data
36. POST /orgs/{uuid}/invitations/{uuid}/resend_invite
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
No data
37. DELETE /orgs/{uuid}/payout_information
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
No data
Response
No data
38. POST /orgs/{uuid}/payout_information
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Request Parameters
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
payout_information { } |
|
|
|
Response
{
"orgs": [
{
"payout_information": {
"account_name": "",
"account_number": "",
"bank_name": "",
"bsb_code": "",
"swift_or_bic_code": "",
"aba_routing": "",
"iban": ""
}
}
]
}
39. GET /orgs/{uuid}/products
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
{
"products": [
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "T-shirt",
"status": "active",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 5,
"min_qty_per_order": 1,
"event_uuid": [
"6d3a2eu43-bfa2-4975-be73-2fb7ff9456jd",
"6d3a2eu43-bfa2-4975-be73-2fb7ff93459f"
],
"created_on": "",
"updated_on": ""
},
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "Coffee",
"status": "active",
"price": 5.00,
"description": "",
"images": "photo_path",
"qty_available": 50,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"event_uuid": [
"6d3a2eu43-bfa2-4975-be73-2fb7ff9456jd",
"6d3a2eu43-bfa2-4975-be73-2fb7ff93459f"
],
"created_on": "",
"updated_on": ""
}
]
}
40. POST /orgs/{uuid}/products
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
name * | String | Max character limit = 75 | name for product should be less than or equal to 75 characters |
status | String | active/inactive |
|
price * | Float | Price>=0 and price<=10000 | If price >10000, price should be less than or equal to 10000 If Price<0, price should have a value greater than 0 |
description | String | Max character limit = 2500 | description for product should be less than or equal to 2500 characters |
images * | File | Valid file path | invalid image |
qty_available | Numerical |
|
|
max_qty_per_order | Numerical |
|
|
min_qty_per_order | Numerical |
|
|
event_uuid | Array | Valid uuid of event which are assigned for the products |
|
{
"product": {
"name": "Coffee",
"status": "active",
"price": 5.00,
"description": "",
"images": "photo_path",
"qty_available": 50,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"event_uuid": [
"6d3a2eu43-bfa2-4975-be73-2fb7ff9456jd",
"6d3a2eu43-bfa2-4975-be73-2fb7ff93459f"
]
}
}
Response
{
"products": [
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "T-shirt",
"status": "active",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 5,
"min_qty_per_order": 1,
"event_uuid": [
"6d3a2eu43-bfa2-4975-be73-2fb7ff9456jd",
"6d3a2eu43-bfa2-4975-be73-2fb7ff93459f"
],
"created_on": "",
"updated_on": ""
},
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "Coffee",
"status": "active",
"price": 5.00,
"description": "",
"images": "photo_path",
"qty_available": 50,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"event_uuid": [
"6d3a2eu43-bfa2-4975-be73-2fb7ff9456jd",
"6d3a2eu43-bfa2-4975-be73-2fb7ff93459f"
],
"created_on": "",
"updated_on": ""
}
]
}
41. PATCH /orgs/{uuid}/products/{uuid}
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
name * | String | Max character limit = 75 | name for product should be less than or equal to 75 characters |
status | String | active/inactive |
|
price * | Float | Price>=0 and price<=10000 | If price >10000, price should be less than or equal to 10000 If Price<0, price should have a value greater than 0 |
description | String | Max character limit = 2500 | description for product should be less than or equal to 2500 characters |
images * | File | Valid file path | invalid image |
qty_available | Numerical |
|
|
max_qty_per_order | Numerical |
|
|
min_qty_per_order | Numerical |
|
|
event_uuid | Array | Valid uuid of event which are assigned for the products |
|
{
"product": {
"name": "Coffee",
"status": "active",
"price": 5.00,
"description": "",
"images": "photo_path",
"qty_available": 50,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"event_uuid": [
"6d3a2eu43-bfa2-4975-be73-2fb7ff9456jd",
"6d3a2eu43-bfa2-4975-be73-2fb7ff93459f"
]
}
}
Response
{
"products": [
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "T-shirt",
"status": "active",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 5,
"min_qty_per_order": 1,
"event_uuid": [
"6d3a2eu43-bfa2-4975-be73-2fb7ff9456jd",
"6d3a2eu43-bfa2-4975-be73-2fb7ff93459f"
],
"created_on": "",
"updated_on": ""
},
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "Coffee",
"status": "active",
"price": 5.00,
"description": "",
"images": "photo_path",
"qty_available": 50,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"event_uuid": [
"6d3a2eu43-bfa2-4975-be73-2fb7ff9456jd",
"6d3a2eu43-bfa2-4975-be73-2fb7ff93459f"
],
"created_on": "",
"updated_on": ""
}
]
}
42. DELETE orgs/uuid/products/uuid
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
No data
Response
No data
43. POST /orgs/{uuid}/events
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
{
"event": {
"name": "Environment problem seminar",
"description": "This is a seminar of discussing about environmental problems with honorable members of society",
"occurrence": {
"type": "daily",
"attributes": {
"starts_on": "2022-11-30 10:00",
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"local": "2022-12-18"
},
"type": "number_of_event",
"value": 10
}
},
"exclusions": [
{
"local": "event_excluding_time"
},
{
"local": "event_excluding_time"
},
{
"local": "event_excluding_time"
}
],
"type": "weekly",
"attributes": {
"starts_on": "local_datetime",
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"local": "date"
},
"type": "number_of_event",
"value": 10
},
"days": [
"Sunday",
"Monday"
]
},
"type": "monthly",
"attributes": {
"starts_on": "2022-11-30 10:00",
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"local": "2022-12-15"
},
"type": "number_of_event",
"value": 10
},
"monthly_recurrence_type": "day_no",
"monthly_recurrence_type": "day_name"
},
"type": "schedule",
"attributes": [
{
"starts_on": "local_datetime",
"event_duration": 60
},
{
"starts_on": "local_datetime",
"event_duration": 60
}
]
},
"banner": [
{
"name": "xxx",
"image": "uploads/orgs/4fa3b56c5b2bacd5e65c877eb6067183/events/e71caf92-14d0-4ec1-9ba0-3ef49dd745e8.jpg",
"primary": "true"
}
],
"resources": [
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "video"
},
{
"name": "content",
"value": ""
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "image"
},
{
"name": "content",
"value": ""
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "text"
},
{
"name": "content",
"value": ""
}
]
],
"timezone": "Australia/Melbourne",
"enable_datetime_conversion": "false",
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "20.00",
"discount_type": "percentage",
"ends_on": "local datetime",
"uses_per_coupon": 0,
"uses_per_customer": 0,
"status": 0
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"local": "2022-11-18 10:00"
}
},
"merchandise": {
"products": [
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "T-shirt",
"code": "TS-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 5,
"min_qty_per_order": 1
},
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "Coffee",
"code": "C-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 10,
"min_qty_per_order": 3
}
]
},
"settings": {
"booking_starts_on": {
"immediately": "true",
"local": "datetime",
"hide_ticket_until_booking_start": "true",
"level": "ticket"
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"local": "datetime",
"level": "event"
},
"event_capacity": 0,
"terminology": "registration",
"enable_guest_checkout": "true",
"enable_share": "false",
"digital_pass": {
"enabled": "true",
"level": "ticket"
},
"discount": {
"enabled": "true",
"level": "event"
},
"coupon": {
"enabled": "true",
"level": "event"
},
"service_charge": {
"enabled": "true",
"level": "event"
},
"boxoffice": "",
"sell_session_individually": {
"enabled": "true",
"level": "event"
},
"sell_tickets_on_venue": {
"enabled": "true",
"level": "event"
},
"special_instruction": {
"enabled": "true",
"level": "ticket"
},
"waiting_list": {
"enabled": "true",
"level": "event"
},
"tracking_codes": [
{
"type": "code",
"value": "google_code"
},
{
"type": "code",
"value": "facebook_code"
}
],
"blockout_period": "1440",
"restrictions": [
{
"type": "age",
"enabled": "true",
"level": "event",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"level": "ticket",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"level": "event",
"condition": null
},
{
"type": "email",
"enabled": "true",
"level": "ticket",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
],
"configuration": {
"type": "venue_event",
"attributes": [
{
"name": "venue",
"value": {
"name": "130 State Route 50",
"image": "uploads\\orgs\\",
"url": "",
"latitude": 80,
"longitude": 80,
"address": {
"address_line1": "130 State Route 50",
"address_line2": "",
"country": "Australia",
"state": "Victoria",
"city": "Melbourne",
"post_code": 3004
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"category": "ticket",
"pricing_details": [
{
"variation": "",
"price": "30.0",
"quantity_included": "1"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"local": "datetime"
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"local": "datetime"
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "20.00",
"discount_type": "percentage",
"ends_on": "local datetime",
"uses_per_coupon": 0,
"uses_per_customer": 0,
"status": 0
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"ends_on": "local datetime",
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
},
"custom_attributes": [
{
"name": "disclaimer_text",
"value": "If you are at the event, keep your belongings safely in your own responsibility."
}
]
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket WITH Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 2,
"category": "ticket",
"pricing_details": [
{
"uuid": "pd3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "Gold",
"price": "$30.0",
"quantity_included": "5"
},
{
"uuid": "",
"variation": "Silver",
"price": "$50.0",
"quantity_included": "3"
}
],
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": "false",
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
}
},
{
"uuid": "",
"display_order": "natural",
"name": "This is a donation ticket",
"description": "",
"quantity": "50",
"category": "donation",
"pricing_details": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"quantity_included": "1"
},
"settings": {
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "false",
"enable_digital_pass": "false",
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
}
}
]
},
"listing": {
"enabled": "true",
"categories": [
{
"uuid": "",
"name": "Arts",
"description": "",
"url": "",
"image": ""
}
],
"tags": [
{
"uuid": "",
"name": "active_event",
"description": "",
"url": "",
"image": ""
}
]
},
"refund": {
"available": "true",
"policy": {
"cancel_before_event_starts": 30,
"automatic": "true",
"amount": {
"discount_type": "",
"discount_unit": 20
}
}
}
}
}
Response
GET /orgs/{uuid}/events/{uuid} 44. PATCH /orgs/{uuid}/events{uuid}
|
Path |
|
|
Request Header |
application/json |
|
Success |
|
|
Special Error |
Query String
None
Request
POST /orgs/{uuid}/eventsResponse
GET /orgs/{uuid}/events/{uuid} 45. GET /orgs/{uuid}/tags
Generates all the tags and their information available
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Scope
Keep it empty
Request
No data
Response
{
"statusCode": 200,
"result": {
"tags": [
{
"name": "happy",
"slug": "happy",
"id": "07facacf-9374-45eb-a4f5-1087aeaec037"
},
{
"name": "health",
"slug": "health",
"id": "5be2e05e-5152-425b-932f-0899a39d687e"
},
{
"name": "current",
"slug": "current",
"id": "f8c81367-f052-4562-bee1-9e6a01432c64"
}
]
}
}
Events
End point | Method | Scope | Purpose | |
|---|---|---|---|---|
| 1 | /events
| GET | event.list | Retrieve a list of events’ public information Public // publishing and listing test required // privacy test required for the org block |
| 2 | /events/{uuid}
| GET | event.read | Retrieve an events public information // publishing and listing test required // privacy test required for the org block Does not send activities Public Show interactions upon validation if client is authenticated as the user who is subject of the interaction |
| 3 | /events | POST | event.create | Adds a new event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 4 | /events/{uuid}/duplicate | POST | event.create | Adds a new event by duplication Validate if client is authenticated as owner (or a member of owner team) of the org |
| 5 | /events/{uuid} | PATCH | event.update | Updates an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 6 | /events/{uuid} | DELETE | event.delete | Deletes an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 7 | /events/{uuid}/publish | POST | event.publish | Publishes an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 8 | /events/{uuid}/unpublish | POST | event.unpublish | Unpublishes an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 9 | /events/{uuid}/sessions | GET | event.list_session | Retrieve an events’ sessions Validate if client is authenticated as owner (or a member of owner team) of the org |
| 10 | /events/{uuid}/sessions | POST | event.add_session | Adds session to an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 11 | /events/{uuid}/sessions/{uuid} | GET | event.read_session | Retrieve a specific session from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 12 | /events/{uuid}/sessions/{uuid} | PATCH | event.update_session | Updates a specific session from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 13 | /events/{uuid}/sessions/{uuid} | DELETE | event.delete_session | Deletes a specific session from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 14 | /events/{uuid}/saves | GET | events.list_save | Retrieves saves of an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 15 | /events/{uuid}/saves | POST | events.add_save | Saves an event // quota test required Validates if the client is authenticated as user as part of authorization |
| 16 | /events/{uuid}/saves/{uuid} | DELETE | events.remove_save | Unsaves an event // quota test required Validates if the client is authenticated as user as part of authorization |
| 17 | /events/{uuid}/shares | GET | events.list_share | Retrieves shares of a review Validate if client is authenticated as owner (or a member of owner team) of the org |
| 18 | /events/{uuid}/shares | POST | events.add_share | Shares an event // quota test required Validates if the client is authenticated as user as part of authorization |
| 19 | /events/{uuid}/shares/{uuid} | DELETE | events.remove_share | Unshares an event // quota test required Validates if the client is authenticated as user as part of authorization |
| 20 | /events/{uuid}/speakers | GET | event.list_speaker | Retrieve list of event’s speakers Validate if client is authenticated as owner (or a member of owner team) of the org |
| 21 | /events/{uuid}/speakers | POST | event.add_speaker | Adds speaker to an event // quota test required Validate if client is authenticated as owner (or a member of owner team) of the org |
| 22 | /events/{uuid}/speakers/{uuid} | GET | event.read_speaker | Retrieve a specific speaker from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 23 | /events/{uuid}/speakers/{uuid} | PATCH | event.update_speaker | Updates a specific speaker from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 24 | /events/{uuid}/speakers/{uuid}/resend_invite | POST | event.resend_invite_speaker | Resends invite to a specific speaker from an event // quota test required Validate if client is authenticated as owner (or a member of owner team) of the org |
| 25 | /events/{uuid}/speakers/{uuid}/accept_invite | POST | event.accept_invite_speaker | Accept speaker invitation from an event Validates if the client is authenticated as user as part of authorization |
| 26 | /events/{uuid}/speakers/{uuid} | DELETE | event.delete_speaker | Deletes a specific speaker from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 27 | /events/{uuid}/invite_to_book | POST | event.send_invite_to_book | Sends invitation to an email address to book // quota test required Validate if client is authenticated as owner (or a member of owner team) of the org |
| 28 | /events/{uuid}/invitations | GET | event.list_invitation | Retrieves list of event’s invitations Validate if client is authenticated as owner (or a member of owner team) of the org |
| 29 | /events/{uuid}/invitations/{uuid} | GET | event.read_invitation | Retrieves a specific invitation from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 30 | /events/{uuid}/invitations/{uuid} | DELETE | event.delete_invitation | Deletes a specific invitation from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 31 | /events/{uuid}/tickets | GET | event.list_ticket | Retrieve list of event’s tickets Validate if client is authenticated as owner (or a member of owner team) of the org |
| 32 | /events/{uuid}/tickets/{uuid} | GET | event.read_ticket | Retrieve a specific ticket from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 33 | /events/{uuid}/attendees | GET | event.list_attendee | Retrieve list of event’s attendees Validate if client is authenticated as owner (or a member of owner team) of the org |
| 34 | /events/{uuid}/attendees/{uuid} | GET | event.read_attendee | Retrieve a specific attendee from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 35 | /events/{uuid}/attendees/{uuid} | PATCH | event.update_attendee | Updates a specific attendee from an event Validate if client is authenticated as owner (or a member of owner team) of the org |
| 36 | /events/{uuid}/suggestions | GET | event.list_suggestion | Retrieve a list of users who could be interested in the event // privacy test required |
| 37 | /events/{uuid}/reviews | GET | event.list_review | Retrieves list of event’s reviews // privacy test required Public |
| 38 | /events/{uuid}/orders | GET | event.list_order | Retrieve list of events’ orders Validate if client is authenticated as owner (or a member of owner team) of the org |
| 39 | /events/{uuid}/related_events | GET | event.list_related_event | Retrieve a list of related events’ public information Public // publishing and listing test required // privacy test required for the org block |
| 40 | /events/{uuid}/waiting_list | GET | event.list_waiting_list | Retrieve a list of waiting list of an event |
| 41 | /events/{uuid}/get_into_waiting_list | POST | event.add_into_waiting_list | Adds into waiting list of an event |
| 42 | /events/{uuid}/cancel | POST | event.cancel | Cancel an event |
| 43 | /events/{uuid}/settings_reviewed | POST |
| Make the created event’s settings reviewed |
1. GET /events
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
Parameter | Type | Allowed value | Note |
|---|---|---|---|
status | enum | draft, ready, published, live, |
|
event_type | enum | venu, online |
|
order_by | enum | created_ascending created_descending starting name_ascending name_descending |
|
category | uuid | Any valid category uuid |
|
country | string | country name |
|
invitation_code | array | code | It will support multiple code with pipe separated value. (e.g.: 1111|ejius2|3940ik) |
contact_email | string |
| |
invitation_id | sting | uuid |
|
time_filter | enum | today, tomorrow, this_week, this_weekend, next_week, next_weekend, this_month, next_month, this_year, next_year Note: only one value is allowed, if multiple is provided only first one will be taken as valid input others will be discarded |
|
search_q | string | Any valid search string |
|
venue_city | string | Any valid city name | All need to be sent for venue wise filtering |
venue_state | string | Any valid state name | |
venue_country | string | Any valid country name | |
organisation | number | Any valid organisation uuid | will support multiple uuid with pipe separated value. (e.g.: 6d3a2eec-bfa2-4975-be73-2fb7ff9850fd|ad4a2eec-bfa2-4975-be73-2fb7ff9850fd) |
currency | string | Any valid currency code, e.g. AUD, USD etc |
|
my | enum | all, attending, speaking, organised_events |
|
position |
|
|
|
rows |
|
|
|
order_by |
|
|
|
Request
No data
Response
code{
"events": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "active",
"extended_status": [
{
"name": "publishing",
"value": "Published"
},
{
"name": "listing",
"value": "Listed"
},
{
"name": "live",
"value": "false"
},
{
"name": "ended",
"value": "false"
},
{
"name": "suspended",
"value": "false"
},
{
"name": "cancelled",
"value": "false"
}
],
"name": "Venue Event",
"display_name": "",
"description": "",
"banner": [
{
"name": "",
"image": "",
"primary": "false"
},
{
"name": "",
"image": "",
"primary": "true"
}
],
"resources": [
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "video"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "image"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "text"
},
{
"name": "content",
"value": []
}
]
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": "https://john.doe/"
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": "https://john.doe/"
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"timezone": "",
"currency": "",
"enable_datetime_conversion": "false",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
],
"created_on": "",
"updated_on": "",
"attending_on": [
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
},
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
}
],
"org": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "Web Mascot",
"slug": "webalive",
"info": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_my_organisation",
"value": "true"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"merchandise": {
"products": [
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "T-shirt",
"code": "TS-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 5,
"min_qty_per_order": 1,
"created_on": "",
"updated_on": ""
},
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "Coffee",
"code": "C-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"created_on": "",
"updated_on": ""
}
]
},
"event_settings_reviewed": false,
"settings": {
"booking_starts_on": {
"immediately": "true",
"utc": "",
"local": "datetime",
"hide_ticket_until_booking_start": "true",
"level": "ticket"
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": "datetime",
"level": "event"
},
"event_capacity": 0,
"terminology": "registration",
"enable_guest_checkout": "true",
"enable_share": "false",
"digital_pass": {
"enabled": "true",
"level": "ticket"
},
"discount": {
"enabled": "true",
"level": "event"
},
"coupon": {
"enabled": "true",
"level": "event"
},
"service_charge": {
"enabled": "true",
"level": "event"
},
"boxoffice": "",
"sell_session_individually": {
"enabled": "true",
"level": "event"
},
"sell_tickets_on_venue": {
"enabled": "true",
"level": "event"
},
"special_instruction": {
"enabled": "true",
"level": "ticket"
},
"waiting_list": {
"enabled": "true",
"level": "event"
},
"tracking_codes": [
{
"type": "code",
"value": "Google analytics"
},
{
"type": "code",
"value": "Google ads"
},
{
"type": "code",
"value": "Facebook pixel"
}
],
"blockout_period": "1440",
"restrictions": [
{
"type": "age",
"enabled": "true",
"level": "event",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"level": "ticket",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"level": "event",
"condition": null
},
{
"type": "email",
"enabled": "true",
"level": "ticket",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
],
"occurrence": {
"type": "daily",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
}
},
"exclusions": [
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
}
],
"type": "weekly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"days": [
"Sunday",
"Monday"
]
},
"type": "monthly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"monthly_recurrence_type": "DAY_NO",
"monthly_recurrence_type": "DAY_NAME"
},
"type": "schedule",
"attributes": [
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
},
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
}
]
},
"configuration": {
"type": "venue_event",
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
},
{
"name": "order_form",
"value": {
"enabled": "true",
"list": [
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"date_format": "mm/dd/yyyy",
"minlength": "",
"maxlength": "",
"information_source": "from_each_attendees",
"option": [
"Australia",
"Bangladesh"
]
}
},
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"minlength": "",
"maxlength": "",
"information_source": "from_buyer_only",
"option": [
"Male",
"Female"
]
}
}
]
}
}
]
},
"tickets": {
"price_is_fee_inclusive": "",
"price_is_tax_inclusive": "",
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": "30"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": true,
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "percentage",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"condition": null
},
{
"type": "email",
"enabled": "true",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
},
{
"uuid": "",
"display_order": "natural",
"name": "This is a donation ticket",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "donation",
"url_digital_pass": null,
"pricing_details": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"quantity_included": "1",
"quantity_sold": "30"
},
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": ""
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
},
"enable_sell_ticket_on_venue": "false",
"pass_on_fees": "false",
"hide_ticket_until_booking_start": "false",
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket with variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "20",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "oa3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "var 1",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": "0"
},
{
"uuid": "oa3a2eec-bfa2-4975-be73-3645dfbg356y",
"variation": "var 2",
"price": "$100.00",
"quantity_included": "5",
"quantity_sold": "0"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": true,
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
}
]
},
"listing": {
"enabled": "true",
"categories": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
},
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
],
"tags": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
},
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
]
},
"sessions": {
"enabled": "true",
"session_lists": [
{
"type": "required",
"uuid": "",
"status": "active",
"name": " Session One",
"display_name": "",
"description": "",
"image": "",
"created_on": "",
"updated_on": "",
"configuration": {
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"uuid": "variation",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "1",
"name": "Single Ticket WITH Variation",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "Gold",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
},
{
"variation": "Silver",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "fixed",
"discount": "5",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
}
]
},
"session_booking_starts_on": {
"utc": "",
"local": ""
},
"session_booking_ends_on": {
"utc": "",
"local": ""
},
"session_starts_on": {
"utc": "",
"local": ""
},
"session_ends_on": {
"utc": "",
"local": ""
}
},
{
"type": "optional",
"uuid": "",
"status": "active",
"name": "Session Two (Optional)",
"display_name": "",
"description": "",
"image": "",
"created_on": "",
"updated_on": "",
"configuration": {
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "1",
"name": "Single Ticket WITH Variation",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "Gold",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
},
{
"variation": "Silver",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "fixed",
"discount": "5",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
}
]
},
"session_booking_starts_on": {
"utc": "",
"local": ""
},
"session_booking_ends_on": {
"utc": "",
"local": ""
},
"session_starts_on": {
"utc": "",
"local": ""
},
"session_ends_on": {
"utc": "",
"local": ""
}
}
]
},
"refund": {
"available": "true",
"policy": {
"cancel_before_event_starts": "7",
"automatic": "false"
}
},
"metrics": [
{
"name": "shared_count",
"value": "304"
},
{
"name": "saved_count",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"fees": {
"currency": "",
"pass_on": "true",
"rate": [
{
"name": "eventbookings_service_fee_fixed",
"value": "0.3"
},
{
"name": "eventbookings_service_fee_percentage",
"value": "3.4"
},
{
"name": "payment_processing_fee_fixed",
"value": "0"
},
{
"name": "payment_processing_fee_percentage",
"value": "0"
}
],
"price_is_tax_inclusive": "",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
]
},
"activities": [
{
"name": "events_hosted",
"value": "304",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "revenue_earned",
"value": "50000",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "orders_received",
"value": "302",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "pages_viewed",
"value": "4,670",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "tickets_sold",
"value": "302",
"meta": {
"start_date": "",
"end_date": ""
}
}
],
"interactions": {
"saves": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"shares": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
{
"uuid": "ad3a2eec-bfa2-4975-be73-2fb7ff9850fd"
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
2. GET /events/{uuid}
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
No data
Response
{
"events": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "active",
"extended_status": [
{
"name": "publishing",
"value": "Published"
},
{
"name": "listing",
"value": "Listed"
},
{
"name": "live",
"value": "false"
},
{
"name": "ended",
"value": "false"
},
{
"name": "suspended",
"value": "false"
},
{
"name": "cancelled",
"value": "false"
}
],
"name": "Venue Event",
"display_name": "",
"description": "",
"banner": [
{
"name": "",
"image": "",
"primary": "false"
},
{
"name": "",
"image": "",
"primary": "true"
}
],
"resources": [
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "video"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "image"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "text"
},
{
"name": "content",
"value": []
}
]
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": "https://john.doe/"
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": "https://john.doe/"
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"timezone": "",
"currency": "",
"enable_datetime_conversion": "false",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
],
"created_on": "",
"updated_on": "",
"attending_on": [
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
},
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
}
],
"org": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "Web Mascot",
"slug": "webalive",
"info": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_my_organisation",
"value": "true"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"merchandise": {
"products": [
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "T-shirt",
"code": "TS-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 5,
"min_qty_per_order": 1,
"created_on": "",
"updated_on": ""
},
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "Coffee",
"code": "C-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"created_on": "",
"updated_on": ""
}
]
},
"event_settings_reviewed": false,
"settings": {
"booking_starts_on": {
"immediately": "true",
"utc": "",
"local": "datetime",
"hide_ticket_until_booking_start": "true",
"level": "ticket"
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": "datetime",
"level": "event"
},
"event_capacity": 0,
"terminology": "registration",
"enable_guest_checkout": "true",
"enable_share": "false",
"digital_pass": {
"enabled": "true",
"level": "ticket"
},
"discount": {
"enabled": "true",
"level": "event"
},
"coupon": {
"enabled": "true",
"level": "event"
},
"service_charge": {
"enabled": "true",
"level": "event"
},
"boxoffice": "",
"sell_session_individually": {
"enabled": "true",
"level": "event"
},
"sell_tickets_on_venue": {
"enabled": "true",
"level": "event"
},
"special_instruction": {
"enabled": "true",
"level": "ticket"
},
"waiting_list": {
"enabled": "true",
"level": "event"
},
"tracking_codes": [
{
"type": "code",
"value": "Google analytics"
},
{
"type": "code",
"value": "Google ads"
},
{
"type": "code",
"value": "Facebook pixel"
}
],
"blockout_period": "1440",
"restrictions": [
{
"type": "age",
"enabled": "true",
"level": "event",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"level": "ticket",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"level": "event",
"condition": null
},
{
"type": "email",
"enabled": "true",
"level": "ticket",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
],
"occurrence": {
"type": "daily",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
}
},
"exclusions": [
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
}
],
"type": "weekly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"days": [
"Sunday",
"Monday"
]
},
"type": "monthly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"monthly_recurrence_type": "DAY_NO",
"monthly_recurrence_type": "DAY_NAME"
},
"type": "schedule",
"attributes": [
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
},
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
}
]
},
"configuration": {
"type": "venue_event",
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
},
{
"name": "order_form",
"value": {
"enabled": "true",
"list": [
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"date_format": "mm/dd/yyyy",
"minlength": "",
"maxlength": "",
"information_source": "from_each_attendees",
"option": [
"Australia",
"Bangladesh"
]
}
},
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"minlength": "",
"maxlength": "",
"information_source": "from_buyer_only",
"option": [
"Male",
"Female"
]
}
}
]
}
}
]
},
"tickets": {
"price_is_fee_inclusive": "",
"price_is_tax_inclusive": "",
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": "30"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": true,
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "percentage",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"condition": null
},
{
"type": "email",
"enabled": "true",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
},
{
"uuid": "",
"display_order": "natural",
"name": "This is a donation ticket",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "donation",
"url_digital_pass": null,
"pricing_details": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"quantity_included": "1",
"quantity_sold": "30"
},
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": ""
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
},
"enable_sell_ticket_on_venue": "false",
"pass_on_fees": "false",
"hide_ticket_until_booking_start": "false",
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket with variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "20",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "oa3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "var 1",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": "0"
},
{
"uuid": "oa3a2eec-bfa2-4975-be73-3645dfbg356y",
"variation": "var 2",
"price": "$100.00",
"quantity_included": "5",
"quantity_sold": "0"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": true,
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
}
]
},
"listing": {
"enabled": "true",
"categories": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
},
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
],
"tags": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
},
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
]
},
"sessions": {
"enabled": "true",
"session_lists": [
{
"type": "required",
"uuid": "",
"status": "active",
"name": " Session One",
"display_name": "",
"description": "",
"image": "",
"created_on": "",
"updated_on": "",
"configuration": {
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"uuid": "variation",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "1",
"name": "Single Ticket WITH Variation",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "Gold",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
},
{
"variation": "Silver",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "fixed",
"discount": "5",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
}
]
},
"session_booking_starts_on": {
"utc": "",
"local": ""
},
"session_booking_ends_on": {
"utc": "",
"local": ""
},
"session_starts_on": {
"utc": "",
"local": ""
},
"session_ends_on": {
"utc": "",
"local": ""
}
},
{
"type": "optional",
"uuid": "",
"status": "active",
"name": "Session Two (Optional)",
"display_name": "",
"description": "",
"image": "",
"created_on": "",
"updated_on": "",
"configuration": {
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "1",
"name": "Single Ticket WITH Variation",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "Gold",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
},
{
"variation": "Silver",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "fixed",
"discount": "5",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
}
]
},
"session_booking_starts_on": {
"utc": "",
"local": ""
},
"session_booking_ends_on": {
"utc": "",
"local": ""
},
"session_starts_on": {
"utc": "",
"local": ""
},
"session_ends_on": {
"utc": "",
"local": ""
}
}
]
},
"refund": {
"available": "true",
"policy": {
"cancel_before_event_starts": "7",
"automatic": "false"
}
},
"metrics": [
{
"name": "shared_count",
"value": "304"
},
{
"name": "saved_count",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"fees": {
"currency": "",
"pass_on": "true",
"rate": [
{
"name": "eventbookings_service_fee_fixed",
"value": "0.3"
},
{
"name": "eventbookings_service_fee_percentage",
"value": "3.4"
},
{
"name": "payment_processing_fee_fixed",
"value": "0"
},
{
"name": "payment_processing_fee_percentage",
"value": "0"
}
],
"price_is_tax_inclusive": "",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
]
},
"activities": [
{
"name": "events_hosted",
"value": "304",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "revenue_earned",
"value": "50000",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "orders_received",
"value": "302",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "pages_viewed",
"value": "4,670",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "tickets_sold",
"value": "302",
"meta": {
"start_date": "",
"end_date": ""
}
}
],
"interactions": {
"saves": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"shares": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
{
"uuid": "ad3a2eec-bfa2-4975-be73-2fb7ff9850fd"
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
3. POST /events
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
No data
Response
{
"event": {
"name": "Flower Festival",
"description": "This is a seminar of discussing about environmental problems with honorable members of society",
"occurrence": {
"type": "daily",
"attributes": {
"starts_on": "2023-02-25 10:00",
"event_duration": 60,
"occurrence_ends": {
"type": "number_of_event",
"value": 10
}
}
},
"banner": [
{
"name": "xxx",
"image": "uploads/orgs/4fa3b56c5b2bacd5e65c877eb6067183/events/e71caf92-14d0-4ec1-9ba0-3ef49dd745e8.jpg",
"primary": true
}
],
"resources": [
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 3
},
{
"name": "type",
"value": "text"
},
{
"name": "content",
"value": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec so"
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 2
},
{
"name": "type",
"value": "video"
},
{
"name": "content",
"value": "https://www.youtube.com/watch?v=0UdTcjrdXK8&list=RD0UdTcjrdXK8&start_radio=1"
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "image"
},
{
"name": "content",
"value": "uploads/orgs/4fa3b56c5b2bacd5e65c877eb6067183/events/e71caf92-14d0-4ec1-9ba0-3ef49dd745e8.jpg"
}
]
],
"timezone": "Australia/Melbourne",
"enable_datetime_conversion": false,
"coupons": [
{
"uuid": "",
"name": "coupon another check",
"code": "122",
"discount_amount": "20.00",
"discount_type": "Percentage",
"starts_on": {
"utc": "",
"local": "2023-12-25 16:15"
},
"ends_on": {
"utc": "",
"local": "2024-12-11 14:00"
},
"uses_per_coupon": 100,
"uses_per_customer": 100,
"status": 0
}
],
"early_bird_discount": {
"discount_type": "Percentage",
"discount": "20",
"discount_starts_on": {
"immediately": false,
"local": "2022-12-10 10:00"
},
"discount_ends_on": {
"continue_until_event_ends": false,
"local": "2023-01-06 10:00"
}
},
"settings": {
"booking_starts_on": {
"immediately": true,
"local": "datetime",
"hide_ticket_until_booking_start": true,
"level": "event"
},
"booking_ends_on": {
"continue_until_event_ends": true,
"local": "",
"level": "event"
},
"event_capacity": 0,
"terminology": "registration",
"enable_guest_checkout": false,
"enable_share": false,
"digital_pass": {
"enabled": true,
"level": "ticket"
},
"discount": {
"enabled": false,
"level": "event"
},
"coupon": {
"enabled": false,
"level": "event"
},
"service_charge": {
"enabled": false,
"level": "ticket"
},
"boxoffice": "",
"sell_session_individually": {
"enabled": true,
"level": "ticket"
},
"sell_tickets_on_venue": {
"enabled": false,
"level": "ticket"
},
"special_instruction": {
"enabled": true,
"level": "ticket"
},
"waiting_list": {
"enabled": true,
"level": "event"
},
"tracking_codes": [
{
"type": "code",
"value": "google_code"
},
{
"type": "code",
"value": "facebook_code"
}
],
"restrictions": [
{
"type": "invitation_code",
"enabled": true,
"level": "event",
"condition": {
"code": "aaaa"
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
],
"configuration": {
"type": "venue_event",
"attributes": [
{
"name": "venue",
"value": {
"name": "130 State Route 50",
"image": "uploads\\orgs\\",
"url": "",
"latitude": 80,
"longitude": 80,
"address": {
"address_line1": "130 State Route 50",
"address_line2": "",
"country": "Australia",
"state": "Victoria",
"city": "Melbourne",
"post_code": 3004
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": -1,
"max_quantity_per_customer": 1,
"category": "ticket",
"pricing_details": [
{
"variation": "",
"price": "30.0",
"quantity_included": 1
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"local": "2022-12-06 10:00"
},
"discount_ends_on": {
"continue_until_event_ends": true,
"local": "2023-02-06 10:00"
}
},
"settings": {
"booking_starts_on": {
"immediately": true,
"hide_ticket_until_booking_start": false,
"local": ""
},
"booking_ends_on": {
"continue_until_event_ends": true,
"local": ""
},
"enable_sell_ticket_on_venue": true,
"price_included_service_charge": false,
"enable_digital_pass": true,
"enable_waiting_list": true,
"restrictions": [
{
"type": "invitation_code",
"enabled": true,
"condition": {
"code": "aRa"
}
}
]
},
"custom_attributes": [
{
"name": "disclaimer_text",
"value": "If you are at the event, keep your belongings safely in your own responsibility."
}
]
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket WITH Variation",
"description": "",
"quantity": -1,
"max_quantity_per_customer": -1,
"category": "ticket",
"pricing_details": [
{
"uuid": "pd3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "Gold",
"price": "30.0",
"quantity_included": 5
},
{
"uuid": "",
"variation": "Silver",
"price": "50.0",
"quantity_included": 3
}
],
"settings": {
"booking_starts_on": {
"immediately": true,
"hide_ticket_until_booking_start": false,
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": true,
"local": "datetime"
},
"enable_sell_ticket_on_venue": false,
"price_included_service_charge": true,
"enable_digital_pass": false,
"enable_waiting_list": false,
"restrictions": [
{
"type": "invitation_code",
"enabled": true,
"condition": {
"code": "222"
}
}
]
}
},
{
"uuid": "",
"display_order": "natural",
"name": "This is a donation ticket",
"description": "",
"quantity": "50",
"category": "donation",
"pricing_details": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"quantity_included": 1
},
"settings": {
"enable_sell_ticket_on_venue": false,
"price_included_service_charge": false,
"enable_digital_pass": false,
"enable_waiting_list": false,
"restrictions": [
{
"type": "age",
"enabled": false,
"condition": {
"max": 20
}
}
]
}
}
]
},
"listing": {
"enabled": false,
"categories": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
],
"tags": [
{
"uuid": "",
"name": "active_event",
"description": "",
"url": "",
"image": ""
}
]
},
"refund": {
"available": false,
"policy": {
"cancel_before_event_starts": 30,
"automatic": true,
"amount": {
"discount_type": "",
"discount_unit": 20
}
}
}
}
}
Response
{
"events": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "active",
"extended_status": [
{
"name": "publishing",
"value": "Published"
},
{
"name": "listing",
"value": "Listed"
},
{
"name": "live",
"value": "false"
},
{
"name": "ended",
"value": "false"
},
{
"name": "suspended",
"value": "false"
},
{
"name": "cancelled",
"value": "false"
}
],
"name": "Venue Event",
"display_name": "",
"description": "",
"banner": [
{
"name": "",
"image": "",
"primary": "false"
},
{
"name": "",
"image": "",
"primary": "true"
}
],
"resources": [
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "video"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "image"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "text"
},
{
"name": "content",
"value": []
}
]
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": "https://john.doe/"
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": "https://john.doe/"
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"timezone": "",
"currency": "",
"enable_datetime_conversion": "false",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
],
"created_on": "",
"updated_on": "",
"attending_on": [
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
},
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
}
],
"org": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "Web Mascot",
"slug": "webalive",
"info": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_my_organisation",
"value": "true"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"merchandise": {
"products": [
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "T-shirt",
"code": "TS-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 5,
"min_qty_per_order": 1,
"created_on": "",
"updated_on": ""
},
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "Coffee",
"code": "C-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"created_on": "",
"updated_on": ""
}
]
},
"event_settings_reviewed": false,
"settings": {
"booking_starts_on": {
"immediately": "true",
"utc": "",
"local": "datetime",
"hide_ticket_until_booking_start": "true",
"level": "ticket"
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": "datetime",
"level": "event"
},
"event_capacity": 0,
"terminology": "registration",
"enable_guest_checkout": "true",
"enable_share": "false",
"digital_pass": {
"enabled": "true",
"level": "ticket"
},
"discount": {
"enabled": "true",
"level": "event"
},
"coupon": {
"enabled": "true",
"level": "event"
},
"service_charge": {
"enabled": "true",
"level": "event"
},
"boxoffice": "",
"sell_session_individually": {
"enabled": "true",
"level": "event"
},
"sell_tickets_on_venue": {
"enabled": "true",
"level": "event"
},
"special_instruction": {
"enabled": "true",
"level": "ticket"
},
"waiting_list": {
"enabled": "true",
"level": "event"
},
"tracking_codes": [
{
"type": "code",
"value": "Google analytics"
},
{
"type": "code",
"value": "Google ads"
},
{
"type": "code",
"value": "Facebook pixel"
}
],
"blockout_period": "1440",
"restrictions": [
{
"type": "age",
"enabled": "true",
"level": "event",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"level": "ticket",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"level": "event",
"condition": null
},
{
"type": "email",
"enabled": "true",
"level": "ticket",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
],
"occurrence": {
"type": "daily",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
}
},
"exclusions": [
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
}
],
"type": "weekly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"days": [
"Sunday",
"Monday"
]
},
"type": "monthly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"monthly_recurrence_type": "DAY_NO",
"monthly_recurrence_type": "DAY_NAME"
},
"type": "schedule",
"attributes": [
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
},
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
}
]
},
"configuration": {
"type": "venue_event",
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
},
{
"name": "order_form",
"value": {
"enabled": "true",
"list": [
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"date_format": "mm/dd/yyyy",
"minlength": "",
"maxlength": "",
"information_source": "from_each_attendees",
"option": [
"Australia",
"Bangladesh"
]
}
},
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"minlength": "",
"maxlength": "",
"information_source": "from_buyer_only",
"option": [
"Male",
"Female"
]
}
}
]
}
}
]
},
"tickets": {
"price_is_fee_inclusive": "",
"price_is_tax_inclusive": "",
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": "30"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": true,
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "percentage",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"condition": null
},
{
"type": "email",
"enabled": "true",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
},
{
"uuid": "",
"display_order": "natural",
"name": "This is a donation ticket",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "donation",
"url_digital_pass": null,
"pricing_details": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"quantity_included": "1",
"quantity_sold": "30"
},
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": ""
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
},
"enable_sell_ticket_on_venue": "false",
"pass_on_fees": "false",
"hide_ticket_until_booking_start": "false",
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket with variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "20",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "oa3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "var 1",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": "0"
},
{
"uuid": "oa3a2eec-bfa2-4975-be73-3645dfbg356y",
"variation": "var 2",
"price": "$100.00",
"quantity_included": "5",
"quantity_sold": "0"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": true,
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
}
]
},
"listing": {
"enabled": "true",
"categories": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
},
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
],
"tags": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
},
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
]
},
"sessions": {
"enabled": "true",
"session_lists": [
{
"type": "required",
"uuid": "",
"status": "active",
"name": " Session One",
"display_name": "",
"description": "",
"image": "",
"created_on": "",
"updated_on": "",
"configuration": {
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"uuid": "variation",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "1",
"name": "Single Ticket WITH Variation",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "Gold",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
},
{
"variation": "Silver",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "fixed",
"discount": "5",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
}
]
},
"session_booking_starts_on": {
"utc": "",
"local": ""
},
"session_booking_ends_on": {
"utc": "",
"local": ""
},
"session_starts_on": {
"utc": "",
"local": ""
},
"session_ends_on": {
"utc": "",
"local": ""
}
},
{
"type": "optional",
"uuid": "",
"status": "active",
"name": "Session Two (Optional)",
"display_name": "",
"description": "",
"image": "",
"created_on": "",
"updated_on": "",
"configuration": {
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "1",
"name": "Single Ticket WITH Variation",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "Gold",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
},
{
"variation": "Silver",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "fixed",
"discount": "5",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
}
]
},
"session_booking_starts_on": {
"utc": "",
"local": ""
},
"session_booking_ends_on": {
"utc": "",
"local": ""
},
"session_starts_on": {
"utc": "",
"local": ""
},
"session_ends_on": {
"utc": "",
"local": ""
}
}
]
},
"refund": {
"available": "true",
"policy": {
"cancel_before_event_starts": "7",
"automatic": "false"
}
},
"metrics": [
{
"name": "shared_count",
"value": "304"
},
{
"name": "saved_count",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"fees": {
"currency": "",
"pass_on": "true",
"rate": [
{
"name": "eventbookings_service_fee_fixed",
"value": "0.3"
},
{
"name": "eventbookings_service_fee_percentage",
"value": "3.4"
},
{
"name": "payment_processing_fee_fixed",
"value": "0"
},
{
"name": "payment_processing_fee_percentage",
"value": "0"
}
],
"price_is_tax_inclusive": "",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
]
},
"activities": [
{
"name": "events_hosted",
"value": "304",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "revenue_earned",
"value": "50000",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "orders_received",
"value": "302",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "pages_viewed",
"value": "4,670",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "tickets_sold",
"value": "302",
"meta": {
"start_date": "",
"end_date": ""
}
}
],
"interactions": {
"saves": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"shares": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
{
"uuid": "ad3a2eec-bfa2-4975-be73-2fb7ff9850fd"
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
4. GET /events/{uuid}/duplicate
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
No data
Response
{
"events": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "active",
"extended_status": [
{
"name": "publishing",
"value": "Published"
},
{
"name": "listing",
"value": "Listed"
},
{
"name": "live",
"value": "false"
},
{
"name": "ended",
"value": "false"
},
{
"name": "suspended",
"value": "false"
},
{
"name": "cancelled",
"value": "false"
}
],
"name": "Venue Event",
"display_name": "",
"description": "",
"banner": [
{
"name": "",
"image": "",
"primary": "false"
},
{
"name": "",
"image": "",
"primary": "true"
}
],
"resources": [
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "video"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "image"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "text"
},
{
"name": "content",
"value": []
}
]
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": "https://john.doe/"
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": "https://john.doe/"
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"timezone": "",
"currency": "",
"enable_datetime_conversion": "false",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
],
"created_on": "",
"updated_on": "",
"attending_on": [
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
},
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
}
],
"org": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "Web Mascot",
"slug": "webalive",
"info": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_my_organisation",
"value": "true"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"merchandise": {
"products": [
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "T-shirt",
"code": "TS-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 5,
"min_qty_per_order": 1,
"created_on": "",
"updated_on": ""
},
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "Coffee",
"code": "C-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"created_on": "",
"updated_on": ""
}
]
},
"event_settings_reviewed": false,
"settings": {
"booking_starts_on": {
"immediately": "true",
"utc": "",
"local": "datetime",
"hide_ticket_until_booking_start": "true",
"level": "ticket"
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": "datetime",
"level": "event"
},
"event_capacity": 0,
"terminology": "registration",
"enable_guest_checkout": "true",
"enable_share": "false",
"digital_pass": {
"enabled": "true",
"level": "ticket"
},
"discount": {
"enabled": "true",
"level": "event"
},
"coupon": {
"enabled": "true",
"level": "event"
},
"service_charge": {
"enabled": "true",
"level": "event"
},
"boxoffice": "",
"sell_session_individually": {
"enabled": "true",
"level": "event"
},
"sell_tickets_on_venue": {
"enabled": "true",
"level": "event"
},
"special_instruction": {
"enabled": "true",
"level": "ticket"
},
"waiting_list": {
"enabled": "true",
"level": "event"
},
"tracking_codes": [
{
"type": "code",
"value": "Google analytics"
},
{
"type": "code",
"value": "Google ads"
},
{
"type": "code",
"value": "Facebook pixel"
}
],
"blockout_period": "1440",
"restrictions": [
{
"type": "age",
"enabled": "true",
"level": "event",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"level": "ticket",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"level": "event",
"condition": null
},
{
"type": "email",
"enabled": "true",
"level": "ticket",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
],
"occurrence": {
"type": "daily",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
}
},
"exclusions": [
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
}
],
"type": "weekly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"days": [
"Sunday",
"Monday"
]
},
"type": "monthly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"monthly_recurrence_type": "DAY_NO",
"monthly_recurrence_type": "DAY_NAME"
},
"type": "schedule",
"attributes": [
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
},
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
}
]
},
"configuration": {
"type": "venue_event",
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
},
{
"name": "order_form",
"value": {
"enabled": "true",
"list": [
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"date_format": "mm/dd/yyyy",
"minlength": "",
"maxlength": "",
"information_source": "from_each_attendees",
"option": [
"Australia",
"Bangladesh"
]
}
},
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"minlength": "",
"maxlength": "",
"information_source": "from_buyer_only",
"option": [
"Male",
"Female"
]
}
}
]
}
}
]
},
"tickets": {
"price_is_fee_inclusive": "",
"price_is_tax_inclusive": "",
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": "30"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": true,
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "percentage",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"condition": null
},
{
"type": "email",
"enabled": "true",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
},
{
"uuid": "",
"display_order": "natural",
"name": "This is a donation ticket",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "donation",
"url_digital_pass": null,
"pricing_details": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"quantity_included": "1",
"quantity_sold": "30"
},
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": ""
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
},
"enable_sell_ticket_on_venue": "false",
"pass_on_fees": "false",
"hide_ticket_until_booking_start": "false",
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket with variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "20",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "oa3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "var 1",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": "0"
},
{
"uuid": "oa3a2eec-bfa2-4975-be73-3645dfbg356y",
"variation": "var 2",
"price": "$100.00",
"quantity_included": "5",
"quantity_sold": "0"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": true,
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
}
]
},
"listing": {
"enabled": "true",
"categories": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
},
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
],
"tags": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
},
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
]
},
"sessions": {
"enabled": "true",
"session_lists": [
{
"type": "required",
"uuid": "",
"status": "active",
"name": " Session One",
"display_name": "",
"description": "",
"image": "",
"created_on": "",
"updated_on": "",
"configuration": {
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"uuid": "variation",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "1",
"name": "Single Ticket WITH Variation",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "Gold",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
},
{
"variation": "Silver",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "fixed",
"discount": "5",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
}
]
},
"session_booking_starts_on": {
"utc": "",
"local": ""
},
"session_booking_ends_on": {
"utc": "",
"local": ""
},
"session_starts_on": {
"utc": "",
"local": ""
},
"session_ends_on": {
"utc": "",
"local": ""
}
},
{
"type": "optional",
"uuid": "",
"status": "active",
"name": "Session Two (Optional)",
"display_name": "",
"description": "",
"image": "",
"created_on": "",
"updated_on": "",
"configuration": {
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "1",
"name": "Single Ticket WITH Variation",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "Gold",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
},
{
"variation": "Silver",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "fixed",
"discount": "5",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
}
]
},
"session_booking_starts_on": {
"utc": "",
"local": ""
},
"session_booking_ends_on": {
"utc": "",
"local": ""
},
"session_starts_on": {
"utc": "",
"local": ""
},
"session_ends_on": {
"utc": "",
"local": ""
}
}
]
},
"refund": {
"available": "true",
"policy": {
"cancel_before_event_starts": "7",
"automatic": "false"
}
},
"metrics": [
{
"name": "shared_count",
"value": "304"
},
{
"name": "saved_count",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"fees": {
"currency": "",
"pass_on": "true",
"rate": [
{
"name": "eventbookings_service_fee_fixed",
"value": "0.3"
},
{
"name": "eventbookings_service_fee_percentage",
"value": "3.4"
},
{
"name": "payment_processing_fee_fixed",
"value": "0"
},
{
"name": "payment_processing_fee_percentage",
"value": "0"
}
],
"price_is_tax_inclusive": "",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
]
},
"activities": [
{
"name": "events_hosted",
"value": "304",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "revenue_earned",
"value": "50000",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "orders_received",
"value": "302",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "pages_viewed",
"value": "4,670",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "tickets_sold",
"value": "302",
"meta": {
"start_date": "",
"end_date": ""
}
}
],
"interactions": {
"saves": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"shares": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
{
"uuid": "ad3a2eec-bfa2-4975-be73-2fb7ff9850fd"
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
5. PATCH /events/{uuid}
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
{
"event": {
"name": "Flower Festival",
"description": "This is a seminar of discussing about environmental problems with honorable members of society",
"occurrence": {
"type": "daily",
"attributes": {
"starts_on": "2023-02-25 10:00",
"event_duration": 60,
"occurrence_ends": {
"type": "number_of_event",
"value": 10
}
}
},
"banner": [
{
"name": "xxx",
"image": "uploads/orgs/4fa3b56c5b2bacd5e65c877eb6067183/events/e71caf92-14d0-4ec1-9ba0-3ef49dd745e8.jpg",
"primary": true
}
],
"resources": [
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 3
},
{
"name": "type",
"value": "text"
},
{
"name": "content",
"value": "Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec so"
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 2
},
{
"name": "type",
"value": "video"
},
{
"name": "content",
"value": "https://www.youtube.com/watch?v=0UdTcjrdXK8&list=RD0UdTcjrdXK8&start_radio=1"
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "image"
},
{
"name": "content",
"value": "uploads/orgs/4fa3b56c5b2bacd5e65c877eb6067183/events/e71caf92-14d0-4ec1-9ba0-3ef49dd745e8.jpg"
}
]
],
"timezone": "Australia/Melbourne",
"enable_datetime_conversion": false,
"coupons": [
{
"uuid": "",
"name": "coupon another check",
"code": "122",
"discount_amount": "20.00",
"discount_type": "Percentage",
"starts_on": {
"utc": "",
"local": "2023-12-25 16:15"
},
"ends_on": {
"utc": "",
"local": "2024-12-11 14:00"
},
"uses_per_coupon": 100,
"uses_per_customer": 100,
"status": 0
}
],
"early_bird_discount": {
"discount_type": "Percentage",
"discount": "20",
"discount_starts_on": {
"immediately": false,
"local": "2022-12-10 10:00"
},
"discount_ends_on": {
"continue_until_event_ends": false,
"local": "2023-01-06 10:00"
}
},
"settings": {
"booking_starts_on": {
"immediately": true,
"local": "datetime",
"hide_ticket_until_booking_start": true,
"level": "event"
},
"booking_ends_on": {
"continue_until_event_ends": true,
"local": "",
"level": "event"
},
"event_capacity": 0,
"terminology": "registration",
"enable_guest_checkout": false,
"enable_share": false,
"digital_pass": {
"enabled": true,
"level": "ticket"
},
"discount": {
"enabled": false,
"level": "event"
},
"coupon": {
"enabled": false,
"level": "event"
},
"service_charge": {
"enabled": false,
"level": "ticket"
},
"boxoffice": "",
"sell_session_individually": {
"enabled": true,
"level": "ticket"
},
"sell_tickets_on_venue": {
"enabled": false,
"level": "ticket"
},
"special_instruction": {
"enabled": true,
"level": "ticket"
},
"waiting_list": {
"enabled": true,
"level": "event"
},
"tracking_codes": [
{
"type": "code",
"value": "google_code"
},
{
"type": "code",
"value": "facebook_code"
}
],
"restrictions": [
{
"type": "invitation_code",
"enabled": true,
"level": "event",
"condition": {
"code": "aaaa"
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
],
"configuration": {
"type": "venue_event",
"attributes": [
{
"name": "venue",
"value": {
"name": "130 State Route 50",
"image": "uploads\\orgs\\",
"url": "",
"latitude": 80,
"longitude": 80,
"address": {
"address_line1": "130 State Route 50",
"address_line2": "",
"country": "Australia",
"state": "Victoria",
"city": "Melbourne",
"post_code": 3004
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": -1,
"max_quantity_per_customer": 1,
"category": "ticket",
"pricing_details": [
{
"variation": "",
"price": "30.0",
"quantity_included": 1
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"local": "2022-12-06 10:00"
},
"discount_ends_on": {
"continue_until_event_ends": true,
"local": "2023-02-06 10:00"
}
},
"settings": {
"booking_starts_on": {
"immediately": true,
"hide_ticket_until_booking_start": false,
"local": ""
},
"booking_ends_on": {
"continue_until_event_ends": true,
"local": ""
},
"enable_sell_ticket_on_venue": true,
"price_included_service_charge": false,
"enable_digital_pass": true,
"enable_waiting_list": true,
"restrictions": [
{
"type": "invitation_code",
"enabled": true,
"condition": {
"code": "aRa"
}
}
]
},
"custom_attributes": [
{
"name": "disclaimer_text",
"value": "If you are at the event, keep your belongings safely in your own responsibility."
}
]
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket WITH Variation",
"description": "",
"quantity": -1,
"max_quantity_per_customer": -1,
"category": "ticket",
"pricing_details": [
{
"uuid": "pd3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "Gold",
"price": "30.0",
"quantity_included": 5
},
{
"uuid": "",
"variation": "Silver",
"price": "50.0",
"quantity_included": 3
}
],
"settings": {
"booking_starts_on": {
"immediately": true,
"hide_ticket_until_booking_start": false,
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": true,
"local": "datetime"
},
"enable_sell_ticket_on_venue": false,
"price_included_service_charge": true,
"enable_digital_pass": false,
"enable_waiting_list": false,
"restrictions": [
{
"type": "invitation_code",
"enabled": true,
"condition": {
"code": "222"
}
}
]
}
},
{
"uuid": "",
"display_order": "natural",
"name": "This is a donation ticket",
"description": "",
"quantity": "50",
"category": "donation",
"pricing_details": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"quantity_included": 1
},
"settings": {
"enable_sell_ticket_on_venue": false,
"price_included_service_charge": false,
"enable_digital_pass": false,
"enable_waiting_list": false,
"restrictions": [
{
"type": "age",
"enabled": false,
"condition": {
"max": 20
}
}
]
}
}
]
},
"listing": {
"enabled": false,
"categories": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
],
"tags": [
{
"uuid": "",
"name": "active_event",
"description": "",
"url": "",
"image": ""
}
]
},
"refund": {
"available": false,
"policy": {
"cancel_before_event_starts": 30,
"automatic": true,
"amount": {
"discount_type": "",
"discount_unit": 20
}
}
}
}
}
Response
{
"events": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "active",
"extended_status": [
{
"name": "publishing",
"value": "Published"
},
{
"name": "listing",
"value": "Listed"
},
{
"name": "live",
"value": "false"
},
{
"name": "ended",
"value": "false"
},
{
"name": "suspended",
"value": "false"
},
{
"name": "cancelled",
"value": "false"
}
],
"name": "Venue Event",
"display_name": "",
"description": "",
"banner": [
{
"name": "",
"image": "",
"primary": "false"
},
{
"name": "",
"image": "",
"primary": "true"
}
],
"resources": [
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "video"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "image"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "text"
},
{
"name": "content",
"value": []
}
]
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": "https://john.doe/"
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": "https://john.doe/"
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"timezone": "",
"currency": "",
"enable_datetime_conversion": "false",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
],
"created_on": "",
"updated_on": "",
"attending_on": [
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
},
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
}
],
"org": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "Web Mascot",
"slug": "webalive",
"info": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_my_organisation",
"value": "true"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"merchandise": {
"products": [
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "T-shirt",
"code": "TS-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 5,
"min_qty_per_order": 1,
"created_on": "",
"updated_on": ""
},
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "Coffee",
"code": "C-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"created_on": "",
"updated_on": ""
}
]
},
"event_settings_reviewed": false,
"settings": {
"booking_starts_on": {
"immediately": "true",
"utc": "",
"local": "datetime",
"hide_ticket_until_booking_start": "true",
"level": "ticket"
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": "datetime",
"level": "event"
},
"event_capacity": 0,
"terminology": "registration",
"enable_guest_checkout": "true",
"enable_share": "false",
"digital_pass": {
"enabled": "true",
"level": "ticket"
},
"discount": {
"enabled": "true",
"level": "event"
},
"coupon": {
"enabled": "true",
"level": "event"
},
"service_charge": {
"enabled": "true",
"level": "event"
},
"boxoffice": "",
"sell_session_individually": {
"enabled": "true",
"level": "event"
},
"sell_tickets_on_venue": {
"enabled": "true",
"level": "event"
},
"special_instruction": {
"enabled": "true",
"level": "ticket"
},
"waiting_list": {
"enabled": "true",
"level": "event"
},
"tracking_codes": [
{
"type": "code",
"value": "Google analytics"
},
{
"type": "code",
"value": "Google ads"
},
{
"type": "code",
"value": "Facebook pixel"
}
],
"blockout_period": "1440",
"restrictions": [
{
"type": "age",
"enabled": "true",
"level": "event",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"level": "ticket",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"level": "event",
"condition": null
},
{
"type": "email",
"enabled": "true",
"level": "ticket",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
],
"occurrence": {
"type": "daily",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
}
},
"exclusions": [
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
}
],
"type": "weekly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"days": [
"Sunday",
"Monday"
]
},
"type": "monthly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"monthly_recurrence_type": "DAY_NO",
"monthly_recurrence_type": "DAY_NAME"
},
"type": "schedule",
"attributes": [
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
},
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
}
]
},
"configuration": {
"type": "venue_event",
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
},
{
"name": "order_form",
"value": {
"enabled": "true",
"list": [
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"date_format": "mm/dd/yyyy",
"minlength": "",
"maxlength": "",
"information_source": "from_each_attendees",
"option": [
"Australia",
"Bangladesh"
]
}
},
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"minlength": "",
"maxlength": "",
"information_source": "from_buyer_only",
"option": [
"Male",
"Female"
]
}
}
]
}
}
]
},
"tickets": {
"price_is_fee_inclusive": "",
"price_is_tax_inclusive": "",
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": "30"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": true,
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "percentage",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"condition": null
},
{
"type": "email",
"enabled": "true",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
},
{
"uuid": "",
"display_order": "natural",
"name": "This is a donation ticket",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "donation",
"url_digital_pass": null,
"pricing_details": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"quantity_included": "1",
"quantity_sold": "30"
},
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": ""
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
},
"enable_sell_ticket_on_venue": "false",
"pass_on_fees": "false",
"hide_ticket_until_booking_start": "false",
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket with variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "20",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "oa3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "var 1",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": "0"
},
{
"uuid": "oa3a2eec-bfa2-4975-be73-3645dfbg356y",
"variation": "var 2",
"price": "$100.00",
"quantity_included": "5",
"quantity_sold": "0"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": true,
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
}
]
},
"listing": {
"enabled": "true",
"categories": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
},
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
],
"tags": [
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
},
{
"uuid": "",
"name": "",
"description": "",
"url": "",
"image": ""
}
]
},
"sessions": {
"enabled": "true",
"session_lists": [
{
"type": "required",
"uuid": "",
"status": "active",
"name": " Session One",
"display_name": "",
"description": "",
"image": "",
"created_on": "",
"updated_on": "",
"configuration": {
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"uuid": "variation",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "1",
"name": "Single Ticket WITH Variation",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "Gold",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
},
{
"variation": "Silver",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "fixed",
"discount": "5",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
}
]
},
"session_booking_starts_on": {
"utc": "",
"local": ""
},
"session_booking_ends_on": {
"utc": "",
"local": ""
},
"session_starts_on": {
"utc": "",
"local": ""
},
"session_ends_on": {
"utc": "",
"local": ""
}
},
{
"type": "optional",
"uuid": "",
"status": "active",
"name": "Session Two (Optional)",
"display_name": "",
"description": "",
"image": "",
"created_on": "",
"updated_on": "",
"configuration": {
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
}
]
},
"tickets": {
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "1",
"name": "Single Ticket WITH Variation",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "Gold",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
},
{
"variation": "Silver",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "fixed",
"discount": "5",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
},
{
"uuid": "",
"display_order": "natural",
"name": "Group Ticket",
"description": "",
"quantity": "100",
"max_quantity_per_customer": "1",
"quantity_sold": "",
"pricing_details": [
{
"variation": "",
"price": "$300.00",
"quantity_included": "5",
"quantity_sold": ""
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"utc": "",
"local": ""
},
"discount_ends_on": {
"utc": "",
"local": ""
}
}
}
]
},
"session_booking_starts_on": {
"utc": "",
"local": ""
},
"session_booking_ends_on": {
"utc": "",
"local": ""
},
"session_starts_on": {
"utc": "",
"local": ""
},
"session_ends_on": {
"utc": "",
"local": ""
}
}
]
},
"refund": {
"available": "true",
"policy": {
"cancel_before_event_starts": "7",
"automatic": "false"
}
},
"metrics": [
{
"name": "shared_count",
"value": "304"
},
{
"name": "saved_count",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"fees": {
"currency": "",
"pass_on": "true",
"rate": [
{
"name": "eventbookings_service_fee_fixed",
"value": "0.3"
},
{
"name": "eventbookings_service_fee_percentage",
"value": "3.4"
},
{
"name": "payment_processing_fee_fixed",
"value": "0"
},
{
"name": "payment_processing_fee_percentage",
"value": "0"
}
],
"price_is_tax_inclusive": "",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
]
},
"activities": [
{
"name": "events_hosted",
"value": "304",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "revenue_earned",
"value": "50000",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "orders_received",
"value": "302",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "pages_viewed",
"value": "4,670",
"meta": {
"start_date": "",
"end_date": ""
}
},
{
"name": "tickets_sold",
"value": "302",
"meta": {
"start_date": "",
"end_date": ""
}
}
],
"interactions": {
"saves": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"shares": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
{
"uuid": "ad3a2eec-bfa2-4975-be73-2fb7ff9850fd"
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
6. DELETE /events/{uuid}
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
No data
Response
No data
7. POST /events/{uuid}/publish
Path |
|
Request Header | application/json |
Success | 200 |
Special Error |
|
Query String
None
Request
No data
Response
No data
8. POST /events/{uuid}/unpublish
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
None
Request
No data
Response
No data
9. GET /events/{uuid}/sessions
Path |
|
Request Header | application/json |
Success |
|
Special Error |
|
Query String
Parameter | Type | Allowed value | Note |
|---|---|---|---|
status | enum | draft, ready, published, live, unpublished |
|
order_by | enum | created_ascending created_descending starting name_ascending name_descending |
|
time_filter | enum | today, tomorrow, this_week, this_weekend, next_week, next_weekend, this_month, next_month, this_year, next_year Note: only one value is allowed, if multiple is provided only first one will be taken as valid input others will be discarded |
|
search_q | string | Any valid search string |
|
position |
|
|
|
rows |
|
|
|
order_by |
|
|
|
Request
No data
Response
{
"sessions": [
{
"type": "multiple-choice",
"session_lists": [
{
},
{
}
]
}
],
"pagination": {
"records": "",
"position": "",
"rows": "",
"order_by": ""
}
}
10. POST /events/{uuid}/sessions
|
Path |
|
|
Request Header |
application/json |
|
Success |
200 |
|
Special Error |
Query String
None
Request
Parameter | Type | Constrains | Validation Message |
|---|---|---|---|
name | String | Maximum 75 characters | name in session should be less than or equal to 75 characters |
description | String | Maximum 2500 characters | description in session should be less than or equal to 2500 characters |
image | File |
.jpg, .jpeg, .png |
|
session_starts_on | Datetime | DATE
TIME
|
|
session_ends_on | Datetime | Valid future date and time | If session_starts_on >= session_ends_on |
{
"name": "Session 1",
"description": "This is a session for managers",
"image": "uploads/orgs/9884089cb1834048e2290c515ee1fb2e/speakers/acbf4dfa-fd10-4050-bd28-4e8b34ae28fa.jpg",
"session_starts_on": "28/11/2022 18:45",
"session_ends_on": "28/11/2022 19:00"
}
Response
{
"events": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"status": "active",
"extended_status": [
{
"name": "publishing",
"value": "Published"
},
{
"name": "listing",
"value": "Listed"
},
{
"name": "live",
"value": "false"
},
{
"name": "ended",
"value": "false"
},
{
"name": "suspended",
"value": "false"
},
{
"name": "cancelled",
"value": "false"
}
],
"name": "Venue Event",
"display_name": "",
"description": "",
"banner": [
{
"name": "",
"image": "",
"primary": "false"
},
{
"name": "",
"image": "",
"primary": "true"
}
],
"resources": [
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "video"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "image"
},
{
"name": "content",
"value": []
}
],
[
{
"name": "uuid",
"value": ""
},
{
"name": "order",
"value": 1
},
{
"name": "type",
"value": "text"
},
{
"name": "content",
"value": []
}
]
],
"links": [
{
"name": "website",
"value": "https://john.doe/"
},
{
"name": "facebook",
"value": "https://john.doe/"
},
{
"name": "instagram",
"value": "https://john.doe/"
},
{
"name": "twitter",
"value": "https://john.doe/"
},
{
"name": "linkedin",
"linkedin": "https://john.doe/li"
}
],
"timezone": "",
"currency": "",
"enable_datetime_conversion": "false",
"tax": [
{
"name": "code",
"value": "GST"
},
{
"name": "rate",
"value": "10"
}
],
"created_on": "",
"updated_on": "",
"attending_on": [
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
},
{
"local": "2024-07-09 12:30",
"utc": "2024-06-09 23:00"
}
],
"org": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "Web Mascot",
"slug": "webalive",
"info": "",
"image": "a916c022-c65a-47c8-8ef2-82371ff63823",
"metrics": [
{
"name": "followed_by_me",
"value": "304"
},
{
"name": "follows_me",
"value": "901"
},
{
"name": "review_count",
"value": "53"
},
{
"name": "review_rating_average",
"value": "3.1"
}
],
"interactions": {
"preferences": [
{
"name": "allow_people_to_contact_my_organisation",
"value": "true"
},
{
"name": "allow_people_to_follow_my_organisation",
"value": "true"
}
],
"follows": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"followed_by": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
},
"mutes": {
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"created_on": "",
"updated_on": ""
}
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": "true",
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"merchandise": {
"products": [
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "T-shirt",
"code": "TS-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 5,
"min_qty_per_order": 1,
"created_on": "",
"updated_on": ""
},
{
"uuid": "6d3a2eu43-bfa2-4975-be73-2fb7ff9850fd",
"name": "Coffee",
"code": "C-00009",
"price": 2.00,
"description": "",
"images": "photo_path",
"qty_available": 100,
"max_qty_per_order": 10,
"min_qty_per_order": 3,
"created_on": "",
"updated_on": ""
}
]
},
"event_settings_reviewed": false,
"settings": {
"booking_starts_on": {
"immediately": "true",
"utc": "",
"local": "datetime",
"hide_ticket_until_booking_start": "true",
"level": "ticket"
},
"booking_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": "datetime",
"level": "event"
},
"event_capacity": 0,
"terminology": "registration",
"enable_guest_checkout": "true",
"enable_share": "false",
"digital_pass": {
"enabled": "true",
"level": "ticket"
},
"discount": {
"enabled": "true",
"level": "event"
},
"coupon": {
"enabled": "true",
"level": "event"
},
"service_charge": {
"enabled": "true",
"level": "event"
},
"boxoffice": "",
"sell_session_individually": {
"enabled": "true",
"level": "event"
},
"sell_tickets_on_venue": {
"enabled": "true",
"level": "event"
},
"special_instruction": {
"enabled": "true",
"level": "ticket"
},
"waiting_list": {
"enabled": "true",
"level": "event"
},
"tracking_codes": [
{
"type": "code",
"value": "Google analytics"
},
{
"type": "code",
"value": "Google ads"
},
{
"type": "code",
"value": "Facebook pixel"
}
],
"blockout_period": "1440",
"restrictions": [
{
"type": "age",
"enabled": "true",
"level": "event",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"level": "ticket",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"level": "event",
"condition": null
},
{
"type": "email",
"enabled": "true",
"level": "ticket",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
],
"occurrence": {
"type": "daily",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
}
},
"exclusions": [
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
},
{
"utc": "",
"local": "event_excluding_time"
}
],
"type": "weekly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"days": [
"Sunday",
"Monday"
]
},
"type": "monthly",
"attributes": {
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60,
"occurrence_ends": {
"type": "specific_date",
"value": {
"utc": "",
"local": ""
},
"type": "number_of_event",
"value": 10
},
"monthly_recurrence_type": "DAY_NO",
"monthly_recurrence_type": "DAY_NAME"
},
"type": "schedule",
"attributes": [
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
},
{
"starts_on": {
"utc": "",
"local": ""
},
"event_duration": 60
}
]
},
"configuration": {
"type": "venue_event",
"attributes": [
{
"name": "venue",
"value": {
"name": "",
"image": "",
"url": "",
"latitude": "",
"longitude": "",
"address": {
"address_line1": "Suite 910",
"address_line2": "9 Yarra St",
"country": "Australia",
"state": "Victoria",
"city": "South Yarra",
"post_code": "3141"
}
}
},
{
"name": "order_form",
"value": {
"enabled": "true",
"list": [
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"date_format": "mm/dd/yyyy",
"minlength": "",
"maxlength": "",
"information_source": "from_each_attendees",
"option": [
"Australia",
"Bangladesh"
]
}
},
{
"field_name": "",
"ticket": [],
"field_def": {
"label": "",
"type": "string",
"mandatory": "true",
"placeholder": "",
"instruction": "",
"minlength": "",
"maxlength": "",
"information_source": "from_buyer_only",
"option": [
"Male",
"Female"
]
}
}
]
}
}
]
},
"tickets": {
"price_is_fee_inclusive": "",
"price_is_tax_inclusive": "",
"levels": [
{
"uuid": "",
"display_order": "natural",
"name": "Single Ticket WITHOUT Variation",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,
"category": "ticket",
"url_digital_pass": null,
"pricing_details": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"variation": "",
"price": "$30.0",
"quantity_included": "1",
"quantity_sold": "30"
}
],
"early_bird_discount": {
"discount_type": "percentage",
"discount": "20",
"discount_starts_on": {
"immediately": true,
"utc": "",
"local": ""
},
"discount_ends_on": {
"continue_until_event_ends": "false",
"utc": "",
"local": ""
}
},
"coupons": [
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "fixed",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
},
{
"uuid": "6d3a2eec-bfa2-4975-be73-2fb7ff9850fd",
"name": "",
"code": "",
"discount_amount": "",
"discount_type": "percentage",
"starts_on": {
"utc": "",
"local": ""
},
"ends_on": {
"utc": "",
"local": ""
},
"uses_per_coupon": 0,
"total_used": 0,
"uses_per_customer": 0,
"status": 0
}
],
"settings": {
"booking_starts_on": {
"immediately": "true",
"hide_ticket_until_booking_start": "false",
"utc": "",
"local": "datetime"
},
"booking_ends_on": {
"continue_until_event_ends": "true",
"utc": "",
"local": "datetime"
},
"enable_sell_ticket_on_venue": "false",
"price_included_service_charge": "true",
"enable_digital_pass": 0,
"enable_waiting_list": "false",
"restrictions": [
{
"type": "age",
"enabled": "true",
"condition": {
"max": 20
}
},
{
"type": "invitation_code",
"enabled": "true",
"condition": {
"code": "DKDH-8376"
}
},
{
"type": "invitation_link",
"enabled": "true",
"condition": null
},
{
"type": "email",
"enabled": "true",
"condition": {
"contact_list": [
"b973df04-371b-11ed-939a-4ed2bbcd2e26",
"c973df04-371b-11ed-939a-4ed2bbcd2e26"
]
}
}
]
},
"ticket_instruction": "",
"custom_attributes": [
{
"name": "",
"value": ""
},
{
"name": "",
"value": ""
}
]
},
{
"uuid": "",
"display_order": "natural",
"name": "This is a donation ticket",
"description": "",
"quantity": "50",
"max_quantity_per_customer": 1,
"quantity_sold": "30",
"status": 0,
"session_id": 0,
"parent_id": 0,