Introduction
This section contains basic concepts such as Authentication, Authorization and Pagination. Eventtia's API v3 is mostly compliant with the JSON API v1.0 specification.
Authentication via Username and Password
To authenticate, use this code:
# Get your token for further authorization
curl 'https://connect.eventtia.com/api/v3/auth' \
-X POST \
-H 'Content-Type: application/json' \
-d '{"email":"email@example.org", "password":"myPassword"}'
// Get your token for further authorization
fetch('https://connect.eventtia.com/api/v3/auth', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({
email: 'email@example.org',
password: 'myPassword'
})
})
Example of a successful (200) response:
{
"auth_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJjbGFzcyI6IlVzZXIiLCJhdXRoZW50aWNhdGlvbl9rZXkiOiJ0ZXN0QGV2ZW50dGlhLmNvbSIsImV2ZW50X3VyaSI6InRlc3QtZXZlbnQiLCJleHAiOjE1MjAzNTY1MDB9.s0m351gn4tuRe4sdF_qw3rTleleWh4TTTt35f1n4lLy",
"username": "Jon Doe"
}
Example of a 401 response:
{"message":"Wrong username or password."}
You can get an authorization token for a User with this endpoint. Tokens issued by Eventtia are valid for 30 days.
HTTP Request
POST /api/v3/auth
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| string | The User's email. | |
| password | string | The User's password. |
Authorization
When you make a request to any protected endpoint, add the token in the Authorization header
# Send your token in the Authorization header
curl '<api endpoint>' \
-H 'Authorization: Bearer <your token>' \
...
// Send your token in the Authorization header
fetch('<api endpoint>', {
headers: {
'Authorization': 'Bearer <your token>',
},
...
})
Make sure you replace
<your token>with the JWT you get when you authenticate.
Eventtia uses JSON Web Tokens for authorization. Tokens issued by Eventtia are valid for 30 days.
Pagination
You can request a specific page size and number by sending the
pageparam in the request query params:
curl '<api endpoint>?page[size]=12&page[number]=1'
fetch('<api endpoint>?page[size]=12&page[number]=1')
Example response:
{
"data": [...],
"links": {
"self": "<api endpoint>?page[number]=1&page[size]=12",
"first": "<api endpoint>?page[number]=1&page[size]=12",
"prev": null,
"next": null,
"last": "<api endpoint>?page[number]=1&page[size]=12"
},
"meta": {
"total_pages": 1
}
}
All list endpoints are paginated by default. The default page size is 24, and the default page number is 1. The response contains links to the first, previous (prev), current (self), next and last pages. For convenience, a total_pages meta field, which contains the total number of pages given the current query parameters, is included as well.
Included resources
You can request the attributes for related entities by sending the
includeparam in the request query params:
curl '<api endpoint>?include=rel1.nested_rel,rel2'
fetch('<api endpoint>?include=rel1.nested_rel,rel2')
Example response:
{
"data": [...],
"included": [
{"id": "123", "type": "rel1", "attributes": {...}},
...
]
}
Some endpoints allow you to retrieve the data of related entities. The response contains the included section when you request the data or when other resources are included by default. See each endpoint's description for the list of available additional resources.
Errors
| Status | Meaning |
|---|---|
| 400 | Bad Request -- Your request is invalid. |
| 401 | Unauthorized -- Your token is invalid or not present. |
| 403 | Forbidden -- Your token doesn't grant you access to this resurce. |
| 404 | Not Found. |
| 500 | Internal Server Error -- We had a problem with our server. Try again later. |
| 503 | Service Unavailable -- We're temporarily offline for maintenance. Please try again later. |
Events
List of Events
curl 'https://connect.eventtia.com/api/v3/events' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": [
{
"id": "1234",
"type": "events",
"attributes": {
"name": "Test Event",
"event_uri": "test-event-1",
"start_date": "2017-10-13T08:00:00.000-05:00",
"end_date": "2017-10-15T18:00:00.000-05:00",
"logo": {
"filename": "testlogo123.png",
"thumb": "https://s3.amazonaws.com/eventtia/event_logos/1234/thumb/testlogo123.png?1493070482",
"small": "https://s3.amazonaws.com/eventtia/event_logos/1234/thumb2x/testlogo123.png?1493070482",
"medium": "https://s3.amazonaws.com/eventtia/event_logos/1234/medium/testlogo123.png?1493070482",
"large": "https://s3.amazonaws.com/eventtia/event_logos/1234/large/testlogo123.png?1493070482"
},
"coordinates": {
"lat": 6.15384,
"lng": -75.533
},
"address": "Indiana",
"google_analytics_tracking_code": "testGA",
"google_tag_manager_tracking_code": "testGTAG"
}
},
{
"id": "1234",
"type": "events",
"attributes": {
"name": "Second Event",
"event_uri": "second-event-2018",
"start_date": "2018-01-24T08:00:00.000-05:00",
"end_date": "2018-04-04T18:00:00.000-05:00",
"logo": {
"filename": "second222.png",
"thumb": "https://s3.amazonaws.com/eventtia/event_logos/2468/thumb/second222.png?1502322788",
"small": "https://s3.amazonaws.com/eventtia/event_logos/2468/thumb2x/second222.png?1502322788",
"medium": "https://s3.amazonaws.com/eventtia/event_logos/2468/medium/second222.png?1502322788",
"large": "https://s3.amazonaws.com/eventtia/event_logos/2468/large/second222.png?1502322788"
},
"coordinates": {
"lat": null,
"lng": null
},
"address": "Some place",
"google_analytics_tracking_code": "",
"google_tag_manager_tracking_code": "GTM-secondTestCode"
}
}
],
"links": {
"self": "https://connect.eventtia.com/api/v3/events/?page%5Bnumber%5D=1&page%5Bsize%5D=24",
"first": "https://connect.eventtia.com/api/v3/events/?page%5Bnumber%5D=1&page%5Bsize%5D=24",
"prev": null,
"next": null,
"last": "https://connect.eventtia.com/api/v3/events/?page%5Bnumber%5D=1&page%5Bsize%5D=24"
},
"meta": {
"total_pages": 1
}
}
This endpoint returns the list of events for the User indicated in the JWT.
HTTP Request
GET /api/v3/events
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| updated_since | date | A datetime in the following format: 2019-12-31T14:25:46.000-05:00, or part of it: 2019-12. |
| templates | boolean | Send true if you want to get only template events |
| template | number | The id of a specific template to get all the events cloned from it |
| name | string | Exact name or part of the event name for which you want to search |
| search_custom_fields | object | Value of the event custom field for which you want to search events. Eg search_custom_fields[312341]. The format of the value depends on the field type, it could be a String or an Array. |
| city_id | number | The id of the city for which you want to search the events |
| country_id | number | The id of the country for which you want to search the events |
List of Events Slim
This endpoint allows you to fetch a list of events in a slim format. You can customize the response by using various query parameters.
curl --location 'https://connect.eventtia.com/api/v3/events/slim' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <your token>' \
--data '{
}'
fetch('https://connect.eventtia.com/api/v3/slim', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": [
{
"id": "12345",
"type": "events",
"attributes": {
"start_date": "2023-09-20T06:00:00.000Z",
"end_date": "2023-09-21T03:00:00.000Z",
"created_at": "2023-05-18T13:10:25.000Z",
"updated_at": "2023-05-18T13:11:49.000Z",
"registration_start_date": null,
"registration_end_date": null,
"name": "Event Test",
"latitude": null,
"longitude": null,
"timezone": "Europe/Amsterdam",
"banner_image": {},
"address_details": null,
"city_id": 106297,
"custom_fields_data": {}
}
}
],
"links": {
"self": "https://connect.eventtia.com/api/v3/events/slim?page%5Bnumber%5D=1&page%5Bsize%5D=100",
"first": "https://connect.eventtia.com/api/v3/events/slim?page%5Bnumber%5D=1&page%5Bsize%5D=100",
"prev": null,
"next": "https://connect.eventtia.com/api/v3/events/slim?page%5Bnumber%5D=2&page%5Bsize%5D=100",
"last": "https://connect.eventtia.com/api/v3/events/slim?page%5Bnumber%5D=8&page%5Bsize%5D=100"
}
}
This endpoint returns the list of events for the User indicated in the JWT.
HTTP Request
GET /api/v3/events/slim
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page[number] | (optional, integer) | Specifies the page number for pagination. |
| page[size] | (optional, integer) | Defines the page size (maximum 100 per page). |
| country_id | (optional, integer) | Filters events by the country's ID. |
| city_id | (optional, integer) | Filters events by the city's ID. |
| start_date_lower_bound | (optional, string, date-time) | Sets the lower bound for the event's start date. |
| start_date_upper_bound | (optional, string, date-time) | Sets the upper bound for the event's start date. |
Create Event
curl 'https://connect.eventtia.com/api/v3/events'
fetch('https://connect.eventtia.com/api/v3/events',{
method: 'POST',
headers: {
'Authorization': 'Bearer <your token>',
},
body: data
})
Example of a successful (200) response:
{
"data": {
"id": "12345",
"type": "events",
"attributes": {
"start_date": "2021-04-20T02:00:00.000Z",
"end_date": "2021-04-20T03:00:00.000Z",
"created_at": "2023-04-18T21:22:17.250Z",
"updated_at": "2023-04-18T21:22:17.250Z",
"active": true,
"name": "Test 9",
"event_uri": "testing",
"logo": {
"filename": null,
"thumb": "/logos/thumb/missing.png",
"small": "/logos/thumb2x/missing.png",
"medium": "/logos/medium/missing.png",
"large": "/logos/large/missing.png"
},
"coordinates": {
"lat": null,
"lng": null
},
"address": "",
"timezone": "America/Bogota",
"time_format": "am_pm",
"description": "description of the event",
"default_language": "fr",
"currency": "USD",
"white_label": false,
"white_label_images": {},
"google_analytics_tracking_code": null,
"google_tag_manager_tracking_code": null,
"sender_email": "johndoe@eventtia.com",
"banner_image": {
"filename": null,
"thumb": "/banner_images/thumb/missing.png",
"small": "/banner_images/thumb2x/missing.png",
"medium": "/banner_images/medium/missing.png",
"large": "/banner_images/large/missing.png"
},
"static_map": null,
"website": "https://live.eventtia.com/fr/testing-test-event",
"is_virtual": true,
"attendance_mode": "online",
"virtual_timezone": "Europe/Paris",
"cloned_from_id": null,
"city_id": null,
"is_template": false,
"can_register_mid_workshop": false,
"iso_code": "CO",
"featured": false
},
"relationships": {...}
},
"meta": {
"api_key": "e0ab473e-751d-4bd4-82c6-ef66cfbc9728"
}
}
This endpoint allows you to create a new event.
HTTP Request
POST /api/v3/events
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | Event name. |
| start_date | datetime | A datetime in the following format "14/08/2020 - 23:00:00" |
| end_date | datetime | A datetime in the following format "14/08/2020 - 23:00:00" |
| is_virtual | boolean | True if you event is virtual |
| default_language | string | Available options es, en and fr |
| event_uri | string | Define a uri for your event website. Please do not use spaces or special characters. |
| virtual_timezone | string | The default event timezone |
| description | string | Short description of your event |
| sender_name | string | Name of the person who will appear in the communications of your event |
| sender_email | string | Email from where event communications will be sent |
| active | boolean | This value allows you to indicate if your event is active or inactive |
| custom_fields_data | Object | field_id: field value eg {"692349"=>"Field value here"}} |
Event
curl 'https://connect.eventtia.com/api/v3/events/test-event-1'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1',{
method: 'GET',
headers: {
'Authorization': 'Bearer <your token>',
},
body: data
})
Example of a successful (200) response:
{
"data": {
"id": "54321",
"type": "events",
"attributes": {
"start_date": "2021-09-06T14:00:00.000Z",
"end_date": "2021-09-10T15:00:00.000Z",
"created_at": "2021-09-06T14:30:06.000Z",
"updated_at": "2021-09-06T14:30:06.000Z",
"active": true,
"name": "FirstTest",
"event_uri": "firsttest",
"logo": {
"filename": null,
"thumb": "/logos/thumb/missing.png",
"small": "/logos/thumb2x/missing.png",
"medium": "/logos/medium/missing.png",
"large": "/logos/large/missing.png"
},
"coordinates": {
"lat": null,
"lng": null
},
"address": "",
"timezone": "America/Bogota",
"time_format": "am_pm",
"description": "Testing creation of event",
"default_language": "es",
"currency": "USD",
"white_label": true,
"white_label_images": {
"logo_filename": null,
"logo": "/white_label_logos/original/missing.png",
"background_filename": null,
"background": "/white_label_backgrounds/original/missing.png"
},
"google_analytics_tracking_code": "q",
"google_tag_manager_tracking_code": "",
"sender_email": "johndoe@eventtia.com",
"banner_image": {
"filename": null,
"thumb": "/banner_images/thumb/missing.png",
"small": "/banner_images/thumb2x/missing.png",
"medium": "/banner_images/medium/missing.png",
"large": "/banner_images/large/missing.png"
},
"static_map": null,
"website": "https://live.eventtia.com/es/firsttest",
"is_virtual": true,
"attendance_mode": "online",
"virtual_timezone": "America/Bogota",
"cloned_from_id": null,
"city_id": null,
"is_template": true,
"can_register_mid_workshop": false,
"iso_code": "CO",
"featured": false,
"budget": 0.0,
"total_attendees": 0,
"api_key": "85c87c84-4f7f-4256-a55d-e1f861068347",
"fields": {}
},
"relationships": {
"attendee_types": {
"data": [...]
}
}
}
}
Example of a 404 response:
{"message": "ActiveRecord::RecordNotFound"}
This endpoint returns the event associated with the specified event_uri.
HTTP Request
GET /api/v3/events/:event_uri
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event you want to retrieve. |
Update Event
curl 'https://connect.eventtia.com/api/v3/events/test-event-1'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1',{
method: 'PUT',
headers: {
'Authorization': 'Bearer <your token>',
},
body: data
})
Example of a successful (200) response:
{
"data": {
"id": "12345",
"type": "events",
"attributes": {
"start_date": "2021-04-20T14:00:00.000Z",
"end_date": "2021-04-20T15:00:00.000Z",
"created_at": "2023-04-18T21:22:17.000Z",
"updated_at": "2023-04-19T15:59:14.559Z",
"active": true,
"name": "Test-new-name",
"event_uri": "testing-test",
"logo": {
"filename": null,
"thumb": "/logos/thumb/missing.png",
"small": "/logos/thumb2x/missing.png",
"medium": "/logos/medium/missing.png",
"large": "/logos/large/missing.png"
},
"coordinates": {
"lat": null,
"lng": null
},
"address": "",
"timezone": "America/Bogota",
"time_format": "am_pm",
"description": "description of the event",
"default_language": "fr",
"currency": "USD",
"white_label": false,
"white_label_images": {},
"google_analytics_tracking_code": null,
"google_tag_manager_tracking_code": null,
"sender_email": "johndoe@eventtia.com",
"banner_image": {
"filename": null,
"thumb": "/banner_images/thumb/missing.png",
"small": "/banner_images/thumb2x/missing.png",
"medium": "/banner_images/medium/missing.png",
"large": "/banner_images/large/missing.png"
},
"static_map": null,
"website": "https://live.eventtia.com/fr/testing-testttt",
"is_virtual": true,
"attendance_mode": "online",
"virtual_timezone": "Europe/Paris",
"cloned_from_id": null,
"city_id": null,
"is_template": false,
"can_register_mid_workshop": false,
"iso_code": "CO",
"featured": false
},
"relationships": {
"attendee_types": {
"data": [...]
},
}
}
}
This endpoint allows you to update an event for the specified event_uri.
HTTP Request
PUT /api/v3/events/:event_uri
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event you want to update. |
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | Event name. |
| start_date | datetime | A datetime in the following format "14/08/2020 - 23:00:00" |
| end_date | datetime | A datetime in the following format "14/08/2020 - 23:00:00" |
| is_virtual | boolean | True if you event is virtual |
| default_language | string | Available options es, en and fr |
| event_uri | string | Define a uri for your event website. Please do not use spaces or special characters. |
| virtual_timezone | string | The default event timezone |
| description | string | Short description of your event |
| sender_name | string | Name of the person who will appear in the communications of your event |
| sender_email | string | Email from where event communications will be sent |
| active | boolean | This value allows you to indicate if your event is active or inactive |
| custom_fields_data | Object | field_id: field value eg {"692349"=>"Field value here"}} |
Clone Event
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/clone'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/clone')
Example of a successful (200) response:
null
Example of a 404 response:
{"message": "ActiveRecord::RecordNotFound"}
This endpoint allows you to clone the event associated with the specified event_uri.
HTTP Request
POST /api/v3/events/:event_uri/clone
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event you want to clone. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| clone_zones | boolean | True if you want to clone the event zones. |
| clone_speakers | boolean | True if you want to clone the event speakers |
| clone_workshops | boolean | True if you want to clone the event workshops |
| clone_pois | boolean | True if you want to clone the event speakers |
| clone_attendee_types | boolean | True if you want to clone the event attendee types |
| clone_business_conference | boolean | True if you want to clone the event business conferences |
| clone_event_page | boolean | True if you want to clone the event page |
Event Clone Progress
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/clone-progress'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/clone-progress')
Example of a successful (200) response:
{"finished": false}
This endpoint return the clone progress for the specified event event_uri.
HTTP Request
GET /api/v3/events/:event_uri/clone-progress
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event. |
Custom Fields
curl 'https://connect.eventtia.com/api/v3/event-custom-fields'
fetch('https://connect.eventtia.com/api/v3/event-custom-fields')
Example of a successful (200) response:
{
"data": [],
"links": {...},
"meta": {...}
}
This endpoint returns the custom fields available for creating an event.
HTTP Request
GET /api/v3/event-custom-fields
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
Tickets Stats
curl 'https://connect.eventtia.com/api/v3/events/:event_uri/tickets-stats'\
-H 'Authorization: Bearer <your token>
fetch('https://connect.eventtia.com/api/v3/events/:event_uri/tickets-stats', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
[
{
"name": "Vip",
"used_seats": 4,
"seats_limit": 100
},
{
"name": "gold",
"used_seats": 1,
"seats_limit": "∞"
}
]
This endpoint returns event ticket stats which allows you to determine the availability of the current seats.
HTTP Request
GET /api/v3/events/:event_uri/tickets-stats
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event. |
Event Files
List of Files in a Category
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_file_categories/1/event_files' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_file_categories/1/event_files', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "135684",
"type": "event_files",
"attributes": {
"name": "test_file",
"description": "a file for testing",
"event_file": "link_here",
"is_image": true,
"urls": {
"thumb": "",
"small": "",
"medium": "",
"large": "",
"original": ""
},
"entity_id": null,
"entity_type": "",
"number_of_downloads": 0
},
"relationships": {...}
}
],
"links": {
"self": "https://connect.eventtia.com/api/v3/events/test_uri/event_file_categories/12345/event_files?page%5Bnumber%5D=1&page%5Bsize%5D=24",
"first": "https://connect.eventtia.com/api/v3/events/test_uri/event_file_categories/12345/event_files?page%5Bnumber%5D=1&page%5Bsize%5D=24",
"prev": null,
"next": null,
"last": "https://connect.eventtia.com/api/v3/events/test_uri/event_file_categories/12345/event_files?page%5Bnumber%5D=1&page%5Bsize%5D=24"
},
"meta": {
"total_pages": 1
}
}
This endpoint returns the list of event files associated with the corresponding event and category.
HTTP Request
GET /api/v3/events/:event_uri/event_file_categories/:event_file_category_id/event_files
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the event file category. |
| event_file_category_id | number | The ID of the event file category you want to retrieve. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
Uploading a File
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_file_categories/1/event_files' \
-X POST \
-H 'Authorization: Bearer <your token>' \
-H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary50m3NumB3r' \
-F 'event_file[name]=name' \
-F 'event_file[description]=description' \
-F 'event_file[event_file]=@/path/to/file.pdf'
const file = document.getElementById('input-id').files[0]; // 'input-id' here should be the id of the file input in your HTML
const data = new FormData();
data.append('event_file[name]', 'name');
data.append('event_file[description]', 'optional description');
data.append('event_file[event_file]', file, file.name);
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_file_categories/1/event_files', {
method: 'POST',
headers: {
'Authorization': 'Bearer <your token>',
},
body: data
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (201) response:
{
"data": {
"id": "234876",
"type": "event_files",
"attributes": {
"name": "test-file",
"description": "description of this file",
"event_file": "link_file",
"is_image": true,
"urls": {
"thumb": "",
"small": "",
"medium": "",
"large": "",
"original": ""
},
"entity_id": null,
"entity_type": null,
"number_of_downloads": 0
},
"relationships": {
"event": {
"data": {
"id": "74562",
"type": "events"
}
},
"event_file_category": {
"data": {
"id": "23468",
"type": "event_file_categories"
}
}
}
}
}
This endpoint uploads a file in the corresponding category.
HTTP Request
POST /api/v3/events/:event_uri/event_file_categories/:event_file_category_id/event_files
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the event file category. |
| event_file_category_id | number | The ID of the event file category in which the file will be found once uploaded. |
Body Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| event_file[name] | string | false | The name of the file. |
| event_file[description] | string | true | Description of the file. |
| event_file[event_file] | file | false | The file to upload. |
Business Conferences
List of Business Conferences
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "12345",
"type": "business_conferences",
"attributes": {
"start_date": "2023-02-10T14:00:00.000Z",
"end_date": "2023-02-16T14:00:00.000Z",
"created_at": "2023-02-08T19:15:07.000Z",
"updated_at": "2023-02-13T14:04:23.000Z",
"scheduling_starts_on": "2023-02-09T15:00:00.000Z",
"booking_deadline_date": "2023-02-16T14:00:00.000Z",
"name": "Networking test",
"event_id": 43678,
"location": "Virtual",
"meeting_duration": null,
"mail_sender_name": "Demo networking",
"limit_amount_of_scheduled_meetings_per_slot": 1,
"meeting_rejection_enabled": true,
"meeting_rejection_description_options": [
"i cant, i have another meeting",
"i cant, need to go for a hurry"
],
"automatic_scheduling": false,
"automatic_scheduling_settings": null,
"rated_show_participant_agendas": true,
"blacklist_enabled": false,
"blacklist_settings": {},
"neo4j_sync": null,
"enable_meetings_evaluation": false,
"enable_categories": false,
"is_virtual": false,
"total_accepted_meetings": 0,
"total_requested_meetings": 0,
"total_rejected_meetings": 0,
"max_repeated_meetings": 1,
"show_only_confirmed": false
},
"relationships": {
"business_conference_participant_types": {
"data": [
{
"id": "12345",
"type": "business_conference_participant_types"
}
]
},
"business_conference_categories": {
"data": []
}
}
}
],
"included": [
{
"id": "12345",
"type": "business_conference_participant_types",
"attributes": {
"name": "Sellers",
"profile_extra_fields": {},
"required_logo": false,
"enable_categories_offering": false,
"enable_categories_looking_for": false,
"can_block_time_slots": true,
"updated_at": "2023-02-08T14:18:52.000-05:00",
"agenda": {
"1676037600": [
"2023-02-10 09:00:00",
"2023-02-10 09:25:00",
232039
],
},
"can_schedule_last_minute_meetings": false,
"can_request_meeting_to_attendee_types": [],
"show_contact_info": true,
"rejection_enabled": true
},
"relationships": {
"business_conference_profile_fields": {
"data": []
},
"attendee_types": {
"data": [
{
"id": "123456",
"type": "attendee_types"
}
]
},
"business_conference": {
"data": {
"id": "12345",
"type": "business_conferences"
}
},
"survey": {
"data": null
}
}
},
{
"id": "12345",
"type": "business_conference_participant_types",
"attributes": {
"name": "Buyers",
"profile_extra_fields": {},
"required_logo": false,
"enable_categories_offering": false,
"enable_categories_looking_for": false,
"can_block_time_slots": false,
"updated_at": "2023-02-08T14:19:09.000-05:00",
"agenda": {
"1676037600": [
"2023-02-10 09:00:00",
"2023-02-10 09:25:00",
232039
],
},
"can_schedule_last_minute_meetings": false,
"can_request_meeting_to_attendee_types": [],
"show_contact_info": true,
"rejection_enabled": true
},
"relationships": {
"business_conference_profile_fields": {
"data": []
},
"attendee_types": {
"data": [
{
"id": "101224",
"type": "attendee_types"
}
]
},
"business_conference": {
"data": {
"id": "16758",
"type": "business_conferences"
}
},
"survey": {
"data": null
}
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of business conferences for an event along with their participant types.
HTTP Request
GET /api/v3/events/:event_uri/business_conferences
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the business conference. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| updated_since | date | A datetime in the following format: 2019-12-31T14:25:46.000-05:00, or part of it: 2019-12. |
List of Business Conference Participant Types
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types')
Example of a successful (200) response:
{
"data": [
{
"id": "12345",
"type": "business_conference_participant_types",
"attributes": {
"name": "Sellers",
"profile_extra_fields": {},
"required_logo": false,
"enable_categories_offering": false,
"enable_categories_looking_for": false,
"can_block_time_slots": true,
"updated_at": "2023-02-08T14:18:52.000-05:00",
"agenda": {
"1234567890": [
"2023-02-10 09:00:00",
"2023-02-10 09:25:00",
232039
],
},
"can_schedule_last_minute_meetings": false,
"can_request_meeting_to_attendee_types": [],
"show_contact_info": true,
"rejection_enabled": true
},
"relationships": {
"business_conference_profile_fields": {
"data": []
},
"attendee_types": {...}
}
},
],
"included": [
{
"id": "123456",
"type": "attendee_types",
"attributes": {
"name": "VIP",
"attendance_mode": "mixed",
"price": 5.0,
"price_end_date": "2023-02-14T23:59:59.000-05:00",
"description": "VIP tickets to get extra benefit",
"capacity": 15,
"availability": 13,
"order": 2,
"price_without_vat": 5.0,
"confirmation_required": false,
"updated_at": "2023-02-08T14:47:04.000-05:00",
"valid_if_no_payments": false
},
"relationships": {
"attendee_type_custom_fields": {
"data": [
{
"id": "1234567",
"type": "attendee_type_custom_fields"
}
]
},
"business_conference_participant_type": {
"data": {
"id": "12345",
"type": "business_conference_participant_types"
}
}
}
},
{
"id": "1234567",
"type": "attendee_type_custom_fields",
"attributes": {...},
"relationships": {
"attendee_type": {
"data": {
"id": "123456",
"type": "attendee_types"
}
}
}
},
],
"meta": {...}
}
This endpoint returns the list of participant types for a business conference, along with the associated attendee types and the custom fields for both the participant types and the attendee types.
HTTP Request
GET /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participant_types
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the business conference. |
| business_conference_id | string | The ID of the business conference. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
List of Business Conference Participant Type Unavailable Hours
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours')
Example of a successful (200) response:
{
"data": [
{
"id": "1234",
"type": "business_conference_participant_type_unavailable_hours",
"attributes": {
"start_date": "2023-02-10T09:00:00.000-05:00",
"end_date": "2023-02-13T12:25:00.000-05:00"
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of unavailable hours for a business conference participant type.
HTTP Request
GET /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participant_types/:business_conference_participant_type_id/unavailable_hours
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the business conference. |
| business_conference_id | Integer | The ID of the business conference. |
| business_conference_participant_type_id | Integer | The ID of the business conference participant type. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
Create Business Conference Participant Type Unavailable Hour
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours')
Example of a successful (200) response:
{
"data": {
"id": "1234",
"type": "business_conference_participant_type_unavailable_hours",
"attributes": {
"start_date": "2023-02-11T09:00:00.000-05:00",
"end_date": "2023-02-11T11:00:00.000-05:00"
}
}
}
This endpoint allows you to create a new unavailable hour for a business conference participant type
HTTP Request
POST /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participant_types/:business_conference_participant_type_id/unavailable_hours
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the business conference. |
| business_conference_id | Integer | The ID of the business conference. |
| business_conference_participant_type_id | Integer | The ID of the business conference participant type. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| start_date | datetime | Restriction start date. Eg. 10/12/2020 - 01:00 |
| end_date | datetime | Restriction end date. Eg. 10/12/2020 - 01:00 |
Update Business Conference Participant Type Unavailable Hour
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours/1'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours/1')
Example of a successful (200) response:
{
"data": {
"id": "1234",
"type": "business_conference_participant_type_unavailable_hours",
"attributes": {
"start_date": "2023-02-11T09:30:00.000-05:00",
"end_date": "2023-02-11T11:30:00.000-05:00"
}
}
}
This endpoint allows you to update a unavailable hour for a business conference participant type
HTTP Request
PUT /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participant_types/:business_conference_participant_type_id/unavailable_hours/:id
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the business conference. |
| business_conference_id | Integer | The ID of the business conference. |
| business_conference_participant_type_id | Integer | The ID of the business conference participant type. |
| id | Integer | The ID of the business conference participant type unavailable hour. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| start_date | datetime | Restriction start date. Eg. 10/12/2020 - 01:00 |
| end_date | datetime | Restriction end date. Eg. 10/12/2020 - 01:00 |
Destroy Business Conference Participant Type Unavailable Hour
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours/1'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participant_types/1/unavailable_hours/1')
Example of a successful (200) response:
{
"data": {
"id": "1234",
"type": "business_conference_participant_type_unavailable_hours",
"attributes": {
"start_date": "2023-02-11T09:10:00.000-05:00",
"end_date": "2023-02-11T11:10:00.000-05:00"
}
}
}
This endpoint allows you to destroy a unavailable hour for a business conference participant type
HTTP Request
DELETE /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participant_types/:business_conference_participant_type_id/unavailable_hours/:id
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the business conference. |
| business_conference_id | Integer | The ID of the business conference. |
| business_conference_participant_type_id | Integer | The ID of the business conference participant type. |
| id | Integer | The ID of the business conference participant type unavailable hour. |
List of Participants
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participants?participant_type_id=13' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participants?participant_type_id=13', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "1234567",
"type": "business_conference_participants",
"attributes": {
"business_conference_id": 12345,
"participant_type_id": 12345,
"event_account_id": null,
"attendee_id": 1234567,
"participant_type_name": "Sellers",
"profile_display_name": "Eventtia",
"profile_contact_name": "John Doe",
"profile_contact_email": "johndoe@eventtia.com",
"job_title": "Developer",
"telephone": "+571234567890",
"public_registration": false,
"logo": {
"filename": null,
"thumb": "/logos/thumb/missing.png",
"small": "/logos/thumb2x/missing.png",
"medium": "/logos/medium/missing.png",
"large": "/logos/large/missing.png"
},
"profile_extra_fields": {},
"blocked_slots": [
"1676037600"
],
"updated_at": "2023-04-19T12:43:03.000-05:00"
},
"relationships": {...}
},
],
"included": [
{
"id": "1234567",
"type": "attendees",
"attributes": {
"created_at": "2023-02-07T16:48:37.000Z",
"updated_at": "2023-03-13T20:04:56.000Z",
"uuid": "248c29",
"fields": {
"1466264": "John",
"1466265": "Doe",
"1466266": "johndoe@eventtia.com",
"1466267": "Eventtia",
"1466268": "+57123456789",
"1466269": null,
"1466270": "Developer",
"1466271": {
"filename": "filename.jpg",
"thumb": "",
"small": "",
"medium": "",
"large": "",
"original": ""
},
"1466272": null,
"1466273": "1998-09-20",
"1466274": "America/Bogota"
},
"status": "confirmed",
"paid": true,
"checked_in": true,
"checked_in_date": "2023-02-07T11:52:02.000-05:00",
"qr_code": "277c29|John Doe|johndoe@eventtia.com|Eventtia - Developer|+571234567890",
"can_schedule_meetings": true
},
"relationships": {...}
}
],
}
This endpoint returns the list of participants for a business conference, possibly filtered by type. It also returns the business_conference_profile_fields, attendees and attendee_type_custom_fields. Each participant has one attendee and zero or more business conference profile fields, which describe the participant's profile extra fields (name of the field, possible values, etc.). Each attendee has a set of attendee type custom fields, which include six default fields (first_name, last_name, email, company, telephone, city_id) and zero or more non-default fields listed under the attendee's custom_fields attribute.
HTTP Request
GET /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participants
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the business conference. |
| business_conference_id | number | The ID of the desired business conference. |
Query Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| page | json | true | A page object as described here. |
| participant_type_id | number | true | The ID of the type you want to use to filter the participants. |
| updated_since | date | true | A datetime in the following format: 2019-12-31T14:25:46.000-05:00, or part of it: 2019-12. |
Participant Agenda
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participants/456/agenda' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_participants/456/agenda', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [...],
"links": {...},
"meta": {
"agenda": {
"1676037600": [
"2023-02-10 09:00:00",
"2023-02-10 09:25:00",
232039
],
"1676039400": [
"2023-02-10 09:30:00",
"2023-02-10 09:55:00",
232040
]
},
"blocked_slots": [
"1676037600",
"1676037600"
],
"meeting_statuses": {
"requested": 1,
"accepted": 2,
"rejected": 3,
"expired": 4
}
}
}
This endpoint returns the list of meetings for a participant and the data for all participants involved in the meetings (for more info on the participant attributes listed here, take a look at the List of Participants endpoint). In addition, the meta information section includes a list of slots for the participant type (agenda) and a list of slots in which the participant won't be available (blocked_slots).
The agenda is an object in which the keys are the UNIX Epoch time for the slot's start date, and the values are arrays with the start and end dates for each slot. The blocked_slots are an array of agenda keys.
HTTP Request
GET /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_participants/:participant_id/agenda
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the business conference. |
| business_conference_id | number | The ID of the associated business conference. |
| participant_id | number | The ID of the desired participant. |
Query Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| page | json | true | A page object as described here. |
Meetings in a Business Conference
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_meetings' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/business_conferences/1/business_conference_meetings', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "1234567",
"type": "business_conference_meetings",
"attributes": {
"start_date": "2023-02-10T19:00:00.000Z",
"end_date": "2023-02-10T19:25:00.000Z",
"created_at": "2023-02-10T16:30:12.000Z",
"updated_at": "2023-02-10T17:00:11.000Z",
"business_conference_id": 12345,
"status": 3,
"start_date_seconds": null,
"end_date_seconds": null,
"user_message": "i request a meeting",
"source": 3,
"guid": "cf2cd43f-5f5a-462f-b7c3-89e6053d38e1",
"location": " 1",
"rejection_description": "i cant, i have another meeting",
"shared_participant_ids": {},
"meeting_type": "booked",
"demodesk_link": null,
"demodesk_id": null,
"slot_id": 123456,
"is_virtual": false,
"host_attended": false,
"participant_attended": false,
"participant_attendance_mode": null,
"host_attendance_mode": null
},
"relationships": {...}
}
],
"included": [
{
"id": "1234567",
"type": "business_conference_participants",
"attributes": {
"business_conference_id": 12345,
"participant_type_id": 12345,
"event_account_id": null,
"attendee_id": 1234567,
"participant_type_name": "Sellers",
"profile_display_name": "Eventtia",
"profile_contact_name": "Daniel Attendee Test",
"profile_contact_email": "test10001@exampleeventtia.com",
"job_title": "",
"telephone": "+1201666203",
"public_registration": false,
"logo": {
"filename": null,
"thumb": "/logos/thumb/missing.png",
"small": "/logos/thumb2x/missing.png",
"medium": "/logos/medium/missing.png",
"large": "/logos/large/missing.png"
},
"profile_extra_fields": {},
"blocked_slots": [],
"updated_at": "2023-02-13T09:20:15.000-05:00"
},
"relationships": {...}
},
{
"id": "7654321",
"type": "business_conference_participants",
"attributes": {
"business_conference_id": 54321,
"participant_type_id": 54321,
"event_account_id": null,
"attendee_id": 1234567,
"participant_type_name": "Buyers",
"profile_display_name": "Eventtia",
"profile_contact_name": "John Doe",
"profile_contact_email": "johndoe@eventtia.com",
"job_title": "Dev",
"telephone": "+57123456789",
"public_registration": false,
"logo": {
"filename": null,
"thumb": "/logos/thumb/missing.png",
"small": "/logos/thumb2x/missing.png",
"medium": "/logos/medium/missing.png",
"large": "/logos/large/missing.png"
},
"profile_extra_fields": {},
"blocked_slots": [
"1676037600",
"1676037600"
],
"updated_at": "2023-04-19T12:43:03.000-05:00"
},
"relationships": {...}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of meetings for a business conference along with the associated participants (for more info on the participant attributes listed here, take a look at the List of Participants endpoint).
HTTP Request
GET /api/v3/events/:event_uri/business_conferences/:business_conference_id/business_conference_meetings
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the business conference. |
| business_conference_id | number | The ID of the desired business conference. |
Query Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| page | json | true | A page object as described here. |
For more info on the possible values for a meeting's status or source, take a look at the Participant Agenda endpoint.
Attendee Types
List of Attendee Types
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendee_types' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendee_types', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": [
{
"id": "123456",
"type": "attendee_types",
"attributes": {
"name": "General Public",
"attendance_mode": "mixed",
"price": 0.0,
"price_end_date": "2023-02-14T23:59:59.000-05:00",
"description": "",
"capacity": null,
"availability": 0,
"order": 1,
"price_without_vat": 0.0,
"confirmation_required": false,
"updated_at": "2023-02-08T14:47:04.000-05:00",
"valid_if_no_payments": true
},
"relationships": {
"attendee_type_custom_fields": {
"data": [
{
"id": "1234567",
"type": "attendee_type_custom_fields"
}
]
},
"business_conference_participant_type": {
"data": {
"id": "12345",
"type": "business_conference_participant_types"
}
}
}
}
],
"included": [
{
"id": "1234567",
"type": "attendee_type_custom_fields",
"attributes": {
"name": "first_name",
"alias": null,
"required": true,
"default": true,
"input_type": 1,
"values": null,
"display": true,
"max_chars": 0,
"validations": null,
"value_limited": 0,
"lower_bound": null,
"upper_bound": null,
"options": null,
"include_time": null,
"order": 1,
"available_public_listings": true,
"filterable": false,
"updated_at": "2023-02-07",
"internal_id": null,
"use_radio_buttons": false,
"edit_admin_only": false
},
"relationships": {
"attendee_type": {
"data": {
"id": "123456",
"type": "attendee_types"
}
}
}
},
],
"meta": {
"total_pages": 1
}
}
This endpoint returns the list of attendee types for an event along with their custom fields.
HTTP Request
GET /api/v3/events/:event_uri/attendee_types
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. The attendee_type_custom_fields are included by default. |
Attendees
List of Attendees
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": [
{
"id": "12345678",
"type": "attendees",
"attributes": {
"created_at": "2023-02-07T16:48:37.000Z",
"updated_at": "2023-03-13T20:04:56.000Z",
"uuid": "288c39",
"fields": {
"1466264": "John",
"1466265": "Doe",
"1466266": "johndoe@eventtia.com",
"1466267": "Eventtia",
"1466268": "+57123456789",
"1466269": null,
"1466270": "Developer",
"1466271": {
"filename": "filename.jpg",
"thumb": "",
"small": "",
"medium": "",
"large": "",
"original": ""
},
"1466272": null,
"1466273": "1996-08-26",
"1466274": "America/Bogota"
},
"status": "confirmed",
"paid": true,
"checked_in": true,
"checked_in_date": "2023-02-07T11:52:02.000-05:00",
"qr_code": "288c22|John Doe|johndoe@eventtia.com|Eventtia - Developer|+57123456789",
"can_schedule_meetings": true
},
"relationships": {
"attendee_type": {
"data": {
"id": "123456",
"type": "attendee_types"
}
},
"attendee_type_custom_fields": {
"data": [
{
"id": "1466264",
"type": "attendee_type_custom_fields"
}
]
},
"business_conference_participants": {
"data": [
{
"id": "1234567",
"type": "business_conference_participants"
}
]
}
}
}
],
"meta": {
"total_pages": 1,
"total_attendees": 1
}
}
This endpoint returns the list of attendees for an event along with their attendee type (attendee_type) and custom field details (attendee_type_custom_fields), if requested via the include param. Authorization in this endpoint is optional; if you don't send an Authorization header, the response will only contain custom fields marked as available in public listings.
HTTP Request
GET /api/v3/events/:event_uri/attendees
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. |
| include_rejected | boolean | If set to true, rejected participants will be listed as well. |
| include_archived | boolean | If set to true, deleted and rejected participants will be listed as well. |
| only_confirmed | boolean | If set to true, only confirmed participants will be listed. |
| first_name | string | Filters results by the attendee's first name. |
| last_name | string | Filters results by the attendee's last name. |
| string | Filters results by the attendee's email. | |
| company | string | Filters results by the attendee's company. |
| created_date_time | datetime | Filters the information of the attendees created after the given datetime 2021-10-31T14:25:46). |
| updated_date_time | datetime | Filters the information of the attendees updated after the given datetime(2021-10-31T14:25:46). |
Create Attendee
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/register' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/register', {
method: 'POST',
headers: {
'Authorization': 'Bearer <your token>',
},
body: data
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": {
"id": "12345678",
"type": "attendees",
"attributes": {
"created_at": "2023-04-20T14:46:43.000Z",
"updated_at": "2023-04-20T14:46:43.000Z",
"uuid": "cbba89",
"fields": {
"944618": "Subleader",
"944619": "two",
"944620": "johndoe2@eventtia.com",
"944621": "Eventtia",
"944622": null,
"944623": null,
"944624": null,
"944625": null,
"944626": null,
"944627": "2020-08-27",
"944628": null
},
"status": "confirmed",
"paid": true,
"checked_in": false,
"checked_in_date": null,
"qr_code": "cbba89|Subleader two|johndoe2@eventtia.com|Eventtia|",
"can_schedule_meetings": false
},
"relationships": {
"attendee_type": {
"data": {
"id": "12345",
"type": "attendee_types"
}
},
"attendee_type_custom_fields": {
"data": []
},
"business_conference_participants": {
"data": []
}
}
},
"included": [
{
"id": "12345",
"type": "attendee_types",
"attributes": {
"name": "Leader Group",
"attendance_mode": "offline",
"price": 0.0,
"price_end_date": "2021-06-02T23:59:59.000-05:00",
"description": "",
"capacity": null,
"availability": 0,
"order": 3,
"price_without_vat": 0.0,
"confirmation_required": false,
"updated_at": "2021-04-26T16:08:52.000-05:00",
"valid_if_no_payments": false
},
"relationships": {
"attendee_type_custom_fields": {
"data": []
},
"business_conference_participant_type": {
"data": null
}
}
}
],
"meta": {
"group_uuid": "1c2f65",
"profiles": {
"69031": {
"seats": 3,
"available": 3
}
}
}
}
This endpoint allows you to create a new attendee.
HTTP Request
POST /api/v3/events/:event_uri/attendees/register
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| attendee_type_id | integer | Id of the attendee type |
| first_name | string | Attendee name |
| last_name | string | Attendee last name |
| string | Attendee email | |
| company | string | Attendee company name |
| telephone | string | Attendee phone or cellphone with the country code eg +570000000000 |
| job_title | string | Attendee job title |
| alternative_email | string | Attendee alternative email |
| birthdate | date | Attendee birthdate eg 27/08/2020 |
| timezone | string | Timezone of the attendee. |
| country_id | integer | Attendee country id |
| region_id | integer | Attendee region name |
| city_id | integer | Attendee city id |
| custom_fields | Object | field_id: field value eg {"692349"=>"Field value here"}} |
| workshops | Object | workshop_id: workshop_id Eg {"103625": 103625}` |
| purchase_items | Object | purchase_item_id: quantity Eg {"701": 0} |
| group_registration_uuid | string | Add the attendee for a existing group identify with that uuid |
This is an example of how your request should look:
{"attendee": {"attendee_type_id": 55428, "first_name": "", "last_name": "", "email": "", "company": "", "telephone": "", "job_title": "", "alternative_email": "", "birthdate": "27/08/2020", "timezone": "", "custom_fields": {"692349"=>""}}, "country_id": 2, "region_id": 3, "city_id": 3,"workshops": {"103625": 103625}, "purchase_items": {"701": 2}}
Group Registration
When you register an atteendee, if the participant type of the atteendee has enabled group registration, in the register response you get a new key "meta" that contains an object with a key named "group_uuid", the profiles that you can add to the group and the available seats for each one.
"meta": {
"group_uuid": "a061f3",
"profiles": {
"69031": {
"seats": 3,
"available": 3
},
"69032": {
"seats": 3,
"available": 3
}
}
}
Then, in the next requests for group registration you must send the "group_uuid" value in the the value of "group_registration_uuid" key.
Attendee
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/123'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/123')
Example of a successful (200) response:
{
"data": {
"id": "12344656",
"type": "attendees",
"attributes": {
"created_at": "2023-02-13T14:05:42.000Z",
"updated_at": "2023-02-13T14:20:32.000Z",
"uuid": "a2691c",
"fields": {
"1466264": "John Attendee",
"1466265": "Test",
"1466266": "lastest@exampleevent.com",
"1466267": "Hospital",
"1466268": null,
"1466269": null,
"1466270": "Paramedic",
"1466271": null,
"1466272": null,
"1466273": null,
"1466274": null
},
"status": "confirmed",
"paid": true,
"checked_in": true,
"checked_in_date": "2023-02-13T09:06:41.000-05:00",
"qr_code": "a1592c|Test Attendee Test|lastest@exampleevent.com|Hospital - Paramedic|",
"can_schedule_meetings": true
},
"relationships": {
"attendee_type": {
"data": {
"id": "123456",
"type": "attendee_types"
}
},
"attendee_type_custom_fields": {
"data": []
},
"business_conference_participants": {
"data": []
}
}
}
}
This endpoint returns the data of the specified attendee along with their attendee type (attendee_type) and custom field details (attendee_type_custom_fields), if requested via the include param.
HTTP Request
GET /api/v3/events/:event_uri/attendees/:attendee_id
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
| attendee_id | string | The id for the desired attendee. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| include | string | A list of included resources as described here. |
Cancel registration
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/123/cancel' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/123/cancel', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
This endpoint allows you to cancel a participant's registration to a given event.
HTTP Request
PUT /api/v3/events/:event_uri/attendees/:attendee_id/cancel
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
| attendee_id | string | The id for the desired attendee. |
HTTP response status codes
- 200: If cancelation is successful.
- 422: If the operation couldn't be performed.
Attendee by email
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/by_email'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/by_email')
Example of a successful (200) response:
{
"data": {
"id": "12345467",
"type": "attendees",
"attributes": {
"created_at": "2023-02-10T16:51:43.000Z",
"updated_at": "2023-03-13T21:21:28.000Z",
"uuid": "41bb76",
"fields": {
"1466287": "Test attendee",
"1466288": "Test2",
"1466289": "cat3@exampleemail.com",
"1466290": "Cat inc",
"1466291": null,
"1466292": null,
"1466293": "Lawyer",
"1466294": null,
"1466295": null,
"1466296": null,
"1466297": null
},
"status": "confirmed",
"paid": false,
"checked_in": true,
"checked_in_date": "2023-02-10T11:56:59.000-05:00",
"qr_code": "20bb76|Test attendee Test|cat3@exampleemail.com|Cat inc - Lawyer|",
"can_schedule_meetings": true
},
"relationships": {
"attendee_type": {
"data": {
"id": "12345",
"type": "attendee_types"
}
},
"attendee_type_custom_fields": {
"data": []
},
"business_conference_participants": {
"data": [
{
"id": "1234567",
"type": "business_conference_participants"
}
]
}
}
}
}
This endpoint returns the data of the specified attendee along with their attendee type (attendee_type) and custom field details (attendee_type_custom_fields), if requested via the include param.
HTTP Request
GET /api/v3/events/:event_uri/attendees/by_email
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| include | string | A list of included resources as described here. |
| string | The email for the desired attendee. |
Attendee Activities
List of Activities for an Attendee
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/123/workshops' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/123/workshops', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": [
{
"id": "123456",
"type": "workshops",
"attributes": {
"start_date": "2023-02-13T15:05:00.000Z",
"end_date": "2023-03-16T16:00:00.000Z",
"created_at": "2023-02-13T14:10:44.000Z",
"updated_at": "2023-03-13T21:23:03.000Z",
"booking_deadline_date": "2023-02-13T10:05:00.000-05:00",
"name": "Activity 4",
"description": "",
"location": "",
"show_on_register": true,
"streaming_embed_code": null,
"streaming_type": null,
"streaming_url": null,
"guid": "149b4489-1569-41e7-a321-0d775f5f0dd7",
"jitsi_url": null,
"background_image": {},
"enable_chat": true,
"chat_name": null,
"file_category_id": null,
"enabled_emotions": false,
"interactivity_type": null,
"interactivity_snippet": null,
"availability": 1000,
"used_seats": 1,
"translation_snippet": null,
"price": {
"101226": "0",
"101224": "0"
},
"sponsor_id": null,
"attendance_mode": "mixed",
"eventtia_studio_params": {}
},
"relationships": {
"speakers": {
"data": [
{
"id": "123456",
"type": "speakers"
}
]
},
"workshop_categories": {
"data": []
}
}
}
],
}
This endpoint returns the list of activities in which a given attendee is registered, along with their categories (workshop_categories) and speakers, if requested via the include param.
HTTP Request
GET /api/v3/events/:event_uri/attendees/:attendee_id/workshops
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the associated event. |
| attendee_id | string | The ID of the associated attendee. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. |
Registering an Attendee to an Activity
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendee_workshops' \
-X POST \
-H 'Authorization: Bearer <your token>' \
-H 'Content-Type: application/json' \
-d '{"workshop_id":1,"attendee_id":1}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendee_workshops', {
method: 'POST',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
workshop_id: 1,
attendee_id: 1
})
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": {
"id": "1234567",
"type": "attendee_workshops",
"attributes": {
"checked_in_date": null,
"checked_in": false
},
"relationships": {
"attendee": {
"data": {
"id": "1234567",
"type": "attendees"
}
},
"workshop": {
"data": {
"id": "123456",
"type": "workshops"
}
}
}
},
"meta": {
"current_attendee_workshops": [
123456
]
}
}
This endpoint allows you to register an attendee to a certain activity from the specified event.
HTTP Request
POST /api/v3/events/:event_uri/attendee_workshops
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Body Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| workshop_id | integer | false | The ID from the activity to which the specified attendee will be registered. |
| attendee_id | integer | false | The ID from the attendee which will be registered to the specified activity. |
Unregistering an Attendee from an Activity
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendee_workshops' \
-X DELETE \
-H 'Authorization: Bearer <your token>' \
-H 'Content-Type: application/json' \
-d '{"workshop_id":1,"attendee_id":1}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendee_workshops', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
workshop_id: 1,
attendee_id: 1
})
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": {
"id": "1234567",
"type": "attendee_workshops",
"attributes": {
"checked_in_date": null,
"checked_in": false
},
"relationships": {
"attendee": {...},
"workshop": {
"data": {
"id": "123456",
"type": "workshops"
}
}
}
}
}
This endpoint allows you to unregister an attendee from a certain activity from the specified event.
HTTP Request
DELETE /api/v3/events/:event_uri/attendee_workshops
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Body Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| workshop_id | integer | false | The ID from the activity from which the specified attendee will be unregistered. |
| attendee_id | integer | false | The ID from the attendee which will be unregistered from the specified activity. |
Updating Activities for an Attendee
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/1/update_activities' \
-X PUT \
-H 'Authorization: Bearer <your token>' \
-H 'Content-Type: application/json' \
-d '{"workshop_id":1,"attendee_id":1}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/1/update_activities', {
method: 'PUT',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
workshop_id: 1,2
attendee_id: 1
})
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": {
"id": "12345678",
"type": "attendees",
"attributes": {...},
"relationships": {
"attendee_type": {...}
}
},
"included": [...]
}
This endpoint allows you to register a participant to specific activities and delete their registration to activities that are not specified.
HTTP Request
PUT /api/v3/events/:event_uri/attendees/:attendee_id/update_activities
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
| attendee_id | string | The ID from the attendee. |
Body Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| workshop_ids | String | false | List of activity IDs separated by commas in which the participant must remain registered. If the participant is registered to other activities that are not provided in the list of workshop ids, they will be deleted. |
Guests
List of Guests
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/guests' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/guests', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": [
{
"id": "1234567",
"type": "guests",
"attributes": {
"uuid": "f0f56c",
"first_name": "Jon",
"last_name": "Doe",
"email": "jondoe@eventtia.com",
"company": "eventtia",
"import_id": null,
"updated_at": "2023-04-20T14:54:28.000-05:00"
},
"relationships": {
"attendee": {
"data": null
},
"attendee_type": {
"data": {
"id": "123456",
"type": "attendee_types"
}
}
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of guests for an event along with their associated attendee and attendee type, if requested via the include param.
HTTP Request
GET /api/v3/events/:event_uri/guests
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. |
Create Guest
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/guests' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/guests',{
method: 'POST',
headers: {
'Authorization': 'Bearer <your token>',
},
body: data
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": {
"id": "1234567",
"type": "guests",
"attributes": {
"uuid": "ecg92e",
"first_name": "Jonas",
"last_name": "Does",
"email": "jonasdoes@eventtia.com",
"company": "eventtia",
"import_id": null,
"updated_at": "2023-04-20T16:46:30.949-05:00"
},
"relationships": {...}
}
}
This endpoint allows you to create a new Guest.
HTTP Request
POST /api/v3/events/:event_uri/guests
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| first_name | string | Guest name |
| last_name | string | Guest last name |
| string | Guest email | |
| company | string | Guest company |
| attendee_type_id | integer | Set this if you want to restrict the attendee type this guest can choose when they register |
Guest
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/guests/123' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/guests/123', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": {
"id": "12345678",
"type": "guests",
"attributes": {
"uuid": "f0c58f",
"first_name": "Jon",
"last_name": "Doe",
"email": "jondoe@eventtia.com",
"company": "eventtia",
"import_id": null,
"updated_at": "2023-04-20T14:54:28.000-05:00"
},
"relationships": {
"attendee": {
"data": null
},
"attendee_type": {...}
}
}
}
This endpoint returns the data of the specified guest along with their associated attendee and attendee type, if requested via the include param.
HTTP Request
GET /api/v3/events/:event_uri/guests/:guest_id
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
| guest_id | string | The id for the desired guest. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| include | string | A list of included resources as described here. |
Activities
List of Activities
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": [
{
"id": "123456",
"type": "workshops",
"attributes": {
"start_date": "2023-02-12T14:00:00.000Z",
"end_date": "2023-02-12T18:00:00.000Z",
"created_at": "2023-02-08T15:22:09.000Z",
"updated_at": "2023-02-08T15:23:43.000Z",
"booking_deadline_date": "2023-02-12T08:00:00.000-05:00",
"name": "Activity 1",
"description": "",
"location": "",
"show_on_register": false,
"streaming_embed_code": [],
"streaming_type": "youtube",
"streaming_url": "",
"guid": "78012fe1-7d35-49ca-7af1-18dc228cf97a",
"jitsi_url": null,
"background_image": {},
"enable_chat": true,
"chat_name": "",
"file_category_id": null,
"enabled_emotions": false,
"interactivity_type": null,
"interactivity_snippet": "",
"availability": 1000,
"used_seats": 0,
"translation_snippet": "",
"price": null,
"sponsor_id": null,
"attendance_mode": "online",
"eventtia_studio_params": {}
},
"relationships": {
"speakers": {...},
"workshop_categories": {...}
}
},
{
"id": "654321",
"type": "workshops",
"attributes": {
"start_date": "2023-02-12T15:00:00.000Z",
"end_date": "2023-02-12T17:00:00.000Z",
"created_at": "2023-02-08T15:25:44.000Z",
"updated_at": "2023-02-08T15:26:08.000Z",
"booking_deadline_date": "2023-02-12T10:00:00.000-05:00",
"name": "Activity 2",
"description": "",
"location": "",
"show_on_register": true,
"streaming_embed_code": [],
"streaming_type": "zoom",
"streaming_url": "",
"guid": "e995adc2-a974-455c-7695-8a05b1226b87",
"jitsi_url": null,
"background_image": {},
"enable_chat": true,
"chat_name": "",
"file_category_id": null,
"enabled_emotions": false,
"interactivity_type": null,
"interactivity_snippet": "",
"availability": 1000,
"used_seats": 0,
"translation_snippet": "",
"price": null,
"sponsor_id": null,
"attendance_mode": "online",
"eventtia_studio_params": {},
"zoom_type": "native"
},
"relationships": {...}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of activities for an event along with their categories (workshop_categories) and speakers, if requested via the include param.
HTTP Request
GET /api/v3/events/:event_uri/workshops
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. |
| name | string | Exact name or part of the activity name for which you want to search |
| date | date | Start date of the activity |
| updated_date_time | datetime | This param allows you to list all the activities that have been updated from a specific date-time. |
| in_the_future | boolean | Send this param if you want to list the activities that have not started |
Activity
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": {
"id": "123456",
"type": "workshops",
"attributes": {
"start_date": "2023-02-12T14:00:00.000Z",
"end_date": "2023-02-12T18:00:00.000Z",
"created_at": "2023-02-08T15:22:09.000Z",
"updated_at": "2023-02-08T15:23:43.000Z",
"booking_deadline_date": "2023-02-12T08:00:00.000-05:00",
"name": "Activity 1",
"description": "",
"location": "",
"show_on_register": false,
"streaming_embed_code": [],
"streaming_type": "youtube",
"streaming_url": "",
"guid": "78013fe1-9d36-49ca-8bf1-18dc228cf97a",
"jitsi_url": null,
"background_image": {},
"enable_chat": true,
"chat_name": "",
"file_category_id": null,
"enabled_emotions": false,
"interactivity_type": null,
"interactivity_snippet": "",
"availability": 1000,
"used_seats": 0,
"translation_snippet": "",
"price": null,
"sponsor_id": null,
"attendance_mode": "online",
"eventtia_studio_params": {}
},
"relationships": {
"speakers": {...},
"workshop_categories": {...}
}
}
}
This endpoint returns the activity associated with the specified id.
HTTP Request
GET /api/v3/events/:event_uri/workshops/:id
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event for the activity you want to retrieve. |
| id | string | The id for the activity you want to retrieve. |
Create Activity
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops',{
method: 'POST',
headers: {
'Authorization': 'Bearer <your token>',
},
body: data
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": {
"id": "123456",
"type": "workshops",
"attributes": {
"start_date": "2023-04-22T11:00:00.000Z",
"end_date": "2023-04-30T12:00:00.000Z",
"created_at": "2023-04-20T21:57:47.772Z",
"updated_at": "2023-04-20T21:57:47.772Z",
"booking_deadline_date": null,
"name": "Activity 7",
"description": "workshop description",
"location": "",
"show_on_register": true,
"streaming_embed_code": null,
"streaming_type": null,
"streaming_url": "",
"guid": "a4c5a7ce-3bf8-4130-98cf-d2b3d454f81e",
"jitsi_url": null,
"background_image": {},
"enable_chat": true,
"chat_name": "",
"file_category_id": null,
"enabled_emotions": false,
"interactivity_type": null,
"interactivity_snippet": "",
"availability": 1000,
"used_seats": 0,
"translation_snippet": "",
"price": {
"69031": 200
},
"sponsor_id": null,
"attendance_mode": "offline",
"eventtia_studio_params": {}
},
"relationships": {
"speakers": {
"data": []
},
"workshop_categories": {
"data": []
}
}
}
}
This endpoint allows you to create a new activity.
HTTP Request
POST /api/v3/events/:event_uri/workshops
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Body Parameters
Activity default parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | Workshop name. |
| description | string | Workshop description. |
| start_date | datetime | A datetime in the following format "14/08/2020 - 23:00:00". |
| end_date | datetime | A datetime in the following format "14/08/2020 - 23:00:00". |
| location | string | Workshop location |
| show_on_register | boolean | Allow registration for this workshop |
| allow_blocking_workshops | boolean | Allow registration for this workshop |
| availability | number | |
| show_for_attendee_type | Object | attendee_type_id: "true" eg. {"69031": "true"} |
| price | Object | attendee_type_id: price eg. {"69031": 200} |
Virtual activity parameters
| Parameter | Type | Description |
|---|---|---|
| streaming_type | string | Allowed values 'google_meet', 'webex', 'microsoft_teams', 'youtube', 'other', 'jitsi', 'jitsi_oficial', 'daily_co' |
| streaming_embed_code | Object | eg {display_name : 'Test', embed_code:'<div>' } if streaming_type is in 'youtube', 'jitsi' or' other' |
| streaming_url | string | Streaming url like 'https://test.streaming.com' if streaming type is other than 'youtube', 'jitsi' or' other' |
| enable_chat | boolean | Allow chat on virtual stage |
| chat_name | string | Change chat name, default it is 'Chat' |
| enabled_emotions | boolean | Allow emotions on virtual stage |
| interactivity_type | string | Allowed values mentimeter, slido, sparkup, other_interactivity: |
| interactivity_snippet | string | Interactivity snipped as string |
| translation_snippet | string | Translation snipped as string |
Update Activity
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": {
"id": "12345",
"type": "workshops",
"attributes": {
"start_date": "2023-04-22T11:00:00.000Z",
"end_date": "2023-04-30T12:00:00.000Z",
"created_at": "2023-02-08T15:22:09.000Z",
"updated_at": "2023-04-20T22:36:43.104Z",
"booking_deadline_date": "2023-02-12T08:00:00.000-05:00",
"name": "Updated name",
"description": "updated workshop name",
"location": "",
"show_on_register": true,
"streaming_embed_code": null,
"streaming_type": null,
"streaming_url": "",
"guid": "78012cf1-9d55-44ca-5af1-18dc228cf97a",
"jitsi_url": null,
"background_image": {},
"enable_chat": true,
"chat_name": "",
"file_category_id": null,
"enabled_emotions": false,
"interactivity_type": null,
"interactivity_snippet": "",
"availability": 1000,
"used_seats": 0,
"translation_snippet": "",
"price": {
"69031": 20
},
"sponsor_id": null,
"attendance_mode": "online",
"eventtia_studio_params": {}
},
"relationships": {...}
}
}
This endpoint allows you to update an activity.
HTTP Request
PUT /api/v3/events/:event_uri/workshops/:id
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
| id | string | The id for the activity you want to retrieve. |
Body Parameters
Activity default parameters
| Parameter | Type | Description |
|---|---|---|
| name | string | Workshop name. |
| description | string | Workshop description. |
| start_date | datetime | A datetime in the following format "14/08/2020 - 23:00:00". |
| end_date | datetime | A datetime in the following format "14/08/2020 - 23:00:00". |
| location | string | Workshop location |
| show_on_register | boolean | Allow registration for this workshop |
| allow_blocking_workshops | boolean | Allow registration for this workshop |
| availability | number | |
| show_for_attendee_type | Object | attendee_type_id: "true" eg. {"69031": "true"} |
| price | Object | attendee_type_id: price eg. {"69031": 200} |
Virtual activity parameters
| Parameter | Type | Description |
|---|---|---|
| streaming_type | string | Allowed values 'google_meet', 'webex', 'microsoft_teams', 'youtube', 'other', 'jitsi', 'jitsi_oficial', 'daily_co' |
| streaming_embed_code | Object | eg {display_name : 'Test', embed_code:'<div>' } if streaming_type is in 'youtube', 'jitsi' or' other' |
| streaming_url | string | Streaming url like 'https://test.streaming.com' if streaming type is other than 'youtube', 'jitsi' or' other' |
| enable_chat | boolean | Allow chat on virtual stage |
| chat_name | string | Change chat name, default it is 'Chat' |
| enabled_emotions | boolean | Allow emotions on virtual stage |
| interactivity_type | string | Allowed values mentimeter, slido, sparkup, other_interactivity: |
| interactivity_snippet | string | Interactivity snipped as string |
| translation_snippet | string | Translation snipped as string |
List of Attendees in an Activity
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops/123/attendees' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops/123/attendees', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "12345678",
"type": "attendees",
"attributes": {
"created_at": "2023-02-07T16:48:37.000Z",
"updated_at": "2023-03-13T20:04:56.000Z",
"uuid": "288c29",
"fields": {
"1466264": "Jon",
"1466265": "Doe",
"1466266": "jondoe@eventtia.com",
"1466267": "Eventtia",
"1466268": "+57123456789",
"1466269": null,
"1466270": "Dev",
"1466271": {...},
"1466272": null,
"1466273": "1998-08-14",
"1466274": "America/Bogota"
},
"status": "confirmed",
"paid": true,
"checked_in": true,
"checked_in_date": "2023-02-07T11:52:02.000-05:00",
"qr_code": "288c29|Jon Doe|jondoe@eventtia.com|Eventtia - Lawyer|+57123456789",
"can_schedule_meetings": true
},
"relationships": {...}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of attendees for an activity. For more details regarding the information returned and additional query params, see the attendees endpoint.
HTTP Request
GET /api/v3/events/:event_uri/workshops/:workshop_id/attendees
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event in which the activity occurs. |
| workshop_id | string | The id of the desired activity. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
Categories
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshop_categories' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshop_categories', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": [
{
"id": "1234",
"type": "workshop_categories",
"attributes": {
"name": "Test Category",
"color": "#6d2a84",
"updated_at": "2023-04-20"
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of categories (workshop_categories) for an event available to assign to any activity.
HTTP Request
GET /api/v3/events/:event_uri/workshop_categories
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
Add Categories to Activity
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421/set-categories' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/workshops/115421/set-categories', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": {
"id": "123456",
"type": "workshops",
"attributes": {...},
"relationships": {
"speakers": {...},
"workshop_categories": {
"data": [
{
"id": "1234",
"type": "workshop_categories"
}
]
}
}
}
}
This endpoint allows you to assign categories to selected activity.
HTTP Request
POST /api/v3/events/:event_uri/workshops/:id/set-categories
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event in which the activity occurs. |
| workshop_id | string | The id of the desired activity. |
Query Parameters
Activity default parameters
| Parameter | Type | Description |
|---|---|---|
| categories | string | ids of categories to assign for selected workshop separated by commas. |
Speakers
List of Speakers
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/speakers'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/speakers')
Example of a successful (200) response:
{
"data": [
{
"id": "123456",
"type": "speakers",
"attributes": {
"full_name": "Speaker 1",
"email": "speaker1@email.com",
"picture": {...},
"banner": {...},
"position": "Dev",
"twitter": "",
"linkedin": "",
"bio": "Speaker Bio",
"company": "Eventtia",
"updated_at": "2023-03-15",
"instagram": "",
"website": "",
"file_category_id": null
},
"relationships": {...}
},
{
"id": "654321",
"type": "speakers",
"attributes": {
"full_name": "Speaker 2",
"email": "speaker2@email.com",
"picture": {...},
"banner": {...},
"position": "Dev",
"twitter": "",
"linkedin": "https://www.linkedin.com/in/john-smith",
"bio": "Speaker Bio 2",
"company": "Example Company",
"updated_at": "2023-03-17",
"instagram": "",
"website": "",
"file_category_id": null
},
"relationships": {...}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of speakers for an event along with their activities (workshops) and activities' categories (workshop_categories), if requested via the include param.
HTTP Request
GET /api/v3/events/:event_uri/speakers
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. |
Merchandising
List of Purchase Items
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/purchase_items' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/purchase_items', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "1234",
"type": "purchase_items",
"attributes": {
"name": "Merch",
"description": "Merch Test",
"quantity": 3,
"maximum_quantity_per_attendee": 1,
"available_for_attendee_types": {
"101226": "5"
},
"image": {...},
"updated_at": "2023-02-07T11:57:16.000-05:00"
}
},
{
"id": "4321",
"type": "purchase_items",
"attributes": {
"name": "Merch 2",
"description": "Merch for vip",
"quantity": 10,
"maximum_quantity_per_attendee": 1,
"available_for_attendee_types": {
"101226": "1"
},
"image": {...},
"updated_at": "2023-04-21T10:59:49.000-05:00"
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of purchase items associated with the corresponding event.
HTTP Request
GET /api/v3/events/:event_uri/purchase_items
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the purchase items. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
Purchase Item
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/purchase_items/432' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/purchase_items/432', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": {
"id": "1234",
"type": "purchase_items",
"attributes": {
"name": "Merch",
"description": "Merch Test",
"quantity": 3,
"maximum_quantity_per_attendee": 1,
"available_for_attendee_types": {
"101226": "5"
},
"image": {...},
"updated_at": "2023-02-07T11:57:16.000-05:00"
}
}
}
This endpoint returns the details of a purchase item.
HTTP Request
GET /api/v3/events/:event_uri/purchase_items/:purchase_item_id
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the purchase items. |
| purchase_item_id | string | The ID of the requested item. |
List of Items bought by Event
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendee_purchase_items' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendee_purchase_items', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "12345",
"type": "attendee_purchase_items",
"attributes": {
"quantity": 1,
"paid": true,
"updated_at": "2023-04-21T12:52:11.000-05:00"
},
"relationships": {
"attendee": {
"data": {
"id": "1234567",
"type": "attendees"
}
},
"purchase_item": {
"data": {
"id": "2233",
"type": "purchase_items"
}
}
}
},
{
"id": "54321",
"type": "attendee_purchase_items",
"attributes": {
"quantity": 1,
"paid": false,
"updated_at": "2023-04-21T13:38:10.000-05:00"
},
"relationships": {
"attendee": {
"data": {
"id": "7654321",
"type": "attendees"
}
},
"purchase_item": {
"data": {
"id": "3344",
"type": "purchase_items"
}
}
}
}
],
"links": {...},
"meta": {
"total_pages": 1
}
}
This endpoint returns the list of attendee purchases for a given event, along with attendee (attendee) and purchase item details (purchase_item), if requested via the include param.
HTTP Request
GET /api/v3/events/:event_uri/attendee_purchase_items
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the purchase item and the attendees. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. |
List of Items bought by Attendee
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendees/45/attendee_purchase_items' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendees/45/attendee_purchase_items', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "12345",
"type": "attendee_purchase_items",
"attributes": {
"quantity": 1,
"paid": true,
"updated_at": "2023-04-21T12:52:11.000-05:00"
},
"relationships": {
"attendee": {
"data": {
"id": "12345678",
"type": "attendees"
}
},
"purchase_item": {
"data": {
"id": "4321",
"type": "purchase_items"
}
}
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of purchases for a given attendee, along with attendee (attendee) and purchase item details (purchase_item), if requested via the include param.
HTTP Request
GET /api/v3/events/:event_uri/attendees/:attendee_id/attendee_purchase_items
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event associated with the purchase item and the attendees. |
| attendee_id | string | The ID of the attendee that purchased these items. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. |
Stands
List of Stand Categories
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/stand_categories'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/stand_categories')
Example of a successful (200) response:
{
"data": [
{
"id": "1234",
"type": "stand_categories",
"attributes": {
"name": "Sofware",
"updated_at": "2023-04-21T15:00:29.000-05:00"
}
},
{
"id": "4321",
"type": "stand_categories",
"attributes": {
"name": "Hardware",
"updated_at": "2023-04-21T15:00:19.000-05:00"
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of stand categories for an event.
HTTP Request
GET /api/v3/events/:event_uri/stand_categories
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
List of Stand Zones
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/zones'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/zones')
Example of a successful (200) response:
{
"data": [
{
"id": "12345",
"type": "zones",
"attributes": {
"name": "Software",
"updated_at": "2023-04-21T15:09:21.000-05:00"
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of stand zones for an event.
HTTP Request
GET /api/v3/events/:event_uri/zones
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
List of Stand Reservations
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/stand_reservations'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/stand_reservations')
Example of a successful (200) response:
{
"data": [
{
"id": "12345",
"type": "stand_reservations",
"attributes": {
"display_name": "Eventtia",
"profile_logo": {
"filename": null,
"thumb": "/profile_logos/thumb/missing.png",
"small": "/profile_logos/thumb2x/missing.png",
"large": "/profile_logos/original/missing.png"
},
"profile_description": "company description",
"website": "www.eventtia.com",
"profile_extra_fields": {},
"updated_at": "2023-04-24T16:47:37.000-05:00"
},
"relationships": {...}
}
],
"included": [...],
"links": {... },
"meta": {...}
}
This endpoint returns the list of public stand reservations for an event.
HTTP Request
GET /api/v3/events/:event_uri/stand_reservations
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| company_name | string | The name of a company to filter the list. |
| zone | string | The ID of a zone to filter the list. |
| category | string | The ID of a category to filter the list. |
List of Exhibitor Leads
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/stand_reservations/567/leads' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/stand_reservations/567/leads', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "123456",
"type": "leads",
"attributes": {
"name": "Jon Doe",
"company": "Eventtia",
"email": "jondoe@eventtia.com",
"phone": "",
"notes": "",
"priority": "medium",
"uuid": "02ecbf84-5efd-4753-9c71-a3e7e2fe0605",
"updated_at": "2023-04-24"
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of leads for an exhibitor that has a stand reservation.
HTTP Request
GET /api/v3/events/:event_uri/stand_reservations/:stand_reservation_id/leads
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
| stand_reservation_id | number | The id of the exhibitor's stand reservation. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
Points of Interest
List of Points of Interest
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/pois'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/pois')
Example of a successful (200) response:
{
"data": [
{
"id": "12345",
"type": "pois",
"attributes": {
"latitude": 6.2457,
"longitude": -75.5822,
"name": "Hotel test",
"description": "Hotel nearby here!",
"category_name": "Hotel",
"updated_at": "2023-02-07T12:11:24.000-05:00"
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of points of interest for an event.
HTTP Request
GET /api/v3/events/:event_uri/pois
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
Q&A Sessions
List of Q&A Sessions
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_qa_sessions'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_qa_sessions')
This endpoint returns the list of Q&A sessions for an event.
HTTP Request
GET /api/v3/events/:event_uri/event_qa_sessions
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. |
Event Params
Event Param
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_params/pay_u_api_key' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_params/pay_u_api_key', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Make sure you replace
<your token>with the JWT you get when you authenticate.
This endpoint returns the requested event param for an event.
HTTP Request
GET /api/v3/events/:event_uri/event_params/:param_name
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the associated event. |
| param_name | string | The name of the desired event param. |
Updating an Event Param
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_params/aux_json_data' \
-X PATCH \
-H 'Authorization: Bearer <your token>' \
-H 'Content-Type: application/json' \
-d '{
"param_value": [{
"attr": "val",
"attr2": "val2"
}]
}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_params/aux_json_data', {
method: 'PATCH',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
param_value: [{
attr: 'val',
attr2: 'val2'
}]
})
})
Make sure you replace
<your token>with the JWT you get when you authenticate.
This endpoint allows you to create or modify an event param.
Currently, the only params available for edition are the following:
| Param name | Param value format |
|---|---|
| aux_json_data | JSON |
HTTP Request
PATCH /api/v3/events/:event_uri/event_params/:param_name
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the associated event. |
| param_name | string | The name of the desired event param. |
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| param_value | any | The content stored in the event param. The type depends on the specific param (see the supported names and formats above). |
Communications
List of Event Massive Messages
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/massive_messages' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/massive_messages', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "12345",
"type": "conditioned_massive_messages",
"attributes": {
"account_id": 54321,
"created_at": "2023-04-24T12:16:43.000-05:00",
"updated_at": "2023-04-24T12:17:12.000-05:00",
"subject": "message",
"body": "test massive",
"created_by_id": 22334,
"updated_by_id": 22334,
"status": 1,
"sent_messages_count": 0,
"failed_messages_count": 0,
"priority": null,
"archived": false,
"start_processing_date": null,
"end_processing_date": null,
"last_activity": null,
"email_account_id": 44556,
"queued_emails_count": 0,
"opened_messages_count": 0,
"filter_id": null,
"repited_mails_count": 0,
"draft": false,
"error_description": null,
"halt": false,
"type": "ConditionedMassiveMessage",
"message_type": 6,
"conditions": {
"attendee_types": [
"123456"
],
"register": "0",
"register_date_lower_bound": "",
"register_date_upper_bound": "",
"event_id": 76536
},
"server_delivered_emails_count": 0,
"test_browser_display_url": "https://connect.eventtia.com/en/api/v2/massive-messages/95060/test-browser-display"
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of massive messages for an event.
HTTP Request
GET /api/v3/events/:event_uri/massive_messages
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
Event Massive Message Stats
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/massive_messages/1/stats' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/massive_messages/1/stats', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"errors": 4,
"opened": 10
}
This endpoint returns the stats for a massive message.
HTTP Request
GET /api/v3/events/:event_uri/massive_messages/:id/stats
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the massive message event. |
| id | integer | The id for the desired massive message. |
Countries, Regions and Cities
List of Countries
curl 'https://connect.eventtia.com/api/v3/countries'
fetch('https://connect.eventtia.com/api/v3/countries')
Example of a successful (200) response:
{
"data": [
{
"id": "157",
"type": "countries",
"attributes": {
"name": "Afghanistan",
"currency_code": "USD"
}
},
{
"id": "176",
"type": "countries",
"attributes": {
"name": "Albania",
"currency_code": "EUR"
}
},
....other
],
"links": {
"self": "...",
"first": "...",
"prev": null,
"next": "...",
"last": "..."
},
"meta": { "total_pages": 10 }
}
This endpoint returns the list of all countries.
HTTP Request
GET /api/v3/countries
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
List of Regions
curl 'https://connect.eventtia.com/api/v3/countries/51/regions'
fetch('https://connect.eventtia.com/api/v3/countries/51/regions')
Example of a successful (200) response:
{
"data": [
{
"id": "464",
"type": "regions",
"attributes": {
"name": "Amazonas"
},
"relationships": {
"country": {
"data": {
"id": "51",
"type": "countries"
}
}
}
},
{
"id": "722",
"type": "regions",
"attributes": {
"name": "Antioquia"
},
"relationships": {
"country": {
"data": {
"id": "51",
"type": "countries"
}
}
}
},
...other
],
"links": {
"self": "...",
"first": "...",
"prev": null,
"next": "...",
"last": "..."
},
"meta": { "total_pages": 2 }
}
This endpoint returns the list of all regions for a given country.
HTTP Request
GET /api/v3/countries/:country_id/regions
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| country_id | number | The ID of the desired country. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
List of Cities
curl 'https://connect.eventtia.com/api/v3/countries/51/regions/722/cities'
fetch('https://connect.eventtia.com/api/v3/countries/51/regions/722/cities')
Example of a successful (200) response:
{
"data": [
{
"id": "7644",
"type": "cities",
"attributes": {
"name": "Abejorral",
"latitude": 5.8,
"longitude": -75.43,
"time_zone": "America/Bogota"
},
"relationships": {
"region": {
"data": {
"id": "722",
"type": "regions"
}
},
"country": {
"data": {
"id": "51",
"type": "countries"
}
}
}
},
...other
],
"links": {
"self": "...",
"first": "...",
"prev": null,
"next": "...",
"last": "..."
},
"meta": { "total_pages": 6 }
}
This endpoint returns the list of all cities for a given region.
HTTP Request
GET /api/v3/countries/:country_id/regions/:region_id/cities
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| country_id | number | The ID of the desired country. |
| region_id | number | The ID of the desired region. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
City
curl 'https://connect.eventtia.com/api/v3/cities/7993'
fetch('https://connect.eventtia.com/api/v3/cities/7993')
Example of a successful (200) response:
{
"data": {
"id": "7993",
"type": "cities",
"attributes": {
"name": "Medellín",
"latitude": 6.29,
"longitude": -75.54,
"time_zone": "America/Bogota"
},
"relationships": {
"region": {
"data": {
"id": "722",
"type": "regions"
}
},
"country": {
"data": {
"id": "51",
"type": "countries"
}
}
}
},
"included": [
{
"id": "722",
"type": "regions",
"attributes": {
"name": "Antioquia"
},
"relationships": {
"country": {
"data": {
"id": "51",
"type": "countries"
}
}
}
},
{
"id": "51",
"type": "countries",
"attributes": {
"name": "Colombia",
"currency_code": "COP"
}
}
]
}
This endpoint returns a city along with its region and country.
HTTP Request
GET /api/v3/cities/:city_id
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| city_id | number | The ID of the desired city. |
Web Hooks
List Account Web Hooks
curl 'https://connect.eventtia.com/en/api/v3/web_hooks' \
-X GET \
-H 'Authorization: Bearer <your token>' \
-H 'Content-Type: application/json' \
fetch('https://connect.eventtia.com/en/api/v3/web_hooks', {
method: 'GET',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json',
},
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
{
"data": [{
"id": "11940",
"type": "event_web_hooks",
"attributes": {
"target_url": "www.google.com/api/web",
"trigger": "attendee_created",
"created_at": "2023-04-21T14:56:19.000-05:00"
},
"relationships": {
"event": {
"data": {
"id": "34614",
"type": "events"
}
}
}
}],
"links": {
"self": "...",
"first": "...",
"prev": null,
"next": null,
"last": "..."
},
"meta": { "total_pages": 1 }
}
This endpoint allows you to list all created webhooks for your account. If you want to obtain the list of webhooks created for a specific event, you could do it by sending an extra parameter called event_uri with the URI of the desired event.
HTTP Request
GET /api/v3/web_hooks
Body Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for certain event. |
Creating a Event Web Hook
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_web_hooks' \
-X POST \
-H 'Authorization: Bearer <your token>' \
-H 'Content-Type: application/json' \
-d '{"target_url":"https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created", "trigger":"attendee_created"}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_web_hooks', {
method: 'POST',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
target_url: 'www.google.com/api/web',
trigger: 'attendee_created'
})
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (201) response:
{
"data": {
"id": "11940",
"type": "event_web_hooks",
"attributes": {
"target_url": "www.google.com/api/web",
"trigger": "attendee_created",
"created_at": "2023-04-21T14:56:19.603-05:00"
},
"relationships": {
"event": {
"data": {
"id": "34614",
"type": "events"
}
}
}
}
}
This endpoint allows you to subscribe to certain events. Once subscribed, you will receive a POST request to the specified URL every time the triggering event happens.
HTTP Request
POST /api/v3/events/:event_uri/event_web_hooks
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the associated event. |
Body Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| target_url | string | false | The URL to which the resource will be sent. This URL must be unique, and it must contain all the information needed to validate that the request comes from Eventtia. |
| trigger | string | false | One of the triggers listed below. |
Available Web Hook Triggers
- attendee_created
- attendee_updated
- event_invoice_created
- event_invoice_updated
- payment_created
Deleting a Event Web Hook
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/event_web_hooks' \
-X DELETE \
-H 'Authorization: Bearer <your token>' \
-H 'Content-Type: application/json' \
-d '{"target_url":"https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created"}'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/event_web_hooks', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
target_url: 'www.google.com/api/web',
trigger: 'attendee_created
})
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (200) response:
null
This endpoint deletes the subscription associated with the target URL.
HTTP Request
DELETE /api/v3/events/:event_uri/event_web_hooks
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the associated event. |
Body Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| target_url | string | false | The URL you used to subscribe to a certain trigger. |
| trigger | string | false | One of the available triggers |
Creating a Account Web Hook
curl 'https://connect.eventtia.com/api/v3/accounts/account-api-key/web_hooks' \
-X POST \
-H 'Authorization: Bearer <your token>' \
-H 'Content-Type: application/json' \
-d '{"target_url":"https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created", "trigger":"attendee_created"}'
fetch('https://connect.eventtia.com/api/v3/accounts/account-api-key/web_hooks', {
method: 'POST',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
target_url: 'https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created',
trigger: 'attendee_created'
})
})
Make sure you replace
<your token>with the JWT you get when you authenticate.Example of a successful (201) response:
{
"data": {
"id": "12345",
"type": "event_web_hooks",
"attributes": {
"target_url": "www.google.com/api/web",
"trigger": "event_created",
"created_at": "2023-04-24T17:22:40.315-05:00"
},
"relationships": {
"event": {
"data": null
}
}
}
}
This endpoint allows you to subscribe to certain events. Once subscribed, you will receive a POST request to the specified URL every time the triggering event happens.
HTTP Request
POST /api/v3/accounts/:account_api_key/web_hooks
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_api_key | string | Your account_api_key. |
Body Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| target_url | string | false | The URL to which the resource will be sent. This URL must be unique, and it must contain all the information needed to validate that the request comes from Eventtia. |
| trigger | string | false | One of the triggers listed below. |
Available Web Hook Triggers
- event_created
- event_updated
Deleting a Account Web Hook
curl 'https://connect.eventtia.com/api/v3/accounts/account-api-key/web_hooks' \
-X DELETE \
-H 'Authorization: Bearer <your token>' \
-H 'Content-Type: application/json' \
-d '{"target_url":"https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created"}'
fetch('https://connect.eventtia.com/api/v3/accounts/account-api-key/web_hooks', {
method: 'DELETE',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json',
},
body: JSON.stringify({
target_url: 'https://mydomain.com/web-hooks/eventtia/uuid-for-attendee-created'
})
})
Make sure you replace
<your token>with the JWT you get when you authenticate.
This endpoint deletes the subscription associated with the target URL.
HTTP Request
DELETE /api/v3/accounts/:account_api_key/web_hooks
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| account_api_key | string | Your account_api_key. |
Body Parameters
| Parameter | Type | Optional | Description |
|---|---|---|---|
| target_url | string | false | The URL you used to subscribe to a certain trigger. |
| trigger | string | false | One of the available triggers |
Surveys
List of Surveys
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/surveys'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/surveys')
Example of a successful (200) response:
{
"data": [
{
"id": "10042",
"type": "surveys",
"attributes": {
"name": "Attendee quiz",
"description": "A fast quiz about the event",
"entity_ids": [
"101224",
"101226"
],
"enabled": true,
"survey_type": "attendee",
"entity_type": "attendee_types",
"session_type": "quiz",
"enabled_signature": false,
"business_conference_id": null,
"answered": false,
"updated_at": "2023-02-10T14:18:10.000-05:00"
},
"relationships": {
"custom_fields": {
"data": [
{
"id": "514784",
"type": "custom_fields"
},
{
"id": "514785",
"type": "custom_fields"
}
]
}
}
},
{
"id": "10033",
"type": "surveys",
"attributes": {
"name": "Satisfaction survey",
"description": "Here you can put your comments about the commit",
"entity_ids": [
"101224",
"101226"
],
"enabled": true,
"survey_type": "attendee",
"entity_type": "attendee_types",
"session_type": "survey",
"enabled_signature": false,
"business_conference_id": null,
"answered": false,
"updated_at": "2023-02-07T12:12:02.000-05:00"
},
"relationships": {
"custom_fields": {
"data": [
{
"id": "514125",
"type": "custom_fields"
},
{
"id": "514126",
"type": "custom_fields"
},
{
"id": "514127",
"type": "custom_fields"
}
]
}
}
}
],
"links": {
"self": "...",
"first": "...",
"prev": null,
"next": null,
"last": "..."
},
"meta": {
"total_pages": 1
}
}
This endpoint returns the list of surveys for an event.
HTTP Request
GET /api/v3/events/:event_uri/surveys
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. |
Add survey answer
curl 'https://connect.eventtia.com/api/v3/events/:event_uri/surveys/:id/answers' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/:event_uri/surveys/:id/answers', {
method: 'POST',
headers: {
'Authorization': 'Bearer <your token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({"333545":"mundo","333546":"Hola"})
})
Example of a successful (201) response:
{
"data": {
"id": "10033",
"type": "surveys",
"attributes": {
"name": "Satisfaction survey",
"description": "Here you can put your comments about the commit",
"entity_ids": [
"101224",
"101226"
],
"enabled": true,
"survey_type": "attendee",
"entity_type": "attendee_types",
"session_type": "survey",
"enabled_signature": false,
"business_conference_id": null,
"answered": true,
"updated_at": "2023-02-07T12:12:02.000-05:00"
},
"relationships": {
"custom_fields": {
"data": [
{
"id": "514125",
"type": "custom_fields"
},
{
"id": "514126",
"type": "custom_fields"
},
{
"id": "514127",
"type": "custom_fields"
}
]
},
"event_file_category": {
"data": null
},
"event_files": {
"data": []
}
}
}
}
This endpoint allows you add an response for the specified survey
HTTP Request
POST /api/v3/events/:event_uri/surveys/:id/answers
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the event.. |
| survey_id | integer | The id of the desired survey. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| answers | json | The survey answers in JSON format with the following schema: {"question_id": "Question answer"} |
| survey_type | string | Allowed values, 'attendee' and 'business_conference_meetings' |
List of Survey Answers
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/surveys/:survey_id/survey_answers' \
-H 'Authorization: Bearer <your token>'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/surveys/:survey_id/survey_answers', {
headers: {
'Authorization': 'Bearer <your token>',
}
})
Example of a successful (200) response:
{
"data": [
{
"id": "254363",
"type": "survey_answers",
"attributes": {
"entity_id": 14140077,
"entity_type": "Attendee",
"values": {
"514125": 5,
"514126": "Very good",
"514127": [
"Yes/No"
]
},
"related_entity_type": null,
"related_entity_id": null
}
}
],
"links": {
"self": "...",
"first": "...",
"prev": null,
"next": null,
"last": "..."
},
"meta": {
"total_pages": 1
}
}
This endpoint returns the list of answers for a survey.
HTTP Request
GET /api/v3/events/test-event-1/surveys/:survey_id/survey_answers
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
| survey_id | integer | The survey_id for the desired survey |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
Payments
List of Attendee Payments
curl 'https://connect.eventtia.com/api/v3/events/test-event-1/attendee-payments'
fetch('https://connect.eventtia.com/api/v3/events/test-event-1/attendee-payments')
Example of a successful (200) response:
{
"data": [
{
"id": "1234567",
"type": "payments",
"attributes": {
"payment_type": "Manual payment",
"identifier": null,
"currency": "COP",
"description": "test pago",
"total_amount": "1.0",
"status": "accepted",
"created_at": "2023-04-24T17:14:38.000-05:00",
"updated_at": "2023-04-24T17:14:38.000-05:00",
"vat": "0.0"
},
"relationships": {
"attendee": {
"data": {
"id": "12345678",
"type": "attendees"
}
}
}
}
],
"links": {...},
"meta": {...}
}
This endpoint returns the list of attendee payments for an event.
HTTP Request
GET /api/v3/events/:event_uri/attendee-payments
Path Parameters
| Parameter | Type | Description |
|---|---|---|
| event_uri | string | The event_uri for the desired event. |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
| page | json | A page object as described here. |
| include | string | A list of included resources as described here. |
| start_date_time | datetime | Start date time filter eg 2020-07-16 23:00 |
| end_date_time | datetime | End date time filter eg 2020-07-30 23:00 |
| payment_type | integer | Payment type filter. Supported options manual_payment: 1 , electronic: 3 |
| status | string | Filter payments by status. Receives a comma-separated list. Suppported options processing, accepted, refuted, expired, error, refunded |