Open Event API Server
The Open Event API Server
Authentication ¶
The API uses JWT Authentication to authenticate users to the server. For authentication, you need to be a registered user. Once you have registered yourself as an user, you can send a request to get the access_token. This access_token you need to then use in Authorization header while sending a request in the following manner: Authorization: JWT <access_token>
JWT Authentication ¶
Authenticate and generate tokenPOST/v1/auth/login
Example URI
POST https://api.eventyay.com/v1/auth/login
Request
Headers
Content-Type: application/jsonBody
{
"email": "email@example.com",
"password": "password"
}Response
200Headers
Content-Type: application/jsonBody
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZGVudGl0eSI6MSwiaWF0IjoxNDk2OTU2ODMwLCJuYmYiOjE0OTY5NTY4MzAsImV4cCI6MTQ5NzA0MzIzMH0.bjl0"
}Authenticate with remember mePOST/v1/auth/login
If there is a need for user to be logged in for extended period of time (max 1 year), value of true must be sent in remember-me key. This will issue a refresh token and refresh CSRF token in cookies, which can be used to refresh the access token once it is expired.
Note: Doing this will reduce the expiry time of access token from 24 hours to 1.5 hours to increase security
Example URI
POST https://api.eventyay.com/v1/auth/login
Request
Headers
Content-Type: application/jsonBody
{
"email": "email@example.com",
"password": "password",
"remember-me": true
}Response
200Headers
Content-Type: application/jsonBody
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZGVudGl0eSI6MSwiaWF0IjoxNDk2OTU2ODMwLCJuYmYiOjE0OTY5NTY4MzAsImV4cCI6MTQ5NzA0MzIzMH0.bjl0"
}Authenticate with remember me for mobilePOST/v1/auth/login
For mobile clients, dealing with cookies is not easy, and traditional problem of XSS and CSRF does not exist for them, so cookies are not required for them. They can send true in key include-in-response, which will not send cookies with request and send the refresh token in the response JSON
Example URI
POST https://api.eventyay.com/v1/auth/login
Request
Headers
Content-Type: application/jsonBody
{
"email": "email@example.com",
"password": "password",
"remember-me": true,
"include-in-response": true
}Response
200Headers
Content-Type: application/jsonBody
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NjQ4NTMwNzgsIm5iZiI6MTU2NDg1MzA3OCwianRpIjoiNzVjNTNiNTgtZmYzYy00NTEyLTk2YzktYjQ0NDQ0N2MzMTAwIiwiZXhwIjoxNTY0ODU4NDc4LCJpZGVudGl0eSI6MSwiZnJlc2giOnRydWUsInR5cGUiOiJhY2Nlc3MiLCJjc3JmIjoiZTk1ZmEzYTktNjMyYS00NGFhLWIzMDAtZmQ2NDI0MmE0ODU3In0.7lBrQW3wAWnwc7vWIBLh5p2a0KUzG42VyoHS8qM-OYs",
"refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NjQ4NTMwNzgsIm5iZiI6MTU2NDg1MzA3OCw3ODgtMzdlYS00YjE1LWE4YjktMjQ0YzYyN2I3NTljIMzg5MDc4LCJpZGVudGl0eSI6MSwidHlwZSI6InJlZnJlc2giLCJjc3JmIjoiNWZlZTdhYmYtNTIxNS00NzFhLWEwZWYtMDk4NmIzMTA3ODhhIn0.vQog__X9GHmfZSTpo_jtKQ_AsFq9idT0kpR7OLcAcmo"
}Re-Authentication ¶
Access Tokens generated via refresh tokens are not fresh. To generate fresh tokens, you need to re-authenticate. However, it is not a good idea to use login endpoint for re-authentication since it will recreate refresh tokens, and also there may be mismatch of currently authenticated user and reauthenticating credentials. This endpoint should be used with current access token in Authorization header to ensure that there is no mismatch. If the credentials are correct and matching with currently authenticated user, a new fresh access token will be generated.
Generate fresh tokenPOST/v1/auth/fresh-login
For mobile clients, dealing with cookies is not easy, and traditional problem of XSS and CSRF does not exist for them, so cookies are not required for them. They can send true in key include-in-response, which will not send cookies with request and send the refresh token in the response JSON
Example URI
POST https://api.eventyay.com/v1/auth/fresh-login
Request
Headers
Content-Type: application/json
Authorization: JWT <Auth Key>Body
{
"email": "email@example.com",
"password": "password"
}Response
200Headers
Content-Type: application/jsonBody
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NjQ4NTQyODIsIm5iZiI6MTU2NDg1NDI4MiwianRpIjoiZGM2MjU3MjMtZjYyMi00YmYzLTgxMGQtYTVmZTljMWNhMDIyIiwiZXhwIjoxNTY0OTQwNjgyLCJpZGVudGl0eSI6MSwiZnJlc2giOnRydWUsInR5cGUiOiJhY2Nlc3MiLCJjc3JmIjoiMDFkNDI2MmYtOGRiZS00MWEwLWI2OWUtODY1M2QzNTRkYTUyIn0.lscegFJqTeqsfpqBNC6t2E2_A38JYqriQh5wixQQOtU"
}API to verify password of signed in account ¶
API to verify password of signed in accountPOST/v1/auth/verify-password
API to verify password of signed in account using JWT token
Example URI
POST https://api.eventyay.com/v1/auth/verify-password
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE1NjQ4NTQyODIsIm5iZiI6MTU2NDg1NDI4MiwianRpIjoiZGM2MjU3MjMtZjYyMi00YmYzLTgxMGQtYTVmZTljMWNhMDIyIiwiZXhwIjoxNTY0OTQwNjgyLCJpZGVudGl0eSI6MSwiZnJlc2giOnRydWUsInR5cGUiOiJhY2Nlc3MiLCJjc3JmIjoiMDFkNDI2MmYtOGRiZS00MWEwLWI2OWUtODY1M2QzNTRkYTUyIn0.lscegFJqTeqsfpqBNC6t2E2_A38JYqriQh5wixQQOtUBody
{
"password": "password"
}Response
200Headers
Content-Type: application/jsonBody
{
"result": true
}Token Refresh ¶
Note: The access token generated by this method is not fresh. Which means it is good for all auth except sensitive APIs like changing password and changing email. This is done to increase security and prevent damage if a refresh token is leaked. If a fresh token is required, use the fresh-login endpoint above to re-authenticate
Access Token Refresh for WebPOST/v1/auth/token/refresh
For web clients, the refresh token is sent as a cookie back to the server, so they don’t need to attach it in the request, but they need to attach the value of csrf_refresh_token cookie as X-CSRF-Token header.
For security purposes, refresh token cookie is HttpOnly, so that JS cannot read it, mitigating XSS attacks, but to prevent CSRF attacks, csrf_refresh_token is used. So, it is readable by JS.
Example URI
POST https://api.eventyay.com/v1/auth/token/refresh
Request
Headers
X-CSRF-Token: e0b229be-629a-40b7-a0de-678f5aafd888Response
200Headers
Content-Type: application/jsonBody
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZGVudGl0eSI6MSwiaWF0IjoxNDk2OTU2ODMwLCJuYmYiOjE0OTY5NTY4MzAsImV4cCI6MTQ5NzA0MzIzMH0.bjl0"
}Access Token Refresh for mobilePOST/v1/auth/token/refresh
For mobile clients, CSRF token is not provided and not needed. They just need to use the refresh token instead of access token in Authorization header. So, instead of JWT <access_token>, they should use JWT <refresh_token> for this endpoint.
Example URI
POST https://api.eventyay.com/v1/auth/token/refresh
Request
Headers
Authorization: JWT <refresh_token>Response
200Headers
Content-Type: application/jsonBody
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZGVudGl0eSI6MSwiaWF0IjoxNDk2OTU2ODMwLCJuYmYiOjE0OTY5NTY4MzAsImV4cCI6MTQ5NzA0MzIzMH0.bjl0"
}Logout ¶
Optional: Logout endpoint should only be used for web clients which use refresh tokens. Refresh Tokens and their CSRF tokens are stored in cookies and hence need to be explicitly cleared when logging out.
LogoutPOST/v1/auth/logout
Example URI
POST https://api.eventyay.com/v1/auth/logout
Response
200Headers
Content-Type: application/jsonBody
{
"success": true
}Blacklist Tokens ¶
Any refresh token that was issued before this request is made will be invalidated and will not be able to be used for creating new access tokens
Blacklist TokensPOST/v1/auth/blacklist
Example URI
POST https://api.eventyay.com/v1/auth/blacklist
Response
200Headers
Content-Type: application/jsonBody
{
"success": true
}Users ¶
For using the API you need(mostly) to register as an user. Registering gives you access to all non admin API endpoints. After registration, you need to create your JWT access token to send requests to the API endpoints.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the user | string | - |
password |
Password of the user | string | yes |
email |
Email of the user | string | yes |
Users Collection ¶
List All UsersGET/v1/users{?sort,filter}
Get a list of Users.
Example URI
GET https://api.eventyay.com/v1/users?sort=email&filter=
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: email- filter
string(optional)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"events": {
"links": {
"self": "/v1/users/3/relationships/events",
"related": "/v1/users/3/events"
}
},
"alternate-emails": {
"links": {
"self": "/v1/users/1/relationships/alternate-emails",
"related": "/v1/users/1/alternate-emails"
}
},
"attendees": {
"links": {
"self": "/v1/users/3/relationships/attendees",
"related": "/v1/users/3/attendees"
}
},
"orders": {
"links": {
"self": "/v1/users/2/relationships/orders",
"related": "/v1/users/2/orders"
}
},
"email-notifications": {
"links": {
"self": "/v1/users/2/relationships/email-notifications",
"related": "/v1/users/2/email-notifications"
}
},
"discount-codes": {
"links": {
"self": "/v1/users/2/relationships/discount-codes",
"related": "/v1/users/2/discount-codes"
}
},
"sessions": {
"links": {
"self": "/v1/users/2/relationships/sessions",
"related": "/v1/users/2/sessions"
}
},
"coorganizer-events": {
"links": {
"self": "/v1/users/2/relationships/coorganizer-events",
"related": "/v1/events"
}
},
"speakers": {
"links": {
"self": "/v1/users/2/relationships/speakers",
"related": "/v1/users/2/speakers"
}
},
"moderator-events": {
"links": {
"self": "/v1/users/2/relationships/moderator-events",
"related": "/v1/events"
}
},
"notifications": {
"links": {
"self": "/v1/users/2/relationships/notifications",
"related": "/v1/users/2/notifications"
}
},
"track-organizer-events": {
"links": {
"self": "/v1/users/2/relationships/track-organizer-events",
"related": "/v1/events"
}
},
"marketer-events": {
"links": {
"self": "/v1/users/2/relationships/marketer-events",
"related": "/v1/events"
}
},
"sales-admin-events": {
"links": {
"self": "/v1/users/2/relationships/sales-admin-events",
"related": "/v1/events"
}
},
"access-codes": {
"links": {
"self": "/v1/users/2/relationships/access-codes",
"related": "/v1/users/2/access-codes"
}
},
"organizer-events": {
"links": {
"self": "/v1/users/2/relationships/organizer-events",
"related": "/v1/events"
}
},
"registrar-events": {
"links": {
"self": "/v1/users/2/relationships/registrar-events",
"related": "/v1/events"
}
}
},
"attributes": {
"is-admin": false,
"last-name": "Doe",
"instagram-url": "http://instagram.com/instagram",
"is-super-admin": false,
"is-sales-admin": false,
"is-marketer": false,
"thumbnail-image-url": "http://example.com/example.png",
"created-at": "2017-06-21T20:33:33.186358+00:00",
"last-accessed-at": null,
"email": "example@example.com",
"icon-image-url": "http://example.com/example.png",
"contact": "example",
"deleted-at": null,
"small-image-url": "http://example.com/example.png",
"facebook-url": "http://facebook.com/facebook",
"details": "example",
"is-verified": false,
"first-name": "John",
"avatar-url": "http://example.com/example.png",
"twitter-url": "http://twitter.com/twitter",
"google-plus-url": "http://plus.google.com/plus.google",
"facebook-id": "12345678",
"was-registered-with-order": false,
"is-user-owner": false,
"is-user-organizer": false,
"is-user-coorganizer": false,
"is-user-track-organizer": false,
"is-user-moderator": false,
"is-user-registrar": false
},
"type": "user",
"id": "2",
"links": {
"self": "/v1/users/2"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users"
}
}Create UserPOST/v1/users{?sort,filter}
Create a new user using an email, password and an optional name.
Example URI
POST https://api.eventyay.com/v1/users?sort=email&filter=
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: email- filter
string(optional)
Request
Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"email": "email@example.com",
"password": "password",
"avatar_url": "https://avatars2.githubusercontent.com/u/1583873",
"first-name": "John",
"last-name": "Doe",
"details": "example",
"contact": "example",
"facebook-url": "http://facebook.com/facebook",
"twitter-url": "http://twitter.com/twitter",
"instagram-url": "http://instagram.com/instagram",
"google-plus-url": "http://plus.google.com/plus.google",
"original-image-url": "https://cdn.pixabay.com/photo/2013/11/23/16/25/birds-216412_1280.jpg"
},
"type": "user"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/users/3/relationships/events",
"related": "/v1/users/3/events"
}
},
"alternate-emails": {
"links": {
"self": "/v1/users/3/relationships/alternate-emails",
"related": "/v1/users/3/alternate-emails"
}
},
"attendees": {
"links": {
"self": "/v1/users/3/relationships/attendees",
"related": "/v1/users/3/attendees"
}
},
"orders": {
"links": {
"self": "/v1/users/1/relationships/orders",
"related": "/v1/users/1/orders"
}
},
"email-notifications": {
"links": {
"self": "/v1/users/2/relationships/email-notifications",
"related": "/v1/users/2/email-notifications"
}
},
"discount-codes": {
"links": {
"self": "/v1/users/2/relationships/discount-codes",
"related": "/v1/users/2/discount-codes"
}
},
"sessions": {
"links": {
"self": "/v1/users/2/relationships/sessions",
"related": "/v1/users/2/sessions"
}
},
"coorganizer-events": {
"links": {
"self": "/v1/users/2/relationships/coorganizer-events",
"related": "/v1/events"
}
},
"speakers": {
"links": {
"self": "/v1/users/2/relationships/speakers",
"related": "/v1/users/2/speakers"
}
},
"moderator-events": {
"links": {
"self": "/v1/users/2/relationships/moderator-events",
"related": "/v1/events"
}
},
"marketer-events": {
"links": {
"self": "/v1/users/2/relationships/marketer-events",
"related": "/v1/events"
}
},
"sales-admin-events": {
"links": {
"self": "/v1/users/2/relationships/sales-admin-events",
"related": "/v1/events"
}
},
"notifications": {
"links": {
"self": "/v1/users/2/relationships/notifications",
"related": "/v1/users/2/notifications"
}
},
"track-organizer-events": {
"links": {
"self": "/v1/users/2/relationships/track-organizer-events",
"related": "/v1/events"
}
},
"access-codes": {
"links": {
"self": "/v1/users/2/relationships/access-codes",
"related": "/v1/users/2/access-codes"
}
},
"organizer-events": {
"links": {
"self": "/v1/users/2/relationships/organizer-events",
"related": "/v1/events"
}
},
"registrar-events": {
"links": {
"self": "/v1/users/2/relationships/registrar-events",
"related": "/v1/events"
}
}
},
"attributes": {
"is-admin": false,
"last-name": "Doe",
"instagram-url": "http://instagram.com/instagram",
"is-super-admin": false,
"is-sales-admin": false,
"is-marketer": false,
"thumbnail-image-url": "http://example.com/example.png",
"created-at": "2017-06-21T20:33:33.186358+00:00",
"last-accessed-at": null,
"email": "example@example.com",
"icon-image-url": "http://example.com/example.png",
"contact": "example",
"deleted-at": null,
"small-image-url": "http://example.com/example.png",
"facebook-url": "http://facebook.com/facebook",
"details": "example",
"is-verified": false,
"first-name": "John",
"avatar-url": "http://example.com/example.png",
"twitter-url": "http://twitter.com/twitter",
"google-plus-url": "http://plus.google.com/plus.google",
"facebook-id": null,
"was-registered-with-order": false,
"is-user-owner": false,
"is-user-organizer": false,
"is-user-coorganizer": false,
"is-user-track-organizer": false,
"is-user-moderator": false,
"is-user-registrar": false
},
"type": "user",
"id": "2",
"links": {
"self": "/v1/users/2"
}
}
}User Details ¶
Get DetailsGET/v1/users/{user_id}
Get a single user.
Example URI
GET https://api.eventyay.com/v1/users/2
URI Parameters
- user_id
integer(required) Example: 2ID of the user in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/users/3/relationships/events",
"related": "/v1/users/3/events"
}
},
"alternate-emails": {
"links": {
"self": "/v1/users/3/relationships/alternate-emails",
"related": "/v1/users/3/alternate-emails"
}
},
"attendees": {
"links": {
"self": "/v1/users/3/relationships/attendees",
"related": "/v1/users/3/attendees"
}
},
"orders": {
"links": {
"self": "/v1/users/1/relationships/orders",
"related": "/v1/users/1/orders"
}
},
"email-notifications": {
"links": {
"self": "/v1/users/2/relationships/email-notifications",
"related": "/v1/users/2/email-notifications"
}
},
"discount-codes": {
"links": {
"self": "/v1/users/2/relationships/discount-codes",
"related": "/v1/users/2/discount-codes"
}
},
"sessions": {
"links": {
"self": "/v1/users/2/relationships/sessions",
"related": "/v1/users/2/sessions"
}
},
"coorganizer-events": {
"links": {
"self": "/v1/users/2/relationships/coorganizer-events",
"related": "/v1/events"
}
},
"marketer-events": {
"links": {
"self": "/v1/users/2/relationships/marketer-events",
"related": "/v1/events"
}
},
"sales-admin-events": {
"links": {
"self": "/v1/users/2/relationships/sales-admin-events",
"related": "/v1/events"
}
},
"speakers": {
"links": {
"self": "/v1/users/2/relationships/speakers",
"related": "/v1/users/2/speakers"
}
},
"moderator-events": {
"links": {
"self": "/v1/users/2/relationships/moderator-events",
"related": "/v1/events"
}
},
"notifications": {
"links": {
"self": "/v1/users/2/relationships/notifications",
"related": "/v1/users/2/notifications"
}
},
"track-organizer-events": {
"links": {
"self": "/v1/users/2/relationships/track-organizer-events",
"related": "/v1/events"
}
},
"access-codes": {
"links": {
"self": "/v1/users/2/relationships/access-codes",
"related": "/v1/users/2/access-codes"
}
},
"organizer-events": {
"links": {
"self": "/v1/users/2/relationships/organizer-events",
"related": "/v1/events"
}
},
"registrar-events": {
"links": {
"self": "/v1/users/2/relationships/registrar-events",
"related": "/v1/events"
}
}
},
"attributes": {
"is-admin": false,
"last-name": "Doe",
"instagram-url": "http://instagram.com/instagram",
"is-super-admin": false,
"is-sales-admin": false,
"is-marketer": false,
"thumbnail-image-url": "http://example.com/example.png",
"created-at": "2017-06-21T20:33:33.186358+00:00",
"last-accessed-at": null,
"email": "example@example.com",
"icon-image-url": "http://example.com/example.png",
"contact": "example",
"deleted-at": null,
"small-image-url": "http://example.com/example.png",
"facebook-url": "http://facebook.com/facebook",
"details": "example",
"is-verified": false,
"first-name": "John",
"avatar-url": "http://example.com/example.png",
"twitter-url": "http://twitter.com/twitter",
"google-plus-url": "http://plus.google.com/plus.google",
"facebook-id": "123456",
"was-registered-with-order": false,
"is-user-owner": false,
"is-user-organizer": false,
"is-user-coorganizer": false,
"is-user-track-organizer": false,
"is-user-moderator": false,
"is-user-registrar": false
},
"type": "user",
"id": "2",
"links": {
"self": "/v1/users/2"
}
}
}Update UserPATCH/v1/users/{user_id}
id(integer) - ID of the record to update (required)
Update a single user by setting the email, email and/or name.
Authorized user should be same as user in request body or must be admin.
Example URI
PATCH https://api.eventyay.com/v1/users/2
URI Parameters
- user_id
integer(required) Example: 2ID of the user in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"password": "password",
"avatar_url": "https://avatars2.githubusercontent.com/u/1583873",
"first-name": "John",
"last-name": "Doe",
"details": "example1",
"contact": "example1",
"facebook-url": "http://facebook.com/facebook",
"twitter-url": "http://twitter.com/twitter",
"instagram-url": "http://instagram.com/instagram",
"google-plus-url": "http://plus.google.com/plus.google"
},
"type": "user",
"id": "2"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/users/3/relationships/events",
"related": "/v1/users/3/events"
}
},
"alternate-emails": {
"links": {
"self": "/v1/users/3/relationships/alternate-emails",
"related": "/v1/users/3/alternate-emails"
}
},
"attendees": {
"links": {
"self": "/v1/users/3/relationships/attendees",
"related": "/v1/users/3/attendees"
}
},
"orders": {
"links": {
"self": "/v1/users/1/relationships/orders",
"related": "/v1/users/1/orders"
}
},
"email-notifications": {
"links": {
"self": "/v1/users/2/relationships/email-notifications",
"related": "/v1/users/2/email-notifications"
}
},
"discount-codes": {
"links": {
"self": "/v1/users/2/relationships/discount-codes",
"related": "/v1/users/2/discount-codes"
}
},
"sessions": {
"links": {
"self": "/v1/users/2/relationships/sessions",
"related": "/v1/users/2/sessions"
}
},
"coorganizer-events": {
"links": {
"self": "/v1/users/2/relationships/coorganizer-events",
"related": "/v1/events"
}
},
"speakers": {
"links": {
"self": "/v1/users/2/relationships/speakers",
"related": "/v1/users/2/speakers"
}
},
"moderator-events": {
"links": {
"self": "/v1/users/2/relationships/moderator-events",
"related": "/v1/events"
}
},
"marketer-events": {
"links": {
"self": "/v1/users/2/relationships/marketer-events",
"related": "/v1/events"
}
},
"sales-admin-events": {
"links": {
"self": "/v1/users/2/relationships/sales-admin-events",
"related": "/v1/events"
}
},
"notifications": {
"links": {
"self": "/v1/users/2/relationships/notifications",
"related": "/v1/users/2/notifications"
}
},
"track-organizer-events": {
"links": {
"self": "/v1/users/2/relationships/track-organizer-events",
"related": "/v1/events"
}
},
"access-codes": {
"links": {
"self": "/v1/users/2/relationships/access-codes",
"related": "/v1/users/2/access-codes"
}
},
"organizer-events": {
"links": {
"self": "/v1/users/2/relationships/organizer-events",
"related": "/v1/events"
}
},
"registrar-events": {
"links": {
"self": "/v1/users/2/relationships/registrar-events",
"related": "/v1/events"
}
}
},
"attributes": {
"is-admin": false,
"last-name": "Doe",
"instagram-url": "http://instagram.com/instagram",
"is-super-admin": false,
"is-sales-admin": false,
"is-marketer": false,
"thumbnail-image-url": "http://example.com/example.png",
"created-at": "2017-06-21T20:33:33.186358+00:00",
"last-accessed-at": null,
"email": "example@example.com",
"icon-image-url": "http://example.com/example.png",
"contact": "example",
"deleted-at": null,
"small-image-url": "http://example.com/example.png",
"facebook-url": "http://facebook.com/facebook",
"details": "example",
"is-verified": false,
"first-name": "John",
"avatar-url": "http://example.com/example.png",
"twitter-url": "http://twitter.com/twitter",
"google-plus-url": "http://plus.google.com/plus.google",
"facebook-id": "123456",
"was-registered-with-order": false,
"is-user-owner": false,
"is-user-organizer": false,
"is-user-coorganizer": false,
"is-user-track-organizer": false,
"is-user-moderator": false,
"is-user-registrar": false
},
"type": "user",
"id": "2",
"links": {
"self": "/v1/users/2"
}
}
}Delete UserDELETE/v1/users/{user_id}
Delete a single user.
Example URI
DELETE https://api.eventyay.com/v1/users/2
URI Parameters
- user_id
integer(required) Example: 2ID of the user in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Get User Details for a Notification ¶
Get User Details for a NotificationGET/v1/notifications/{notification_id}/user
Get the details of the user.
Example URI
GET https://api.eventyay.com/v1/notifications/1/user
URI Parameters
- notification_id
integer(required) Example: 1ID of the notification in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"email-notifications": {
"links": {
"self": "/v1/users/1/relationships/email-notifications",
"related": "/v1/users/1/email-notifications"
}
},
"alternate-emails": {
"links": {
"self": "/v1/users/1/relationships/alternate-emails",
"related": "/v1/users/1/alternate-emails"
}
},
"notifications": {
"links": {
"self": "/v1/users/1/relationships/notifications",
"related": "/v1/users/1/notifications"
}
},
"orders": {
"links": {
"self": "/v1/users/1/relationships/orders",
"related": "/v1/users/1/orders"
}
},
"discount-codes": {
"links": {
"self": "/v1/users/1/relationships/discount-codes",
"related": "/v1/users/1/discount-codes"
}
},
"access-codes": {
"links": {
"self": "/v1/users/1/relationships/access-codes",
"related": "/v1/users/1/access-codes"
}
},
"speakers": {
"links": {
"self": "/v1/users/1/relationships/speakers",
"related": "/v1/users/1/speakers"
}
},
"sessions": {
"links": {
"self": "/v1/users/1/relationships/sessions",
"related": "/v1/users/1/sessions"
}
}
},
"attributes": {
"is-admin": true,
"thumbnail-image-url": null,
"last-name": null,
"icon-image-url": null,
"instagram-url": null,
"is-super-admin": true,
"is-sales-admin": false,
"is-marketer": false,
"original-image-url": null,
"created-at": "2017-07-21T15:06:20.741290+00:00",
"last-accessed-at": null,
"avatar-url": null,
"email": "enigmaeth@gmail.com",
"contact": null,
"google-plus-url": null,
"twitter-url": null,
"facebook-url": null,
"is-verified": true,
"first-name": null,
"deleted-at": null,
"small-image-url": null,
"details": null,
"facebook-id": "123456",
"was-registered-with-order": false,
"is-user-owner": false,
"is-user-organizer": false,
"is-user-coorganizer": false,
"is-user-track-organizer": false,
"is-user-moderator": false,
"is-user-registrar": false
},
"type": "user",
"id": "1",
"links": {
"self": "/v1/users/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/1"
}
}Get User Details for an Event Invoice ¶
Get User Details for an Event InvoiceGET/v1/event-invoices/{event_invoice_id}/user
Get the details of the user.
Example URI
GET https://api.eventyay.com/v1/event-invoices/1/user
URI Parameters
- event_invoice_id
integer(required) Example: 1ID of the event invoice in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"email-notifications": {
"links": {
"self": "/v1/users/1/relationships/email-notifications",
"related": "/v1/users/1/email-notifications"
}
},
"alternate-emails": {
"links": {
"self": "/v1/users/1/relationships/alternate-emails",
"related": "/v1/users/1/alternate-emails"
}
},
"notifications": {
"links": {
"self": "/v1/users/1/relationships/notifications",
"related": "/v1/users/1/notifications"
}
},
"orders": {
"links": {
"self": "/v1/users/1/relationships/orders",
"related": "/v1/users/1/orders"
}
},
"discount-codes": {
"links": {
"self": "/v1/users/1/relationships/discount-codes",
"related": "/v1/users/1/discount-codes"
}
},
"access-codes": {
"links": {
"self": "/v1/users/1/relationships/access-codes",
"related": "/v1/users/1/access-codes"
}
},
"speakers": {
"links": {
"self": "/v1/users/1/relationships/speakers",
"related": "/v1/users/1/speakers"
}
},
"sessions": {
"links": {
"self": "/v1/users/1/relationships/sessions",
"related": "/v1/users/1/sessions"
}
}
},
"attributes": {
"is-admin": true,
"thumbnail-image-url": null,
"last-name": null,
"icon-image-url": null,
"instagram-url": null,
"is-super-admin": true,
"is-sales-admin": false,
"is-marketer": false,
"original-image-url": null,
"created-at": "2017-07-21T15:06:20.741290+00:00",
"last-accessed-at": null,
"avatar-url": null,
"email": "enigmaeth@gmail.com",
"contact": null,
"google-plus-url": null,
"twitter-url": null,
"facebook-url": null,
"is-verified": true,
"first-name": null,
"deleted-at": null,
"small-image-url": null,
"details": null,
"facebook-id": "123456",
"was-registered-with-order": false,
"is-user-owner": false,
"is-user-organizer": false,
"is-user-coorganizer": false,
"is-user-track-organizer": false,
"is-user-moderator": false,
"is-user-registrar": false
},
"type": "user",
"id": "1",
"links": {
"self": "/v1/users/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/1"
}
}Get User Details for a Speaker ¶
Get User Details for a SpeakerGET/v1/speakers/{speaker_id}/user
Get the details of the user.
Example URI
GET https://api.eventyay.com/v1/speakers/1/user
URI Parameters
- speaker_id
integer(required) Example: 1ID of the speaker in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"email-notifications": {
"links": {
"self": "/v1/users/1/relationships/email-notifications",
"related": "/v1/users/1/email-notifications"
}
},
"alternate-emails": {
"links": {
"self": "/v1/users/1/relationships/alternate-emails",
"related": "/v1/users/1/alternate-emails"
}
},
"notifications": {
"links": {
"self": "/v1/users/1/relationships/notifications",
"related": "/v1/users/1/notifications"
}
},
"orders": {
"links": {
"self": "/v1/users/1/relationships/orders",
"related": "/v1/users/1/orders"
}
},
"discount-codes": {
"links": {
"self": "/v1/users/1/relationships/discount-codes",
"related": "/v1/users/1/discount-codes"
}
},
"access-codes": {
"links": {
"self": "/v1/users/1/relationships/access-codes",
"related": "/v1/users/1/access-codes"
}
},
"speakers": {
"links": {
"self": "/v1/users/1/relationships/speakers",
"related": "/v1/users/1/speakers"
}
},
"sessions": {
"links": {
"self": "/v1/users/1/relationships/sessions",
"related": "/v1/users/1/sessions"
}
}
},
"attributes": {
"is-admin": true,
"is-sales-admin": false,
"is-marketer": false,
"thumbnail-image-url": null,
"last-name": null,
"icon-image-url": null,
"instagram-url": null,
"is-super-admin": true,
"original-image-url": null,
"created-at": "2017-07-21T15:06:20.741290+00:00",
"last-accessed-at": null,
"avatar-url": null,
"email": "enigmaeth@gmail.com",
"contact": null,
"google-plus-url": null,
"twitter-url": null,
"facebook-url": null,
"is-verified": true,
"first-name": null,
"deleted-at": null,
"small-image-url": null,
"details": null,
"facebook-id": "123456",
"was-registered-with-order": false,
"is-user-owner": false,
"is-user-organizer": false,
"is-user-coorganizer": false,
"is-user-track-organizer": false,
"is-user-moderator": false,
"is-user-registrar": false
},
"type": "user",
"id": "1",
"links": {
"self": "/v1/users/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/1"
}
}Get User Details for an Access Code ¶
Get User Details for an Access CodeGET/v1/access-codes/{access_code_id}/marketer
Get the details of the user.
Example URI
GET https://api.eventyay.com/v1/access-codes/1/marketer
URI Parameters
- access_code_id
integer(required) Example: 1ID of the access code in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"email-notifications": {
"links": {
"self": "/v1/users/1/relationships/email-notifications",
"related": "/v1/users/1/email-notifications"
}
},
"alternate-emails": {
"links": {
"self": "/v1/users/1/relationships/alternate-emails",
"related": "/v1/users/1/alternate-emails"
}
},
"notifications": {
"links": {
"self": "/v1/users/1/relationships/notifications",
"related": "/v1/users/1/notifications"
}
},
"orders": {
"links": {
"self": "/v1/users/1/relationships/orders",
"related": "/v1/users/1/orders"
}
},
"discount-codes": {
"links": {
"self": "/v1/users/1/relationships/discount-codes",
"related": "/v1/users/1/discount-codes"
}
},
"access-codes": {
"links": {
"self": "/v1/users/1/relationships/access-codes",
"related": "/v1/users/1/access-codes"
}
},
"speakers": {
"links": {
"self": "/v1/users/1/relationships/speakers",
"related": "/v1/users/1/speakers"
}
},
"sessions": {
"links": {
"self": "/v1/users/1/relationships/sessions",
"related": "/v1/users/1/sessions"
}
}
},
"attributes": {
"is-admin": true,
"thumbnail-image-url": null,
"last-name": null,
"icon-image-url": null,
"instagram-url": null,
"is-super-admin": true,
"is-sales-admin": false,
"is-marketer": false,
"original-image-url": null,
"created-at": "2017-07-21T15:06:20.741290+00:00",
"last-accessed-at": null,
"avatar-url": null,
"email": "enigmaeth@gmail.com",
"contact": null,
"google-plus-url": null,
"twitter-url": null,
"facebook-url": null,
"is-verified": true,
"first-name": null,
"deleted-at": null,
"small-image-url": null,
"details": null,
"facebook-id": "123456",
"was-registered-with-order": false,
"is-user-owner": false,
"is-user-organizer": false,
"is-user-coorganizer": false,
"is-user-track-organizer": false,
"is-user-moderator": false,
"is-user-registrar": false
},
"type": "user",
"id": "1",
"links": {
"self": "/v1/users/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/1"
}
}Get User Details for an Email Notification ¶
Get User Details for an Email NotificationGET/v1/email-notifications/{email_notification_id}/user
Get the details of the user.
Example URI
GET https://api.eventyay.com/v1/email-notifications/1/user
URI Parameters
- email_notification_id
integer(required) Example: 1ID of the email notification in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"email-notifications": {
"links": {
"self": "/v1/users/1/relationships/email-notifications",
"related": "/v1/users/1/email-notifications"
}
},
"alternate-emails": {
"links": {
"self": "/v1/users/1/relationships/alternate-emails",
"related": "/v1/users/1/alternate-emails"
}
},
"notifications": {
"links": {
"self": "/v1/users/1/relationships/notifications",
"related": "/v1/users/1/notifications"
}
},
"orders": {
"links": {
"self": "/v1/users/1/relationships/orders",
"related": "/v1/users/1/orders"
}
},
"discount-codes": {
"links": {
"self": "/v1/users/1/relationships/discount-codes",
"related": "/v1/users/1/discount-codes"
}
},
"access-codes": {
"links": {
"self": "/v1/users/1/relationships/access-codes",
"related": "/v1/users/1/access-codes"
}
},
"speakers": {
"links": {
"self": "/v1/users/1/relationships/speakers",
"related": "/v1/users/1/speakers"
}
},
"sessions": {
"links": {
"self": "/v1/users/1/relationships/sessions",
"related": "/v1/users/1/sessions"
}
}
},
"attributes": {
"is-admin": true,
"is-sales-admin": false,
"is-marketer": false,
"thumbnail-image-url": null,
"last-name": null,
"icon-image-url": null,
"instagram-url": null,
"is-super-admin": true,
"original-image-url": null,
"created-at": "2017-07-21T15:06:20.741290+00:00",
"last-accessed-at": null,
"avatar-url": null,
"email": "enigmaeth@gmail.com",
"contact": null,
"google-plus-url": null,
"twitter-url": null,
"facebook-url": null,
"is-verified": true,
"first-name": null,
"deleted-at": null,
"small-image-url": null,
"details": null,
"facebook-id": "123456",
"was-registered-with-order": false,
"is-user-owner": false,
"is-user-organizer": false,
"is-user-coorganizer": false,
"is-user-track-organizer": false,
"is-user-moderator": false,
"is-user-registrar": false
},
"type": "user",
"id": "1",
"links": {
"self": "/v1/users/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/1"
}
}Get User Details for a Discount Code ¶
Get User Details for a Discount CodeGET/v1/discount-codes/{discount_code_id}/marketer
Get the details of the user.
Example URI
GET https://api.eventyay.com/v1/discount-codes/1/marketer
URI Parameters
- discount_code_id
integer(required) Example: 1ID of the discount code in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"email-notifications": {
"links": {
"self": "/v1/users/1/relationships/email-notifications",
"related": "/v1/users/1/email-notifications"
}
},
"alternate-emails": {
"links": {
"self": "/v1/users/1/relationships/alternate-emails",
"related": "/v1/users/1/alternate-emails"
}
},
"notifications": {
"links": {
"self": "/v1/users/1/relationships/notifications",
"related": "/v1/users/1/notifications"
}
},
"orders": {
"links": {
"self": "/v1/users/1/relationships/orders",
"related": "/v1/users/1/orders"
}
},
"discount-codes": {
"links": {
"self": "/v1/users/1/relationships/discount-codes",
"related": "/v1/users/1/discount-codes"
}
},
"access-codes": {
"links": {
"self": "/v1/users/1/relationships/access-codes",
"related": "/v1/users/1/access-codes"
}
},
"speakers": {
"links": {
"self": "/v1/users/1/relationships/speakers",
"related": "/v1/users/1/speakers"
}
},
"sessions": {
"links": {
"self": "/v1/users/1/relationships/sessions",
"related": "/v1/users/1/sessions"
}
}
},
"attributes": {
"is-admin": true,
"is-sales-admin": false,
"is-marketer": false,
"thumbnail-image-url": null,
"last-name": null,
"icon-image-url": null,
"instagram-url": null,
"is-super-admin": true,
"original-image-url": null,
"created-at": "2017-07-21T15:06:20.741290+00:00",
"last-accessed-at": null,
"avatar-url": null,
"email": "enigmaeth@gmail.com",
"contact": null,
"google-plus-url": null,
"twitter-url": null,
"facebook-url": null,
"is-verified": true,
"first-name": null,
"deleted-at": null,
"small-image-url": null,
"details": null,
"facebook-id": "123456",
"was-registered-with-order": false,
"is-user-owner": false,
"is-user-organizer": false,
"is-user-coorganizer": false,
"is-user-track-organizer": false,
"is-user-moderator": false,
"is-user-registrar": false
},
"type": "user",
"id": "1",
"links": {
"self": "/v1/users/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/1"
}
}Check if the email is available ¶
Check if the email passed is available or not. True is returned if the email is available, false otherwise.
Check if email is availablePOST/v1/users/check_email
Example URI
POST https://api.eventyay.com/v1/users/check_email
Request
Headers
Accept: application/json
Content-Type: application/jsonBody
{
"email": "test@example.com"
}Response
200Headers
Content-Type: application/jsonBody
{
"exists": true
}Get User ID ¶
Get User IDGET/v1/users/user-details/get-user-id
Get the user id using JWT token
Example URI
GET https://api.eventyay.com/v1/users/user-details/get-user-id
Request
Headers
Accept: application/json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"user_id": "2"
}Event Locations ¶
Event Locations for Events.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the event type | string | - |
slug |
Slug of the event type | string | - |
Event Locations Collection ¶
List All Event LocationsGET/v1/event-locations{?sort}
Get a list of Event Locations.
Example URI
GET https://api.eventyay.com/v1/event-locations?sort=name
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "event-location",
"attributes": {
"slug": "india",
"name": "India"
},
"id": "1"
},
{
"type": "event-location",
"attributes": {
"slug": "singapore",
"name": "Singapore"
},
"id": "2"
},
{
"type": "event-location",
"attributes": {
"slug": "berlin",
"name": "Berlin"
},
"id": "3"
},
{
"type": "event-location",
"attributes": {
"slug": "new-york",
"name": "New York"
},
"id": "4"
},
{
"type": "event-location",
"attributes": {
"slug": "hong-kong",
"name": "Hong Kong"
},
"id": "5"
}
],
"links": {
"self": "/v1/event-locations"
},
"meta": {
"count": 5
},
"jsonapi": {
"version": "1.0"
}
}Event Types ¶
Event Types for Events. Can only be edited and entered by admins.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the event type | string | - |
slug |
Slug of the event type | string | - |
Event Types Collection ¶
List All Event TypesGET/v1/event-types{?sort}
Get a list of Event Types.
Example URI
GET https://api.eventyay.com/v1/event-types?sort=name
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"events": {
"links": {
"self": "/v1/event-types/1/relationships/events",
"related": "/v1/event-types/1/events"
}
}
},
"attributes": {
"name": "Camp, Treat & Retreat",
"slug": "camp-treat-retreat"
},
"type": "event-type",
"id": "1",
"links": {
"self": "/v1/event-types/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-types"
}
}Create Event TypePOST/v1/event-types{?sort}
Create a new event type with name.
Example URI
POST https://api.eventyay.com/v1/event-types?sort=name
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "Camp, Treat & Retreat"
},
"type": "event-type"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-types/1/relationships/events",
"related": "/v1/event-types/1/events"
}
}
},
"attributes": {
"name": "Camp, Treat & Retreat",
"slug": "camp-treat-retreat"
},
"type": "event-type",
"id": "1",
"links": {
"self": "/v1/event-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-types/1"
}
}Event Type Details ¶
Event Type DetailsGET/v1/event-types/{event_type_id}
Get a single event type.
Example URI
GET https://api.eventyay.com/v1/event-types/1
URI Parameters
- event_type_id
integer(required) Example: 1ID of the event type in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-types/1/relationships/events",
"related": "/v1/event-types/1/events"
}
}
},
"attributes": {
"name": "Camp, Treat & Retreat",
"slug": "camp-treat-retreat"
},
"type": "event-type",
"id": "1",
"links": {
"self": "/v1/event-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-types/1"
}
}Update Event TypePATCH/v1/event-types/{event_type_id}
id(integer) - ID of the record to update (required)
Update a single event type by setting name.
Authorized user must be admin.
Example URI
PATCH https://api.eventyay.com/v1/event-types/1
URI Parameters
- event_type_id
integer(required) Example: 1ID of the event type in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "Camp, Treat & Retreat"
},
"type": "event-type",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-types/1/relationships/events",
"related": "/v1/event-types/1/events"
}
}
},
"attributes": {
"name": "Camp, Treat & Retreat",
"slug": "camp-treat-retreat"
},
"type": "event-type",
"id": "1",
"links": {
"self": "/v1/event-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-types/1"
}
}Delete Event TypeDELETE/v1/event-types/{event_type_id}
Delete a single event type.
Example URI
DELETE https://api.eventyay.com/v1/event-types/1
URI Parameters
- event_type_id
integer(required) Example: 1ID of the event type in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Event Type of an Event ¶
Event Type Details of an EventGET/v1/events/{event_identifier}/event-type
Get a single event type.
Example URI
GET https://api.eventyay.com/v1/events/1/event-type
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-types/1/relationships/events",
"related": "/v1/event-types/1/events"
}
}
},
"attributes": {
"name": "Camp, Treat & Retreat",
"slug": "camp-treat-retreat"
},
"type": "event-type",
"id": "1",
"links": {
"self": "/v1/event-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-types/1"
}
}Event Topics ¶
Event Topics for Events. Can only be edited and entered by admins.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the event topic | string | - |
slug |
Slug of the event topic | string | - |
system-image-url |
Url of system image of event topic | string | - |
Event Topics Collection ¶
List All Event TopicsGET/v1/event-topics{?sort}
Get a list of Event Topics.
Example URI
GET https://api.eventyay.com/v1/event-topics?sort=name
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-topics/1/events"
}
},
"event-sub-topics": {
"links": {
"self": "/v1/event-topics/1/relationships/event-sub-topics",
"related": "/v1/event-topics/1/event-sub-topics"
}
}
},
"attributes": {
"name": "Travel & Outdoor",
"slug": "travel-outdoor",
"system-image-url": "https://www.w3schools.com/html/pic_mountain.jpg"
},
"type": "event-topic",
"id": "1",
"links": {
"self": "/v1/event-topics/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-topics"
}
}Create Event TopicPOST/v1/event-topics{?sort}
Create a new event topic with name.
Example URI
POST https://api.eventyay.com/v1/event-topics?sort=name
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "Travel & Outdoor",
"system-image-url": "https://www.w3schools.com/html/pic_mountain.jpg"
},
"type": "event-topic"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-topics/1/events"
}
},
"event-sub-topics": {
"links": {
"self": "/v1/event-topics/1/relationships/event-sub-topics",
"related": "/v1/event-topics/1/event-sub-topics"
}
}
},
"attributes": {
"name": "Travel & Outdoor",
"slug": "travel-outdoor",
"system-image-url": "https://www.w3schools.com/html/pic_mountain.jpg"
},
"type": "event-topic",
"id": "1",
"links": {
"self": "/v1/event-topics/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-topics/1"
}
}Event Topic Details ¶
Event Topic DetailsGET/v1/event-topics/{event_topic_id}
Get a single event topic.
Example URI
GET https://api.eventyay.com/v1/event-topics/1
URI Parameters
- event_topic_id
integer(required) Example: 1ID of the event topic in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-topics/1/events"
}
},
"event-sub-topics": {
"links": {
"self": "/v1/event-topics/1/relationships/event-sub-topics",
"related": "/v1/event-topics/1/event-sub-topics"
}
}
},
"attributes": {
"name": "Travel & Outdoor",
"slug": "travel-outdoor",
"system-image-url": "https://www.w3schools.com/html/pic_mountain.jpg"
},
"type": "event-topic",
"id": "1",
"links": {
"self": "/v1/event-topics/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-topics/1"
}
}Update Event TopicPATCH/v1/event-topics/{event_topic_id}
id(integer) - ID of the record to update (required)
Update a single event topic by setting name.
Authorized user must be admin.
Example URI
PATCH https://api.eventyay.com/v1/event-topics/1
URI Parameters
- event_topic_id
integer(required) Example: 1ID of the event topic in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "Travel & Outdoor",
"system-image-url": "https://www.w3schools.com/html/pic_mountain.jpg"
},
"type": "event-topic",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-topics/1/events"
}
},
"event-sub-topics": {
"links": {
"self": "/v1/event-topics/1/relationships/event-sub-topics",
"related": "/v1/event-topics/1/event-sub-topics"
}
}
},
"attributes": {
"name": "Travel & Outdoor",
"slug": "travel-outdoor",
"system-image-url": "https://www.w3schools.com/html/pic_mountain.jpg"
},
"type": "event-type",
"id": "1",
"links": {
"self": "/v1/event-topics/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-topics/1"
}
}Delete Event TopicDELETE/v1/event-topics/{event_topic_id}
Delete a single event topic.
Example URI
DELETE https://api.eventyay.com/v1/event-topics/1
URI Parameters
- event_topic_id
integer(required) Example: 1ID of the event topic in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Event Topic of an Event ¶
Event Topic Details of an EventGET/v1/events/{event_identifier}/event-topic
Example URI
GET https://api.eventyay.com/v1/events/1/event-topic
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-topics/1/events"
}
},
"event-sub-topics": {
"links": {
"self": "/v1/event-topics/1/relationships/event-sub-topics",
"related": "/v1/event-topics/1/event-sub-topics"
}
}
},
"attributes": {
"slug": "travel-outdoor",
"name": "Travel & Outdoor",
"system-image-url": "https://www.w3schools.com/html/pic_mountain.jpg"
},
"type": "event-topic",
"id": "1",
"links": {
"self": "/v1/event-topics/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-topics/1"
}
}Event Topic of a Sub Topic ¶
Event Topic Details of a Sub TopicGET/v1/event-sub-topics/{event_sub_topic_id}/event-topic
Example URI
GET https://api.eventyay.com/v1/event-sub-topics/1/event-topic
URI Parameters
- event_sub_topic_id
integer(required) Example: 1ID of the event sub topic in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-topics/1/events"
}
},
"event-sub-topics": {
"links": {
"self": "/v1/event-topics/1/relationships/event-sub-topics",
"related": "/v1/event-topics/1/event-sub-topics"
}
}
},
"attributes": {
"slug": "travel-outdoor",
"name": "Travel & Outdoor",
"system-image-url": "https://www.w3schools.com/html/pic_mountain.jpg"
},
"type": "event-topic",
"id": "1",
"links": {
"self": "/v1/event-topics/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-topics/1"
}
}Event Sub Topics ¶
Event Sub Topics for Events. Can only be edited and entered by admins.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the event sub topic | string | - |
slug |
Slug of the event sub topic | string | - |
Event Sub Topics Collection Get ¶
List All Event Sub TopicsGET/v1/event-topics/{event_topic_id}/event-sub-topics{?sort}
Get a list of Event Sub Topics.
Example URI
GET https://api.eventyay.com/v1/event-topics/1/event-sub-topics?sort=name
URI Parameters
- event_topic_id
integer(required) Example: 1ID of the event topic.
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-sub-topics/1/events"
}
},
"event-topic": {
"links": {
"self": "/v1/event-sub-topics/1/relationships/event-topic",
"related": "/v1/event-sub-topics/1/event-topic"
}
}
},
"attributes": {
"slug": "climbing",
"name": "Climbing"
},
"type": "event-sub-topic",
"id": "1",
"links": {
"self": "/v1/event-sub-topics/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-topics/2/event-sub-topics"
}
}Event Sub Topics Collection Post ¶
Create Event Sub TopicPOST/v1/event-sub-topics{?sort}
Create a new event sub topic with name.
Example URI
POST https://api.eventyay.com/v1/event-sub-topics?sort=name
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event-topic": {
"data": {
"type": "event-topic",
"id": "1"
}
}
},
"attributes": {
"name": "Climbing"
},
"type": "event-sub-topic"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-sub-topics/1/events"
}
},
"event-topic": {
"links": {
"self": "/v1/event-sub-topics/1/relationships/event-topic",
"related": "/v1/event-sub-topics/1/event-topic"
}
}
},
"attributes": {
"name": "Climbing",
"slug": "climbing"
},
"type": "event-sub-topic",
"id": "1",
"links": {
"self": "/v1/event-sub-topics/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-sub-topics/1"
}
}Event Sub Topic Details ¶
Event Sub Topic DetailsGET/v1/event-sub-topics/{event_sub_topic_id}
Get a single event sub topic.
Example URI
GET https://api.eventyay.com/v1/event-sub-topics/1
URI Parameters
- event_sub_topic_id
integer(required) Example: 1ID of the event sub topic in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-sub-topics/1/events"
}
},
"event-topic": {
"links": {
"self": "/v1/event-sub-topics/1/relationships/event-topic",
"related": "/v1/event-sub-topics/1/event-topic"
}
}
},
"attributes": {
"name": "Climbing",
"slug": "climbing"
},
"type": "event-sub-topic",
"id": "1",
"links": {
"self": "/v1/event-sub-topics/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-sub-topics/1"
}
}Update Event Sub TopicPATCH/v1/event-sub-topics/{event_sub_topic_id}
id(integer) - ID of the record to update (required)
Update a single event topic by setting name.
Authorized user must be admin.
Example URI
PATCH https://api.eventyay.com/v1/event-sub-topics/1
URI Parameters
- event_sub_topic_id
integer(required) Example: 1ID of the event sub topic in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "Climbing"
},
"type": "event-sub-topic",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-sub-topics/1/events"
}
},
"event-topic": {
"links": {
"self": "/v1/event-sub-topics/1/relationships/event-topic",
"related": "/v1/event-sub-topics/1/event-topic"
}
}
},
"attributes": {
"name": "Climbing",
"slug": "climbing"
},
"type": "event-sub-type",
"id": "1",
"links": {
"self": "/v1/event-sub-topics/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-sub-topics/1"
}
}Delete Event Sub TopicDELETE/v1/event-sub-topics/{event_sub_topic_id}
Delete a single event sub topic.
Example URI
DELETE https://api.eventyay.com/v1/event-sub-topics/1
URI Parameters
- event_sub_topic_id
integer(required) Example: 1ID of the event sub topic in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Event Sub Topic of an Event ¶
Event Sub Topic Details of an EventGET/v1/events/{event_identifier}/event-sub-topic
Example URI
GET https://api.eventyay.com/v1/events/1/event-sub-topic
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-sub-topics/1/events"
}
},
"event-topic": {
"links": {
"self": "/v1/event-sub-topics/1/relationships/event-topic",
"related": "/v1/event-sub-topics/1/event-topic"
}
},
"custom-placeholder": {
"links": {
"self": "/v1/event-sub-topics/1/relationships/custom-placeholder",
"related": "/v1/event-sub-topics/1/custom-placeholder"
}
}
},
"attributes": {
"name": "Climbing",
"slug": "climbing"
},
"type": "event-sub-topic",
"id": "1",
"links": {
"self": "/v1/event-sub-topics/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-sub-topics/1"
}
}Event Sub Topic of Custom Placeholder ¶
Event Sub Topic Details of Custom PlaceholderGET/v1/custom-placeholders/{custom_placeholder_id}/event-sub-topic
Example URI
GET https://api.eventyay.com/v1/custom-placeholders/1/event-sub-topic
URI Parameters
- custom_placeholder_id
integer(required) Example: 1ID of the Custom Placeholder in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"events": {
"links": {
"self": "/v1/event-topics/1/relationships/events",
"related": "/v1/event-sub-topics/1/events"
}
},
"event-topic": {
"links": {
"self": "/v1/event-sub-topics/1/relationships/event-topic",
"related": "/v1/event-sub-topics/1/event-topic"
}
},
"custom-placeholder": {
"links": {
"self": "/v1/event-sub-topics/1/relationships/custom-placeholder",
"related": "/v1/event-sub-topics/1/custom-placeholder"
}
}
},
"attributes": {
"name": "Climbing",
"slug": "climbing"
},
"type": "event-sub-topic",
"id": "1",
"links": {
"self": "/v1/event-sub-topics/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-sub-topics/1"
}
}Custom Placeholders ¶
Data related to custom placeholder information.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name | string | yes |
original-image-url |
Url of the original image | string | yes |
copyright |
Copyright for the image | string | - |
origin |
origin of image | string | - |
thumbnail-image-url |
Thumbnail version of original image | string | - |
large-image-url |
Large version of original image | string | - |
icon-image-url |
Icon version of original image | string | - |
Custom Placeholders Collection ¶
List All Custom PlaceholdersGET/v1/custom-placeholders{?sort,filter}
Get a list of resources
Example URI
GET https://api.eventyay.com/v1/custom-placeholders?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event-sub-topic": {
"links": {
"self": "/v1/custom-placeholders/1/relationships/event-sub-topic",
"related": "/v1/custom-placeholders/1/event-sub-topic"
}
}
},
"attributes": {
"origin": "example",
"thumbnail-image-url": "http://localhost/static/media/custom-placeholders/1/thumbnail/Zk1mMHBHQV/b5ec1116-8671-4b75-8c65-387c8b114784.jpg",
"name": "example",
"copyright": "example",
"original-image-url": "http://localhost/static/media/custom-placeholders/1/original/UXYwdXcySV/e33a2f08-0d8c-47df-aa7d-47b132acf3a5.jpg",
"icon-image-url": "http://localhost/static/media/custom-placeholders/1/icon/bEY5Wk9ZNk/641c6ab8-a9fc-4759-afc9-e36579ae3ec9.jpg",
"large-image-url": "http://localhost/static/media/custom-placeholders/1/large/ak01T2xDTW/e5f0b4a3-f045-439a-89b5-7d1085fdaeb1.jpg"
},
"type": "custom-placeholder",
"id": 1,
"links": {
"self": "/v1/custom-placeholders/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/custom-placeholders"
}
}Create Custom PlaceholderPOST/v1/custom-placeholders{?sort,filter}
Create a new Custom Placeholder
Example URI
POST https://api.eventyay.com/v1/custom-placeholders?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "example",
"origin": "example",
"copyright": "example",
"original_image_url": "https://www.w3schools.com/html/pic_mountain.jpg"
},
"type": "custom-placeholder"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event-sub-topic": {
"links": {
"self": "/v1/custom-placeholders/1/relationships/event-sub-topic",
"related": "/v1/custom-placeholders/1/event-sub-topic"
}
}
},
"attributes": {
"origin": "example",
"thumbnail-image-url": "http://localhost/static/media/custom-placeholders/1/thumbnail/Zk1mMHBHQV/b5ec1116-8671-4b75-8c65-387c8b114784.jpg",
"name": "example",
"copyright": "example",
"original-image-url": "http://localhost/static/media/custom-placeholders/1/original/UXYwdXcySV/e33a2f08-0d8c-47df-aa7d-47b132acf3a5.jpg",
"icon-image-url": "http://localhost/static/media/custom-placeholders/1/icon/bEY5Wk9ZNk/641c6ab8-a9fc-4759-afc9-e36579ae3ec9.jpg",
"large-image-url": "http://localhost/static/media/custom-placeholders/1/large/ak01T2xDTW/e5f0b4a3-f045-439a-89b5-7d1085fdaeb1.jpg"
},
"type": "custom-placeholder",
"id": 1,
"links": {
"self": "/v1/custom-placeholders/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/custom-placeholders/1"
}
}Custom Placeholder Details ¶
Custom Placeholder DetailsGET/v1/custom-placeholders/{id}
Example URI
GET https://api.eventyay.com/v1/custom-placeholders/1
URI Parameters
- id
integer(required) Example: 1ID of the Custom Placeholder in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event-sub-topic": {
"links": {
"self": "/v1/custom-placeholders/1/relationships/event-sub-topic",
"related": "/v1/custom-placeholders/1/event-sub-topic"
}
}
},
"attributes": {
"origin": "example",
"thumbnail-image-url": "http://localhost/static/media/custom-placeholders/1/thumbnail/Zk1mMHBHQV/b5ec1116-8671-4b75-8c65-387c8b114784.jpg",
"name": "example",
"copyright": "example",
"original-image-url": "http://localhost/static/media/custom-placeholders/1/original/UXYwdXcySV/e33a2f08-0d8c-47df-aa7d-47b132acf3a5.jpg",
"icon-image-url": "http://localhost/static/media/custom-placeholders/1/icon/bEY5Wk9ZNk/641c6ab8-a9fc-4759-afc9-e36579ae3ec9.jpg",
"large-image-url": "http://localhost/static/media/custom-placeholders/1/large/ak01T2xDTW/e5f0b4a3-f045-439a-89b5-7d1085fdaeb1.jpg"
},
"type": "custom-placeholder",
"id": 1,
"links": {
"self": "/v1/custom-placeholders/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/custom-placeholders/1"
}
}Update Custom PlaceholderPATCH/v1/custom-placeholders/{id}
Update a single custom placeholder by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/custom-placeholders/1
URI Parameters
- id
integer(required) Example: 1ID of the Custom Placeholder in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "example",
"origin": "example",
"copyright": "example",
"original_image_url": "https://www.w3schools.com/html/pic_mountain.jpg"
},
"type": "custom-placeholder",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event-sub-topic": {
"links": {
"self": "/v1/custom-placeholders/1/relationships/event-sub-topic",
"related": "/v1/custom-placeholders/1/event-sub-topic"
}
}
},
"attributes": {
"origin": "example",
"thumbnail-image-url": "http://localhost/static/media/custom-placeholders/1/thumbnail/Zk1mMHBHQV/b5ec1116-8671-4b75-8c65-387c8b114784.jpg",
"name": "example",
"copyright": "example",
"original-image-url": "http://localhost/static/media/custom-placeholders/1/original/UXYwdXcySV/e33a2f08-0d8c-47df-aa7d-47b132acf3a5.jpg",
"icon-image-url": "http://localhost/static/media/custom-placeholders/1/icon/bEY5Wk9ZNk/641c6ab8-a9fc-4759-afc9-e36579ae3ec9.jpg",
"large-image-url": "http://localhost/static/media/custom-placeholders/1/large/ak01T2xDTW/e5f0b4a3-f045-439a-89b5-7d1085fdaeb1.jpg"
},
"type": "custom-placeholder",
"id": 1,
"links": {
"self": "/v1/custom-placeholders/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/custom-placeholders/1"
}
}Delete Custom PlaceholderDELETE/v1/custom-placeholders/{id}
Delete a single resource.
Example URI
DELETE https://api.eventyay.com/v1/custom-placeholders/1
URI Parameters
- id
integer(required) Example: 1ID of the Custom Placeholder in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Custom Placeholder Details of Event Sub-topic ¶
Custom Placeholder Details of Event Sub-topicGET/v1/event-sub-topics/{event_sub_topic_id}/custom-placeholder
Example URI
GET https://api.eventyay.com/v1/event-sub-topics/1/custom-placeholder
URI Parameters
- event_sub_topic_id
integer(required) Example: 1ID of the event sub-topic in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event-sub-topic": {
"links": {
"self": "/v1/custom-placeholders/1/relationships/event-sub-topic",
"related": "/v1/custom-placeholders/1/event-sub-topic"
}
}
},
"attributes": {
"origin": "example",
"thumbnail-image-url": "http://localhost/static/media/custom-placeholders/1/thumbnail/Zk1mMHBHQV/b5ec1116-8671-4b75-8c65-387c8b114784.jpg",
"name": "example",
"copyright": "example",
"original-image-url": "http://localhost/static/media/custom-placeholders/1/original/UXYwdXcySV/e33a2f08-0d8c-47df-aa7d-47b132acf3a5.jpg",
"icon-image-url": "http://localhost/static/media/custom-placeholders/1/icon/bEY5Wk9ZNk/641c6ab8-a9fc-4759-afc9-e36579ae3ec9.jpg",
"large-image-url": "http://localhost/static/media/custom-placeholders/1/large/ak01T2xDTW/e5f0b4a3-f045-439a-89b5-7d1085fdaeb1.jpg"
},
"type": "custom-placeholder",
"id": 1,
"links": {
"self": "/v1/custom-placeholders/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-sub-topics/1/custom-placeholder"
}
}Events ¶
These endpoints help you to create the basic event structure. To add other parts of the event such as ticket, sponsor, copyright, etc. there are separate endpoints.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the event | string | yes |
starts-at |
Start time of the event | ISO 8601 (tz-aware) | yes |
ends-at |
End time of the event | ISO 8601 (tz-aware) | yes |
timezone |
Timezone of the event | string | yes |
location-name |
Name of the event location | string | - |
logo-url |
URL of the logo uploaded | string | - |
latitude |
Latitude of the event location | float | - |
longitude |
Longitude of the event location | float | - |
description |
Description of the event | String | - |
searchable-location-name |
Search friendly name of the event location | string | - |
owner-name |
Name of the event organizer | string | - |
owner-description |
Additional details about the event organizer | string | - |
description |
Event’s description | string | - |
is-map-shown |
Should the map be shown on public page | boolean (default: false) |
- |
is-sessions-speakers-enabled |
Does the event have sessions & speakers | boolean (default: false) |
- |
privacy |
Should the event be listed publicly | string (default: public) |
- |
state |
Current state of the event | string (default: draft) |
- |
event_type_id |
Type of the event | Integer | - |
event_topic_id |
Topic of the event | Integer | - |
sub-topic |
Sub-topic of the event | string | - |
ticket-url |
The ticketing URL of the event | string | - |
code-of-conduct |
Event’s code of conduct | string | - |
thumbnail-image-url |
URL of the uploaded thumbnail | string | - |
large-image-url |
URL of the large uploaded banner image | string | - |
original-image-url |
URL of the original image | string | - |
icon-image-url |
URL of the icon image | string | - |
scheduled-published-on |
- | ISO 8601 (tz-aware) | - |
deleted-at |
Event deleted date | ISO 8601 (tz-aware) | - |
payment-country |
- | string | - |
payment-currency |
- | string | - |
paypal-email |
- | string | - |
tax-allow |
Is tax allowed on event | boolean (default: false) |
- |
can-pay-by-paypal |
- | boolean (default: false) |
- |
can-pay-by-stripe |
- | boolean (default: false) |
- |
can-pay-by-cheque |
- | boolean (default: false) |
- |
can-pay-by-omise |
- | boolean (default: false) |
- |
can-pay-onsite |
- | boolean (default: false) |
- |
cheque-details |
- | string | - |
bank-details |
- | string | - |
onsite-details |
- | string | - |
is-sponsors-enabled |
- | boolean (default: false) |
- |
identifier |
- | string | - |
external-event-url |
- | string | - |
has-owner-info |
- | boolean(default: false) |
- |
refund-policy |
Refund policy | string | - |
is-stripe-linked |
Shows if the event has a linked stripe account. | boolean(default: false) |
- |
Events Collection ¶
List All EventsGET/v1/events{?sort,filter}
Get a list of events.
Example URI
GET https://api.eventyay.com/v1/events?sort=identifier&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: identifier- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"orders": {
"links": {
"self": "/v1/events/1/relationships/orders",
"related": "/v1/orders"
}
},
"owner": {
"links": {
"self": "/v1/events/1/relationships/owner",
"related": "/v1/events/1/owner"
}
},
"organizers": {
"links": {
"self": "/v1/events/1/relationships/organizers",
"related": "/v1/users"
}
},
"coorganizers": {
"links": {
"self": "/v1/events/1/relationships/coorganizers",
"related": "/v1/users"
}
},
"track-organizers": {
"links": {
"self": "/v1/events/1/relationships/track-coorganizers",
"related": "/v1/users"
}
},
"registrars": {
"links": {
"self": "/v1/events/1/relationships/registrars",
"related": "/v1/users"
}
},
"moderators": {
"links": {
"self": "/v1/events/1/relationships/moderators",
"related": "/v1/users"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"faq-types": {
"links": {
"self": "/v1/events/1/relationships/faq-types",
"related": "/v1/events/1/faq-types"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"thumbnail-image-url": null,
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "http://example.com/example.png",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"online": false,
"has-owner-info": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"code-of-conduct": "example",
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "example",
"can-pay-by-cheque": true,
"can-pay-by-omise": false,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"external-event-url": null,
"is-tax-enabled": true,
"icon-image-url": null,
"ical-url": null,
"name": "example",
"can-pay-by-bank": true,
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"created-at": "2017-06-26T15:22:37.205399+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"identifier": "b8324ae2",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events"
}
}Create EventPOST/v1/events{?sort,filter}
Create a new event using a name, starts-at, ends-at, timezone and an optional content body.
Example URI
POST https://api.eventyay.com/v1/events?sort=identifier&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: identifier- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "example",
"external-event-url": "http://example.com",
"starts-at": "2099-12-13T23:59:59.123456+00:00",
"ends-at": "2099-12-14T23:59:59.123456+00:00",
"timezone": "UTC",
"latitude": "1.23456789",
"longitude": "1.23456789",
"logo-url": "http://example.com/example.png",
"location-name": "example",
"searchable-location-name": "example",
"description": "example",
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"owner-name": "example",
"is-map-shown": "true",
"owner-description": "example",
"is-sessions-speakers-enabled": "true",
"privacy": "public",
"state": "draft",
"online": false,
"ticket-url": "http://example.com",
"code-of-conduct": "example",
"payment-country": "US",
"payment-currency": "USD",
"paypal-email": "example@example.com",
"is-tax-enabled": "true",
"can-pay-by-paypal": "false",
"can-pay-by-stripe": "false",
"can-pay-by-cheque": "false",
"can-pay-by-bank": "false",
"can-pay-by-omise": "false",
"can-pay-onsite": "true",
"cheque-details": "example",
"bank-details": "example",
"onsite-details": "example",
"is-sponsors-enabled": "false",
"has-owner-info": "false"
},
"type": "event"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"orders": {
"links": {
"self": "/v1/events/1/relationships/orders",
"related": "/v1/orders"
}
},
"owner": {
"links": {
"self": "/v1/events/1/relationships/owner",
"related": "/v1/events/1/owner"
}
},
"organizers": {
"links": {
"self": "/v1/events/1/relationships/organizers",
"related": "/v1/users"
}
},
"coorganizers": {
"links": {
"self": "/v1/events/1/relationships/coorganizers",
"related": "/v1/users"
}
},
"track-organizers": {
"links": {
"self": "/v1/events/1/relationships/track-coorganizers",
"related": "/v1/users"
}
},
"registrars": {
"links": {
"self": "/v1/events/1/relationships/registrars",
"related": "/v1/users"
}
},
"moderators": {
"links": {
"self": "/v1/events/1/relationships/moderators",
"related": "/v1/users"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"faq-types": {
"links": {
"self": "/v1/events/1/relationships/faq-types",
"related": "/v1/events/1/faq-types"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"thumbnail-image-url": null,
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "http://example.com/example.png",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": false,
"can-pay-by-omise": false,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"online": false,
"ticket-url": "http://example.com",
"can-pay-by-paypal": false,
"location-name": "example",
"is-sponsors-enabled": false,
"has-owner-info": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"code-of-conduct": "example",
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "example",
"can-pay-by-cheque": false,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"external-event-url": null,
"is-tax-enabled": true,
"icon-image-url": null,
"ical-url": null,
"name": "example",
"can-pay-by-bank": false,
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"created-at": "2017-06-26T15:22:37.205399+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"identifier": "b8324ae2",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Event Details ¶
Event DetailsGET/v1/events/{event_identifier}
Get a single event.
Example URI
GET https://api.eventyay.com/v1/events/1
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"orders": {
"links": {
"self": "/v1/events/1/relationships/orders",
"related": "/v1/orders"
}
},
"owner": {
"links": {
"self": "/v1/events/1/relationships/owner",
"related": "/v1/events/1/owner"
}
},
"organizers": {
"links": {
"self": "/v1/events/1/relationships/organizers",
"related": "/v1/users"
}
},
"coorganizers": {
"links": {
"self": "/v1/events/1/relationships/coorganizers",
"related": "/v1/users"
}
},
"track-organizers": {
"links": {
"self": "/v1/events/1/relationships/track-coorganizers",
"related": "/v1/users"
}
},
"registrars": {
"links": {
"self": "/v1/events/1/relationships/registrars",
"related": "/v1/users"
}
},
"moderators": {
"links": {
"self": "/v1/events/1/relationships/moderators",
"related": "/v1/users"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"faq-types": {
"links": {
"self": "/v1/events/1/relationships/faq-types",
"related": "/v1/events/1/faq-types"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"thumbnail-image-url": null,
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "http://example.com/example.png",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"has-owner-info": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"online": false,
"code-of-conduct": "example",
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "example",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"external-event-url": null,
"is-tax-enabled": true,
"icon-image-url": null,
"ical-url": null,
"name": "example",
"can-pay-by-bank": true,
"can-pay-by-omise": false,
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"created-at": "2017-06-26T15:22:37.205399+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"identifier": "b8324ae2",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Update EventPATCH/v1/events/{event_identifier}
Update a single event.
All other fields are optional. Add attributes you want to modify.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/events/1
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "example1",
"external-event-url": "http://example11.com",
"starts-at": "2099-12-14T23:59:59.123456+05:30",
"ends-at": "2099-12-15T23:59:59.123456+05:30",
"timezone": "Asia/Kolkata",
"latitude": "12.23456789",
"longitude": "12.23456789",
"logo-url": "http://example1.com/example1.png",
"location-name": "example1",
"searchable-location-name": "example1",
"description": "example1",
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"owner-name": "example1",
"is-map-shown": "false",
"owner-description": "example1",
"is-sessions-speakers-enabled": "false",
"privacy": "private",
"state": "draft",
"ticket-url": "http://example1.com",
"code-of-conduct": "example1",
"payment-country": "US",
"payment-currency": "USD",
"paypal-email": "example1@example1.com",
"is-tax-enabled": "false",
"can-pay-by-paypal": "false",
"can-pay-by-stripe": "false",
"can-pay-by-cheque": "false",
"can-pay-by-bank": "false",
"can-pay-by-omise": "false",
"can-pay-onsite": "false",
"cheque-details": "example1",
"bank-details": "example1",
"onsite-details": "example1",
"is-sponsors-enabled": "false",
"has-owner-info": "false",
"refund-policy": "All sales are final. No refunds shall be issued in any case."
},
"id": "1",
"type": "event"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"orders": {
"links": {
"self": "/v1/events/1/relationships/orders",
"related": "/v1/orders"
}
},
"owner": {
"links": {
"self": "/v1/events/1/relationships/owner",
"related": "/v1/events/1/owner"
}
},
"organizers": {
"links": {
"self": "/v1/events/1/relationships/organizers",
"related": "/v1/users"
}
},
"coorganizers": {
"links": {
"self": "/v1/events/1/relationships/coorganizers",
"related": "/v1/users"
}
},
"track-organizers": {
"links": {
"self": "/v1/events/1/relationships/track-coorganizers",
"related": "/v1/users"
}
},
"registrars": {
"links": {
"self": "/v1/events/1/relationships/registrars",
"related": "/v1/users"
}
},
"moderators": {
"links": {
"self": "/v1/events/1/relationships/moderators",
"related": "/v1/users"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"faq-types": {
"links": {
"self": "/v1/events/1/relationships/faq-types",
"related": "/v1/events/1/faq-types"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example1@example1.com",
"thumbnail-image-url": null,
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example1",
"is-map-shown": false,
"original-image-url": "http://example1.com/example1.png",
"onsite-details": "example1",
"owner-name": "example1",
"can-pay-by-stripe": false,
"large-image-url": null,
"timezone": "Asia/Kolkata",
"can-pay-onsite": false,
"deleted-at": null,
"ticket-url": "http://example1.com",
"can-pay-by-paypal": false,
"location-name": "example1",
"is-sponsors-enabled": false,
"has-owner-info": false,
"can-pay-by-omise": false,
"is-sessions-speakers-enabled": false,
"privacy": "private",
"code-of-conduct": "example1",
"state": "published",
"online": false,
"latitude": 12.23456789,
"starts-at": "2016-12-14T18:29:59.123456+00:00",
"searchable-location-name": "example1",
"can-pay-by-cheque": false,
"description": "example1",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example1.com/example1.png",
"external-event-url": null,
"is-tax-enabled": false,
"icon-image-url": null,
"ical-url": null,
"name": "example1",
"can-pay-by-bank": false,
"ends-at": "2016-12-15T18:29:59.123456+00:00",
"created-at": "2017-06-26T15:22:37.205399+00:00",
"longitude": 12.23456789,
"bank-details": "example1",
"cheque-details": "example1",
"identifier": "b8324ae2",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Delete EventDELETE/v1/events/{event_identifier}
Delete a single event.
Example URI
DELETE https://api.eventyay.com/v1/events/1
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Upcoming Events Collection ¶
List All Upcoming EventsGET/v1/events/upcoming
Get a list of upcoming events.
Example URI
GET https://api.eventyay.com/v1/events/upcoming
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"orders": {
"links": {
"self": "/v1/events/1/relationships/orders",
"related": "/v1/orders"
}
},
"owner": {
"links": {
"self": "/v1/events/1/relationships/owner",
"related": "/v1/events/1/owner"
}
},
"organizers": {
"links": {
"self": "/v1/events/1/relationships/organizers",
"related": "/v1/users"
}
},
"coorganizers": {
"links": {
"self": "/v1/events/1/relationships/coorganizers",
"related": "/v1/users"
}
},
"track-organizers": {
"links": {
"self": "/v1/events/1/relationships/track-coorganizers",
"related": "/v1/users"
}
},
"registrars": {
"links": {
"self": "/v1/events/1/relationships/registrars",
"related": "/v1/users"
}
},
"moderators": {
"links": {
"self": "/v1/events/1/relationships/moderators",
"related": "/v1/users"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"faq-types": {
"links": {
"self": "/v1/events/1/relationships/faq-types",
"related": "/v1/events/1/faq-types"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"thumbnail-image-url": null,
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "http://example.com/example.png",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"online": false,
"has-owner-info": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"code-of-conduct": "example",
"state": "published",
"latitude": 1.23456789,
"starts-at": "2099-12-13T23:59:59.123456+00:00",
"searchable-location-name": "example",
"can-pay-by-cheque": true,
"can-pay-by-omise": false,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"external-event-url": null,
"is-tax-enabled": true,
"icon-image-url": null,
"ical-url": null,
"name": "example",
"can-pay-by-bank": true,
"ends-at": "2099-12-14T23:59:59.123456+00:00",
"created-at": "2020-06-07T15:22:37.205399+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"identifier": "b8324ae2",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/upcoming"
}
}Events of an Event Type ¶
List All Events of an Event TypeGET/v1/event-types/{event_type_id}/events{?sort,filter}
Get a list of events.
Example URI
GET https://api.eventyay.com/v1/event-types/1/events?sort=name&filter=[]
URI Parameters
- event_type_id
integer(required) Example: 1ID of the event type in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"faq-types": {
"links": {
"self": "/v1/events/1/relationships/faq-types",
"related": "/v1/events/1/faq-types"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"online": false,
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"can-pay-by-omise": false,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events"
}
}Events under an Event Topic ¶
List All Events under an Event TopicGET/v1/event-topics/{event_topic_id}/events{?sort,filter}
Get a list of events.
Example URI
GET https://api.eventyay.com/v1/event-topics/1/events?sort=name&filter=[]
URI Parameters
- event_topic_id
integer(required) Example: 1ID of the event topic in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"faq-types": {
"links": {
"self": "/v1/events/1/relationships/faq-types",
"related": "/v1/events/1/faq-types"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"online": false,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"can-pay-by-omise": false,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events"
}
}Events under an Event Sub-topic ¶
List All Events under an Event Sub-topicGET/v1/event-sub-topics/{event_sub_topic_id}/events{?sort,filter}
Get a list of events.
Example URI
GET https://api.eventyay.com/v1/event-sub-topics/1/events?sort=name&filter=[]
URI Parameters
- event_sub_topic_id
integer(required) Example: 1ID of the event sub topic in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"online": false,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"can-pay-by-omise": false,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events"
}
}Events under a User ¶
List All Events under a UserGET/v1/users/{user_id}/events{?sort,filter}
Get a list of events.
Example URI
GET https://api.eventyay.com/v1/users/1/events?sort=name&filter=[]
URI Parameters
- user_id
integer(required) Example: 1ID of the user in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"can-pay-by-omise": false,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"online": false,
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events"
}
}Events under a Group ¶
List All Events under a GroupGET/v1/groups/{group_id}/events{?sort,filter}
Get a list of events.
Example URI
GET https://api.eventyay.com/v1/groups/1/events?sort=name&filter=[]
URI Parameters
- group_id
integer(required) Example: 1ID of the group in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"faq-types": {
"links": {
"self": "/v1/events/1/relationships/faq-types",
"related": "/v1/events/1/faq-types"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"online": false,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"can-pay-by-omise": false,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events"
}
}Events for a Discount Code ¶
List All Events for a Discount CodeGET/v1/discount-codes/{discount_code_id}/events{?sort,filter}
Get a list of events.
Example URI
GET https://api.eventyay.com/v1/discount-codes/1/events?sort=name&filter=[]
URI Parameters
- discount_code_id
integer(required) Example: 1ID of the discount code in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"can-pay-by-omise": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"online": false,
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events"
}
}Get Event for a Ticket ¶
Event Details for a TicketGET/v1/tickets/{ticket_id}/event
Example URI
GET https://api.eventyay.com/v1/tickets/1/event
URI Parameters
- ticket_id
integer(required) Example: 1ID of the ticket in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"can-pay-by-omise": false,
"online": false,
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Microlocation ¶
Event Details for a MicrolocationGET/v1/microlocations/{microlocation_id}/event
Example URI
GET https://api.eventyay.com/v1/microlocations/1/event
URI Parameters
- microlocation_id
integer(required) Example: 1ID of the microlocation in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"online": false,
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"can-pay-by-omise": false,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Sponsor ¶
Event Details for a SponsorGET/v1/sponsors/{sponsor_id}/event
Example URI
GET https://api.eventyay.com/v1/sponsors/1/event
URI Parameters
- sponsor_id
integer(required) Example: 1ID of the sponsor link in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"online": false,
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"can-pay-by-omise": false,
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Speakers Call ¶
Event Details for a Speakers CallGET/v1/speakers-calls/{speakers_call_id}/event
Example URI
GET https://api.eventyay.com/v1/speakers-calls/1/event
URI Parameters
- speakers_call_id
integer(required) Example: 1ID of the speakers call link in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"can-pay-by-omise": false,
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"online": false,
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Track ¶
Event Details for a TrackGET/v1/tracks/{track_id}/event
Example URI
GET https://api.eventyay.com/v1/tracks/1/event
URI Parameters
- track_id
integer(required) Example: 1ID of the track in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"can-pay-by-omise": false,
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"online": false,
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Session Type ¶
Event Details for a Session TypeGET/v1/session-types/{session_type_id}/event
Example URI
GET https://api.eventyay.com/v1/session-types/1/event
URI Parameters
- session_type_id
integer(required) Example: 1ID of the Session Type in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"can-pay-by-omise": false,
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"online": false,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for an Event Copyright ¶
Event Details for an Event CopyrightGET/v1/event-copyrights/{event_copyright_id}/event
Example URI
GET https://api.eventyay.com/v1/event-copyrights/1/event
URI Parameters
- event_copyright_id
integer(required) Example: 1ID of the Event Copyright in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"can-pay-by-omise": false,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"online": false,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Tax ¶
Event Details for a TaxGET/v1/tax/{tax_id}/event
Example URI
GET https://api.eventyay.com/v1/tax/1/event
URI Parameters
- tax_id
integer(required) Example: 1ID of the tax in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"online": false,
"can-pay-by-omise": false,
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for an Event Invoice ¶
Event Details for an Event InvoiceGET/v1/event-invoices/{event_invoice_id}/event
Example URI
GET https://api.eventyay.com/v1/event-invoices/1/event
URI Parameters
- event_invoice_id
integer(required) Example: 1ID of the Event Invoice in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-omise": false,
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"online": false,
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Discount Code ¶
Event Details for a Discount CodeGET/v1/discount-codes/{discount_code_id}/event
Example URI
GET https://api.eventyay.com/v1/discount-codes/1/event
URI Parameters
- discount_code_id
integer(required) Example: 1ID of the discount code in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"can-pay-by-omise": false,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"online": false,
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Session ¶
Event Details for a SessionGET/v1/sessions/{session_id}/event
Example URI
GET https://api.eventyay.com/v1/sessions/1/event
URI Parameters
- session_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"can-pay-by-omise": false,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"online": false,
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Ticket Tag ¶
Event Details for a Ticket TagGET/v1/ticket-tags/{ticket_tag_id}/event
Example URI
GET https://api.eventyay.com/v1/ticket-tags/1/event
URI Parameters
- ticket_tag_id
integer(required) Example: 1ID of the ticket tag in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-omise": false,
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"online": false,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Role Invite ¶
Event Details for a Role InviteGET/v1/role-invites/{role_invite_id}/event
Example URI
GET https://api.eventyay.com/v1/role-invites/1/event
URI Parameters
- role_invite_id
integer(required) Example: 1ID of the role invite in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"can-pay-by-omise": false,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"online": false,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Speaker ¶
Event Details for a SpeakerGET/v1/speakers/{speaker_id}/event
Example URI
GET https://api.eventyay.com/v1/speakers/1/event
URI Parameters
- speaker_id
integer(required) Example: 1ID of the speaker in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-omise": false,
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"online": false,
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for an Email Notification ¶
Event Details for an Email NotificationGET/v1/email-notifications/{email_notification_id}/event
Example URI
GET https://api.eventyay.com/v1/email-notifications/1/event
URI Parameters
- email_notification_id
integer(required) Example: 1ID of the email notification in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"can-pay-by-omise": false,
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"online": false,
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for an Attendee ¶
Event Details for an AttendeeGET/v1/attendees/{attendee_id}/event
Example URI
GET https://api.eventyay.com/v1/attendees/1/event
URI Parameters
- attendee_id
integer(required) Example: 1ID of the attendee in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-by-omise": false,
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"online": false,
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Custom Form ¶
Event Details for a Custom FormGET/v1/custom-forms/{custom_form_id}/event
Example URI
GET https://api.eventyay.com/v1/custom-forms/1/event
URI Parameters
- custom_form_id
integer(required) Example: 1ID of the custom form in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"online": false,
"has-owner-info": false,
"state": "draft",
"can-pay-by-omise": false,
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a FAQ ¶
Event Details for a FAQGET/v1/faqs/{faq_id}/event
Example URI
GET https://api.eventyay.com/v1/faqs/1/event
URI Parameters
- faq_id
integer(required) Example: 1ID of the faq in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"faqs": {
"links": {
"self": "/v1/events/1/relationships/faqs",
"related": "/v1/events/1/faqs"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": "US",
"paypal-email": "example@example.com",
"code-of-conduct": "example",
"schedule-published-on": null,
"payment-currency": "USD",
"owner-description": "example",
"is-map-shown": true,
"original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
"onsite-details": "example",
"owner-name": "example",
"can-pay-by-stripe": true,
"large-image-url": null,
"timezone": "UTC",
"can-pay-onsite": true,
"deleted-at": null,
"ticket-url": "http://example.com",
"can-pay-by-paypal": true,
"location-name": "example",
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": true,
"privacy": "public",
"has-owner-info": false,
"state": "draft",
"latitude": 1.23456789,
"starts-at": "2016-12-13T23:59:59.123456+00:00",
"searchable-location-name": "Draft",
"can-pay-by-cheque": true,
"description": "example",
"pentabarf-url": null,
"xcal-url": null,
"can-pay-by-omise": false,
"logo-url": "http://example.com/example.png",
"can-pay-by-bank": true,
"is-tax-enabled": true,
"ical-url": null,
"name": "example",
"icon-image-url": null,
"online": false,
"thumbnail-image-url": null,
"created-at": "2017-07-23T12:01:55.414735+00:00",
"longitude": 1.23456789,
"bank-details": "example",
"cheque-details": "example",
"external-event-url": "http://example.com",
"identifier": "f4fbf878",
"ends-at": "2016-12-14T23:59:59.123456+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Get Event for a Order ¶
Event Details for a OrderGET/v1/orders/{order_identifier}/event
Example URI
GET https://api.eventyay.com/v1/orders/7201904e/event
URI Parameters
- order_identifier
string(required) Example: 7201904eIdentifier of the order
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"owner": {
"links": {
"self": "/v1/events/1/relationships/owner",
"related": "/v1/events/1/owner"
}
},
"organizers": {
"links": {
"self": "/v1/events/1/relationships/organizers",
"related": "/v1/users"
}
},
"ticket-tags": {
"links": {
"self": "/v1/events/1/relationships/ticket-tags",
"related": "/v1/events/1/ticket-tags"
}
},
"speakers-call": {
"links": {
"self": "/v1/events/1/relationships/speakers-call",
"related": "/v1/events/1/speakers-call"
}
},
"tax": {
"links": {
"self": "/v1/events/1/relationships/tax",
"related": "/v1/events/1/tax"
}
},
"coorganizers": {
"links": {
"self": "/v1/events/1/relationships/coorganizers",
"related": "/v1/users"
}
},
"session-types": {
"links": {
"self": "/v1/events/1/relationships/session-types",
"related": "/v1/events/1/session-types"
}
},
"microlocations": {
"links": {
"self": "/v1/events/1/relationships/microlocations",
"related": "/v1/events/1/microlocations"
}
},
"orders": {
"links": {
"self": "/v1/events/1/relationships/orders",
"related": "/v1/events/1/orders"
}
},
"speakers": {
"links": {
"self": "/v1/events/1/relationships/speakers",
"related": "/v1/events/1/speakers"
}
},
"event-copyright": {
"links": {
"self": "/v1/events/1/relationships/event-copyright",
"related": "/v1/events/1/event-copyright"
}
},
"attendees": {
"links": {
"self": "/v1/events/1/relationships/attendees",
"related": "/v1/events/1/attendees"
}
},
"custom-forms": {
"links": {
"self": "/v1/events/1/relationships/custom-forms",
"related": "/v1/events/1/custom-forms"
}
},
"track-organizers": {
"links": {
"self": "/v1/events/1/relationships/track-organizers",
"related": "/v1/users"
}
},
"event-type": {
"links": {
"self": "/v1/events/1/relationships/event-type",
"related": "/v1/events/1/event-type"
}
},
"discount-codes": {
"links": {
"self": "/v1/events/1/relationships/discount-codes",
"related": "/v1/events/1/discount-codes"
}
},
"event-sub-topic": {
"links": {
"self": "/v1/events/1/relationships/event-sub-topic",
"related": "/v1/events/1/event-sub-topic"
}
},
"sessions": {
"links": {
"self": "/v1/events/1/relationships/sessions",
"related": "/v1/events/1/sessions"
}
},
"event-topic": {
"links": {
"self": "/v1/events/1/relationships/event-topic",
"related": "/v1/events/1/event-topic"
}
},
"registrars": {
"links": {
"self": "/v1/events/1/relationships/registrars",
"related": "/v1/users"
}
},
"sponsors": {
"links": {
"self": "/v1/events/1/relationships/sponsors",
"related": "/v1/events/1/sponsors"
}
},
"tracks": {
"links": {
"self": "/v1/events/1/relationships/tracks",
"related": "/v1/events/1/tracks"
}
},
"access-codes": {
"links": {
"self": "/v1/events/1/relationships/access-codes",
"related": "/v1/events/1/access-codes"
}
},
"role-invites": {
"links": {
"self": "/v1/events/1/relationships/role-invites",
"related": "/v1/events/1/role-invites"
}
},
"tickets": {
"links": {
"self": "/v1/events/1/relationships/tickets",
"related": "/v1/events/1/tickets"
}
},
"social-links": {
"links": {
"self": "/v1/events/1/relationships/social-links",
"related": "/v1/events/1/social-links"
}
},
"moderators": {
"links": {
"self": "/v1/events/1/relationships/moderators",
"related": "/v1/users"
}
},
"event-invoices": {
"links": {
"self": "/v1/events/1/relationships/event-invoices",
"related": "/v1/events/1/event-invoices"
}
},
"stripe-authorization": {
"links": {
"self": "/v1/events/1/relationships/stripe-authorization",
"related": "/v1/events/1/stripe-authorization"
}
}
},
"attributes": {
"payment-country": null,
"paypal-email": null,
"code-of-conduct": "",
"schedule-published-on": null,
"payment-currency": null,
"owner-description": "",
"is-map-shown": false,
"original-image-url": "https://cdn.pixabay.com/photo/2013/11/23/16/25/birds-216412_1280.jpg",
"onsite-details": null,
"owner-name": null,
"longitude": null,
"large-image-url": null,
"timezone": "Asia/Kolkata",
"can-pay-onsite": false,
"deleted-at": null,
"ticket-url": null,
"can-pay-by-paypal": false,
"location-name": null,
"is-sponsors-enabled": false,
"is-sessions-speakers-enabled": false,
"privacy": "public",
"online": false,
"has-owner-info": false,
"state": "draft",
"can-pay-by-omise": false,
"latitude": null,
"starts-at": "2002-05-30T04:00:10+00:00",
"searchable-location-name": null,
"can-pay-by-cheque": false,
"description": "",
"pentabarf-url": null,
"xcal-url": null,
"logo-url": null,
"can-pay-by-bank": false,
"is-tax-enabled": false,
"icon-image-url": null,
"ical-url": null,
"name": "New Event",
"bank-details": null,
"thumbnail-image-url": null,
"created-at": "2017-08-13T21:41:20.468748+00:00",
"can-pay-by-stripe": false,
"cheque-details": null,
"external-event-url": null,
"identifier": "4f27fefe",
"ends-at": "2022-05-30T04:00:10+00:00",
"refund-policy": "All sales are final. No refunds shall be issued in any case.",
"is-stripe-linked": "false"
},
"type": "event",
"id": "1",
"links": {
"self": "/v1/events/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1"
}
}Group ¶
Groups consisting of events.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the group | string | yes |
Group Collection ¶
List All GroupsGET/v1/groups{?sort,filter}
Get a list of groups.
Example URI
GET https://api.eventyay.com/v1/groups?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"type": "group",
"relationships": {
"events": {
"links": {
"self": "/v1/groups/1/relationships/events",
"related": "/v1/groups/1/events"
}
},
"user": {
"links": {
"self": "/v1/groups/1/relationships/user",
"related": "/v1/groups/1/user"
}
}
},
"attributes": {
"name": "eventgp1",
"deleted-at": null
},
"id": "1",
"links": {
"self": "/v1/groups/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/groups"
}
}Create GroupPOST/v1/groups{?sort,filter}
Create a new group with event_id.
Example URI
POST https://api.eventyay.com/v1/groups?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "group",
"id": "1",
"relationships": {
"user": {
"data": {
"id": "1",
"type": "user"
}
},
"events": {
"data": [
{
"id": "1",
"type": "event"
}
]
}
},
"attributes": {
"name": "eventgp1"
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "group",
"relationships": {
"events": {
"links": {
"self": "/v1/groups/1/relationships/events",
"related": "/v1/groups/1/events"
}
},
"user": {
"links": {
"self": "/v1/groups/1/relationships/user",
"related": "/v1/groups/1/user"
}
}
},
"attributes": {
"name": "eventgp1",
"deleted-at": null
},
"id": "1",
"links": {
"self": "/v1/groups/1"
}
},
"links": {
"self": "/v1/groups/1"
},
"jsonapi": {
"version": "1.0"
}
}Group Detail ¶
Group DetailGET/v1/groups/{group_id}
Get a single group.
Example URI
GET https://api.eventyay.com/v1/groups/1
URI Parameters
- group_id
integer(required) Example: 1ID of the group in the form of an integer
Request
Headers
Accept: application/vnd.api+jsonResponse
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "group",
"relationships": {
"events": {
"links": {
"self": "/v1/groups/1/relationships/events",
"related": "/v1/groups/1/events"
}
},
"user": {
"links": {
"self": "/v1/groups/1/relationships/user",
"related": "/v1/groups/1/user"
}
}
},
"attributes": {
"name": "eventgp1",
"deleted-at": null
},
"id": "1",
"links": {
"self": "/v1/groups/1"
}
},
"links": {
"self": "/v1/groups/1"
},
"jsonapi": {
"version": "1.0"
}
}Update GroupPATCH/v1/groups/{group_id}
Update a single group with id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/groups/1
URI Parameters
- group_id
integer(required) Example: 1ID of the group in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "group",
"attributes": {
"name": "eventgp-random"
},
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "group",
"relationships": {
"events": {
"links": {
"self": "/v1/groups/1/relationships/events",
"related": "/v1/groups/1/events"
}
},
"user": {
"links": {
"self": "/v1/groups/1/relationships/user",
"related": "/v1/groups/1/user"
}
}
},
"attributes": {
"name": "eventgp_random",
"deleted-at": null
},
"id": "1",
"links": {
"self": "/v1/groups/1"
}
},
"links": {
"self": "/v1/groups/1"
},
"jsonapi": {
"version": "1.0"
}
}Delete GroupDELETE/v1/groups/{group_id}
Delete a single group.
Example URI
DELETE https://api.eventyay.com/v1/groups/1
URI Parameters
- group_id
integer(required) Example: 1ID of the group in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Get Group for an Event ¶
Group Details for an EventGET/v1/events/{event_id}/group
Get a single group.
Example URI
GET https://api.eventyay.com/v1/events/1/group
URI Parameters
- event_id
integer(required) Example: 1ID of the group in the form of an integer
Request
Headers
Accept: application/vnd.api+jsonResponse
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "group",
"relationships": {
"events": {
"links": {
"self": "/v1/groups/1/relationships/events",
"related": "/v1/groups/1/events"
}
},
"user": {
"links": {
"self": "/v1/groups/1/relationships/user",
"related": "/v1/groups/1/user"
}
}
},
"attributes": {
"name": "eventgp_1",
"deleted-at": null
},
"id": "1",
"links": {
"self": "/v1/groups/1"
}
},
"links": {
"self": "/v1/groups/1"
},
"jsonapi": {
"version": "1.0"
}
}Groups under an User ¶
List All Groups under an UserGET/v1/users/{user_id}/groups{?sort,filter}
Get a list of groups.
Example URI
GET https://api.eventyay.com/v1/users/1/groups?sort=name&filter=[]
URI Parameters
- user_id
integer(required) Example: 1ID of the user in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"type": "group",
"relationships": {
"events": {
"links": {
"self": "/v1/groups/1/relationships/events",
"related": "/v1/groups/1/events"
}
},
"user": {
"links": {
"self": "/v1/groups/1/relationships/user",
"related": "/v1/groups/1/user"
}
}
},
"attributes": {
"name": "eventgp1",
"deleted-at": null
},
"id": "1",
"links": {
"self": "/v1/groups/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/1/groups?page%5Bsize%5D=10&page%5Bnumber%5D=1&sort=name&filter=%5B%5D"
}
}Copyright ¶
Data related to event copyright information.
| Parameter | Description | Type | Required |
|---|---|---|---|
holder |
Holder name | string | - |
holder-url |
URL of the holder | string | - |
year |
Year till which you have copyright | ISO 8601 (tz-aware) | - |
licence |
Licence text | string | - |
licence-url |
URL of the licence location | string | - |
logo-url |
URL of the logo for the Licence | string | - |
Event Copyright ¶
Create Event CopyrightPOST/v1/event-copyrights{?sort,filter}
Create a new Event Copyright.
Example URI
POST https://api.eventyay.com/v1/event-copyrights?sort=year&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: year- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"holder": "Name of Holder",
"holder-url": "http://holder-url.com",
"licence": "Licence text",
"licence-url": "http://licence-url.com",
"year": 2007,
"logo-url": "http://logo-url.com"
},
"type": "event-copyright"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/event-copyright/1/relationships/event",
"related": "/v1/event-copyright/1/event"
}
}
},
"attributes": {
"holder": "Name of Holder",
"holder-url": "http://holder-url.com",
"licence": "Licence text",
"licence-url": "http://licence-url.com",
"year": 2007,
"deleted-at": null,
"logo-url": "http://logo-url.com"
},
"type": "event-copyright",
"id": "1",
"links": {
"self": "/v1/event-copyright/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-copyright/1"
}
}Event Copyright Details ¶
Event Copyright DetailsGET/v1/event-copyrights/{event_copyright_id}
Example URI
GET https://api.eventyay.com/v1/event-copyrights/1
URI Parameters
- event_copyright_id
integer(required) Example: 1ID of the event copyright in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/event-copyright/1/relationships/event",
"related": "/v1/event-copyright/1/event"
}
}
},
"attributes": {
"holder": "Name of Holder",
"holder-url": "http://holder-url.com",
"licence": "Licence text",
"licence-url": "http://licence-url.com",
"year": 2007,
"deleted-at": null,
"logo-url": "http://logo-url.com"
},
"type": "event-copyright",
"id": "1",
"links": {
"self": "/v1/event-copyright/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-copyright/1"
}
}Update Event CopyrightPATCH/v1/event-copyrights/{event_copyright_id}
Update a single event copyright by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/event-copyrights/1
URI Parameters
- event_copyright_id
integer(required) Example: 1ID of the event copyright in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"holder": "Name of Holder",
"holder-url": "http://holder-url.com",
"licence": "Licence text",
"licence-url": "http://licence-url.com",
"year": 2007,
"logo-url": "http://logo-url.com"
},
"type": "event-copyright",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/event-copyright/1/relationships/event",
"related": "/v1/event-copyright/1/event"
}
}
},
"attributes": {
"holder": "Name of Holder",
"holder-url": "http://holder-url.com",
"licence": "Licence text",
"licence-url": "http://licence-url.com",
"year": 2007,
"deleted-at": null,
"logo-url": "http://logo-url.com"
},
"type": "event-copyright",
"id": "1",
"links": {
"self": "/v1/event-copyright/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-copyright/1"
}
}Delete Event CopyrightDELETE/v1/event-copyrights/{event_copyright_id}
Delete a single event copyright.
Example URI
DELETE https://api.eventyay.com/v1/event-copyrights/1
URI Parameters
- event_copyright_id
integer(required) Example: 1ID of the event copyright in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Get Event Copyright for an Event ¶
Event Copyright DetailsGET/v1/events/{event_identifier}/event-copyright{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/events/1/event-copyright?sort=year&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: year- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/event-copyright/1/relationships/event",
"related": "/v1/event-copyrights/1/event"
}
}
},
"attributes": {
"logo-url": "http://logo-url.com",
"holder-url": "http://holder-url.com",
"licence": "Licence text",
"year": 2007,
"deleted-at": null,
"licence-url": "http://licence-url.com",
"holder": "Name of Holder"
},
"type": "event-copyright",
"id": "1",
"links": {
"self": "/v1/event-copyright/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-copyright/1"
}
}Invoices ¶
Data related to an invoice for the event.
| Parameter | Description | Type | Required |
|---|---|---|---|
status |
Status of the event order | string | - |
identifier |
Unique ID for the invoice | string | - |
paypal-token |
Paypal Token for the event organizer | string | - |
transaction-id |
ID for Transaction | string | - |
brand |
Brand for event invoice | string | - |
created-at |
Time of creation of order | ISO 8601 (tz-aware) | - |
payment-mode |
Payment Mode | string | - |
stripe-token |
Stripe Token for the event organizer | string | - |
last4 |
- | string | - |
exp-month |
Expiring Month | integer | - |
exp-year |
Expiring Year | integer | - |
amount |
Amount of the order | float | - |
completed-at |
Completion of Invoice Order | ISO 8601 (tz-aware) | - |
paid-via |
Payment procedure | string | - |
Event Invoices ¶
Get Event InvoicesGET/v1/event-invoices{?sort,filter}
Get a list of event invoices.
Example URI
GET https://api.eventyay.com/v1/event-invoices?sort=created-at&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: created-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/event-invoices/1/relationships/event",
"related": "/v1/event-invoices/1/event"
}
},
"user": {
"links": {
"self": "/v1/event-invoices/1/relationships/user",
"related": "/v1/event-invoices/1/user"
}
}
},
"attributes": {
"status": "pending",
"identifier": "3fe1aa02-34dd-41ea-a0a9-f7a0259b90b5",
"paypal-token": null,
"exp-year": null,
"transaction-id": null,
"brand": null,
"created-at": "2017-06-08T11:24:57.344803+00:00",
"payment-mode": null,
"stripe-token": null,
"last4": null,
"exp-month": null,
"amount": 100,
"completed-at": null,
"paid-via": null
},
"type": "event-invoice",
"id": "1",
"links": {
"self": "/v1/event-invoices/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-invoices"
}
}Event Invoices Details ¶
Event Invoices DetailsGET/v1/event-invoices/{event_invoice_id}
Get a single event invoice.
Example URI
GET https://api.eventyay.com/v1/event-invoices/1
URI Parameters
- event_invoice_id
integer(required) Example: 1ID of the event invoice in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/event-invoices/5/relationships/event",
"related": "/v1/event-invoices/5/event"
}
},
"user": {
"links": {
"self": "/v1/event-invoices/5/relationships/user",
"related": "/v1/event-invoices/5/user"
}
}
},
"attributes": {
"status": "pending",
"identifier": "b88639c9-5a41-45ea-884d-977876baa08f",
"paypal-token": "1234",
"invoice-pdf-url": null,
"transaction-id": "ae43awer",
"brand": "brand",
"created-at": "2017-06-28T08:10:14.968538+00:00",
"payment-mode": "mode",
"stripe-token": "fssfda432",
"last4": "5445",
"exp-month": 10,
"amount": 500,
"completed-at": null,
"exp-year": 2100,
"paid-via": "stripe"
},
"type": "event-invoice",
"id": "5",
"links": {
"self": "/v1/event-invoices/5"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-invoices/5"
}
}Event Invoice List of an Event ¶
List Event Invoices of an EventGET/v1/events/{event_identifier}/event-invoices{?sort,filter}
Get a single event invoice.
Example URI
GET https://api.eventyay.com/v1/events/1/event-invoices?sort=status&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: status- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/event-invoices/1/relationships/event",
"related": "/v1/event-invoices/1/event"
}
},
"user": {
"links": {
"self": "/v1/event-invoices/1/relationships/user",
"related": "/v1/event-invoices/1/user"
}
}
},
"attributes": {
"status": "pending",
"identifier": "1881f5f8-2936-4796-b51e-b9a97a54ba9a",
"paypal-token": "1234",
"invoice-pdf-url": null,
"transaction-id": "ae43awer",
"brand": "brand",
"created-at": "2017-08-06T23:45:30.564344+00:00",
"payment-mode": "mode",
"stripe-token": "fssfda432",
"last4": "5445",
"exp-month": 10,
"amount": 500,
"completed-at": null,
"exp-year": 2100,
"paid-via": "stripe"
},
"type": "event-invoice",
"id": "1",
"links": {
"self": "/v1/event-invoices/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/event-invoices"
}
}Event Invoice List of a User ¶
List Event Invoices of a UserGET/v1/users/{user_id}/event-invoices{?sort,filter}
Get a single event invoice.
Example URI
GET https://api.eventyay.com/v1/users/2/event-invoices?sort=status&filter=[]
URI Parameters
- user_id
integer(required) Example: 2ID of the user in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: status- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/event-invoices/1/relationships/event",
"related": "/v1/event-invoices/1/event"
}
},
"user": {
"links": {
"self": "/v1/event-invoices/1/relationships/user",
"related": "/v1/event-invoices/1/user"
}
}
},
"attributes": {
"status": "pending",
"identifier": "1881f5f8-2936-4796-b51e-b9a97a54ba9a",
"paypal-token": "1234",
"invoice-pdf-url": null,
"transaction-id": "ae43awer",
"brand": "brand",
"created-at": "2017-08-06T23:45:30.564344+00:00",
"payment-mode": "mode",
"stripe-token": "fssfda432",
"last4": "5445",
"exp-month": 10,
"amount": 500,
"completed-at": null,
"exp-year": 2100,
"paid-via": "stripe"
},
"type": "event-invoice",
"id": "1",
"links": {
"self": "/v1/event-invoices/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/event-invoices"
}
}Microlocations ¶
Data related to all the microlocations for the various sessions of the event.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the microlocation | string | yes |
latitude |
Latitude of the microlocation | float | - |
longitude |
Longitude of the microlocation | float | - |
floor |
Floor of the microlocation | integer | - |
room |
Room of the microlocation | string | - |
Microlocation Collection ¶
Create MicrolocationPOST/v1/microlocations{?sort,filter}
Create a new microlocation using an event_id.
Example URI
POST https://api.eventyay.com/v1/microlocations?sort=floor&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: floor- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"name": "microlocation-name",
"latitude": "45.00",
"longitude": "45.00",
"floor": "2",
"room": "room1"
},
"type": "microlocation"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/microlocations/1/relationships/event",
"related": "/v1/microlocations/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/microlocations/1/relationships/sessions",
"related": "/v1/microlocations/1/sessions"
}
}
},
"attributes": {
"name": "microlocation-name",
"latitude": "45.00",
"longitude": "45.00",
"floor": "2",
"deleted-at": null,
"room": "room1"
},
"type": "microlocation",
"id": "1",
"links": {
"self": "/v1/microlocations/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/microlocations/1"
}
}Microlocation Details ¶
Microlocation DetailsGET/v1/microlocations/{microlocation_id}
Get a single microlocation.
Example URI
GET https://api.eventyay.com/v1/microlocations/1
URI Parameters
- microlocation_id
integer(required) Example: 1ID of the ticket in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/microlocations/1/relationships/event",
"related": "/v1/microlocations/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/microlocations/1/relationships/sessions",
"related": "/v1/microlocations/1/sessions"
}
}
},
"attributes": {
"name": "microlocation-name",
"latitude": "45.00",
"longitude": "45.00",
"floor": "2",
"deleted-at": null,
"room": "room1"
},
"type": "microlocation",
"id": "2",
"links": {
"self": "/v1/microlocations/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/microlocations/1"
}
}Update MicrolocationPATCH/v1/microlocations/{microlocation_id}
Update a single microlocation by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/microlocations/1
URI Parameters
- microlocation_id
integer(required) Example: 1ID of the ticket in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "microlocation-name1",
"latitude": "46.00",
"longitude": "46.00",
"floor": "21",
"room": "room11"
},
"type": "microlocation",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/microlocations/1/relationships/event",
"related": "/v1/microlocations/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/microlocations/1/relationships/sessions",
"related": "/v1/microlocations/1/sessions"
}
}
},
"attributes": {
"name": "microlocation-name1",
"latitude": "46.00",
"longitude": "46.00",
"floor": "21",
"deleted-at": null,
"room": "room11"
},
"type": "microlocation",
"id": "1",
"links": {
"self": "/v1/microlocations/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/microlocations/1"
}
}Delete MicrolocationDELETE/v1/microlocations/{microlocation_id}
Delete a single microlocation.
Example URI
DELETE https://api.eventyay.com/v1/microlocations/1
URI Parameters
- microlocation_id
integer(required) Example: 1ID of the ticket in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Microlocations under an Event ¶
Get List of Microlocations under an EventGET/v1/events/{event_identifier}/microlocations{?sort,filter}
Get a single microlocation.
Example URI
GET https://api.eventyay.com/v1/events/1/microlocations?sort=floor&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: floor- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/microlocations/1/relationships/event",
"related": "/v1/microlocations/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/microlocations/1/relationships/sessions",
"related": "/v1/microlocations/1/sessions"
}
}
},
"attributes": {
"latitude": 45,
"room": "room1",
"name": "microlocation-name",
"longitude": 45,
"deleted-at": null,
"floor": 2
},
"type": "microlocation",
"id": "1",
"links": {
"self": "/v1/microlocations/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/microlocations"
}
}Microlocation Details of a Session ¶
Get Microlocation Details of a SessionGET/v1/sessions/{session_id}/microlocation
Get a single microlocation.
Example URI
GET https://api.eventyay.com/v1/sessions/1/microlocation
URI Parameters
- session_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/microlocations/1/relationships/event",
"related": "/v1/microlocations/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/microlocations/1/relationships/sessions",
"related": "/v1/microlocations/1/sessions"
}
}
},
"attributes": {
"latitude": 45,
"room": "room1",
"name": "microlocation-name",
"longitude": 45,
"deleted-at": null,
"floor": 2
},
"type": "microlocation",
"id": "1",
"links": {
"self": "/v1/microlocations/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/microlocations/1"
}
}Sessions ¶
Data related to all the sessions in the event.
| Parameter | Description | Type | Required |
|---|---|---|---|
title |
Title of the Session | string | yes |
subtitle |
Subtitle of the Session | string | - |
level |
Level of the Session | string | - |
short-abstract |
Short Abstract of the Session | string | - |
long-abstract |
Long Abstract of the Session | string | - |
comments |
Comments of the Session | string | - |
starts-at |
Start date of the Session | ISO 8601 (tz-aware) | - |
ends-at |
End date of the Session | ISO 8601 (tz-aware) | - |
language |
Language of the Session | string | - |
slides-url |
Slide Url of the Session | string | - |
videos-url |
Video Url of the Session | string | - |
audios-url |
Audio Url of the Session | string | - |
signup-url |
Signup Url of the Session | string | - |
state |
State of the Session | string | - |
created-at |
Date the session was created | ISO 8601 (tz-aware) | - |
deleted-at |
Date the session was deleted | ISO 8601 (tz-aware) | - |
submitted-at |
Date the session was submitted | ISO 8601 (tz-aware) | - |
is-mail-sent |
Yes/No for Session accept/reject email | boolean (default: false) |
- |
last-modified-at |
Date the session was modified | ISO 8601 (tz-aware) | - |
send-email |
Yes/No for sending Session accept/reject email | boolean | - |
average-rating |
Average rating of session | float | - |
Sessions Collection ¶
Create SessionsPOST/v1/sessions{?sort,filter}
Create a new session using an event_id and track_id (Minimum Co-Organizer Access)
Example URI
POST https://api.eventyay.com/v1/sessions?sort=created-at&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: created-at- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
},
"track": {
"data": {
"type": "track",
"id": "1"
}
}
},
"attributes": {
"title": "Micropython Session",
"subtitle": "Title",
"level": "Expert",
"short-abstract": "Short Abstract",
"long-abstract": "The Long Abstract",
"comments": "Comment",
"starts-at": "2099-06-01T10:00:00.500127+00:00",
"ends-at": "2099-06-01T11:00:00.500127+00:00",
"language": "English",
"slides-url": "http://example.com/example",
"video-url": "http://example.com/example",
"audio-url": "http://example.com/example",
"signup-url": "http://example.com/example",
"state": "accepted",
"created-at": "2017-05-01T01:24:47.500127+00:00",
"deleted-at": null,
"submitted-at": "2017-05-01T01:24:47.500127+00:00",
"is-mail-sent": false,
"last-modified-at": "2017-05-01T01:24:47.500127+00:00"
},
"type": "session"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/sessions/21/relationships/event",
"related": "/v1/sessions/21/event"
}
},
"track": {
"links": {
"self": "/v1/sessions/21/relationships/track",
"related": "/v1/sessions/21/track"
}
},
"microlocation": {
"links": {
"self": "/v1/sessions/21/relationships/microlocation",
"related": "/v1/sessions/21/microlocation"
}
},
"session-type": {
"links": {
"self": "/v1/sessions/21/relationships/session-type",
"related": "/v1/sessions/21/session-type"
}
},
"creator": {
"links": {
"self": "/v1/sessions/21/relationships/creator",
"related": "/v1/sessions/21/creator"
}
}
},
"attributes": {
"title": "Micropython Session",
"subtitle": null,
"level": "Expert",
"short-abstract": null,
"average-rating": 4.25,
"long-abstract": null,
"comments": null,
"starts-at": "2017-06-01T10:00:00.500127+00:00",
"ends-at": "2017-06-01T11:00:00.500127+00:00",
"language": "English",
"slides-url": null,
"video-url": null,
"audio-url": null,
"signup-url": null,
"state": null,
"created-at": "2017-05-01T01:24:47.500127+00:00",
"deleted-at": null,
"submitted-at": null,
"is-mail-sent": false,
"last-modified-at": "2017-05-01T01:24:47.500127+00:00"
},
"type": "session",
"id": "21",
"links": {
"self": "/v1/sessions/21"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/sessions/21"
}
}Sessions Details ¶
Session DetailsGET/v1/sessions/{session_id}
Get a single session. (Public)
Example URI
GET https://api.eventyay.com/v1/sessions/1
URI Parameters
- session_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/sessions/1/relationships/event",
"related": "/v1/sessions/1/event"
}
},
"track": {
"links": {
"self": "/v1/sessions/1/relationships/track",
"related": "/v1/sessions/1/track"
}
},
"microlocation": {
"links": {
"self": "/v1/sessions/1/relationships/microlocation",
"related": "/v1/sessions/1/microlocation"
}
},
"session-type": {
"links": {
"self": "/v1/sessions/1/relationships/session-type",
"related": "/v1/sessions/1/session-type"
}
},
"creator": {
"links": {
"self": "/v1/sessions/1/relationships/creator",
"related": "/v1/sessions/1/creator"
}
}
},
"attributes": {
"title": "Micropython Session",
"subtitle": null,
"level": "Expert",
"short-abstract": null,
"average-rating": 4.25,
"long-abstract": null,
"comments": null,
"starts-at": "2017-06-01T10:00:00.500127+00:00",
"ends-at": "2017-06-01T11:00:00.500127+00:00",
"language": "English",
"slides-url": null,
"video-url": null,
"audio-url": null,
"signup-url": null,
"state": null,
"created-at": "2017-05-01T01:24:47.500127+00:00",
"deleted-at": null,
"submitted-at": null,
"is-mail-sent": false,
"last-modified-at": "2017-05-01T01:24:47.500127+00:00"
},
"type": "session",
"id": "1",
"links": {
"self": "/v1/sessions/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/sessions/1"
}
}Update SessionPATCH/v1/sessions/{session_id}
Update a single session by id. (Minimum Co-Organizer Access)
| Key | Description | Type | Required |
|---|---|---|---|
id |
ID of the record to update | integer | yes |
Example URI
PATCH https://api.eventyay.com/v1/sessions/1
URI Parameters
- session_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"title": "Micropython Session",
"level": "Expert",
"starts-at": "2099-06-01T10:00:00.500127+00:00",
"ends-at": "2099-06-01T11:00:00.500127+00:00",
"created-at": "2017-05-01T01:24:47.500127+00:00",
"is-mail-sent": false
},
"type": "session",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/sessions/1/relationships/event",
"related": "/v1/sessions/1/event"
}
},
"track": {
"links": {
"self": "/v1/sessions/1/relationships/track",
"related": "/v1/sessions/1/track"
}
},
"microlocation": {
"links": {
"self": "/v1/sessions/1/relationships/microlocation",
"related": "/v1/sessions/1/microlocation"
}
},
"session-type": {
"links": {
"self": "/v1/sessions/1/relationships/session-type",
"related": "/v1/sessions/1/session-type"
}
},
"creator": {
"links": {
"self": "/v1/sessions/1/relationships/creator",
"related": "/v1/sessions/1/creator"
}
}
},
"attributes": {
"title": "Micropython Session",
"subtitle": null,
"level": "Expert",
"short-abstract": null,
"average-rating": 4.25,
"long-abstract": null,
"comments": null,
"starts-at": "2017-06-01T10:00:00.500127+00:00",
"ends-at": "2017-06-01T11:00:00.500127+00:00",
"language": "English",
"slides-url": null,
"video-url": null,
"audio-url": null,
"signup-url": null,
"state": null,
"created-at": "2017-05-01T01:24:47.500127+00:00",
"deleted-at": null,
"submitted-at": null,
"is-mail-sent": false,
"last-modified-at": "2017-05-02T01:24:47.500127+00:00"
},
"type": "session",
"id": "1",
"links": {
"self": "/v1/sessions/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/sessions/1"
}
}Delete SessionDELETE/v1/sessions/{session_id}
Delete a single session. (Minimum Co-Organizer Access)
Example URI
DELETE https://api.eventyay.com/v1/sessions/1
URI Parameters
- session_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}List Sessions under an Event ¶
List Sessions under an EventGET/v1/events/{event_identifier}/sessions{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/events/1/sessions?sort=created-at&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: created-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"track": {
"links": {
"self": "/v1/sessions/1/relationships/track",
"related": "/v1/sessions/1/track"
}
},
"speakers": {
"links": {
"self": "/v1/sessions/1/relationships/speakers",
"related": "/v1/sessions/1/speakers"
}
},
"microlocation": {
"links": {
"self": "/v1/sessions/1/relationships/microlocation",
"related": "/v1/sessions/1/microlocation"
}
},
"event": {
"links": {
"self": "/v1/sessions/1/relationships/event",
"related": "/v1/sessions/1/event"
}
},
"session-type": {
"links": {
"self": "/v1/sessions/1/relationships/session-type",
"related": "/v1/sessions/1/session-type"
}
}
},
"attributes": {
"audio-url": "http://example.com/example",
"subtitle": "Title",
"ends-at": "2017-06-01T11:00:00.500127+00:00",
"language": "English",
"short-abstract": "Short Abstract",
"average-rating": 4.25,
"slides-url": "http://example.com/example",
"title": "Micropython Session",
"created-at": "2017-07-25T02:22:35.010307+00:00",
"signup-url": "http://example.com/example",
"long-abstract": "The Long Abstract",
"state": "draft",
"submitted-at": "2017-05-01T01:24:47.500127+00:00",
"comments": "Comment",
"video-url": "http://example.com/example",
"level": "Expert",
"deleted-at": null,
"starts-at": "2017-06-01T10:00:00.500127+00:00",
"is-mail-sent": false,
"last-modified-at": "2017-07-25T02:22:35.010307+00:00"
},
"type": "session",
"id": "1",
"links": {
"self": "/v1/sessions/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/sessions"
}
}List Sessions under a Track ¶
List Sessions under a TrackGET/v1/tracks/{track_id}/sessions{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/tracks/1/sessions?sort=created-at&filter=[]
URI Parameters
- track_id
integer(required) Example: 1ID of the track in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: created-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"track": {
"links": {
"self": "/v1/sessions/1/relationships/track",
"related": "/v1/sessions/1/track"
}
},
"speakers": {
"links": {
"self": "/v1/sessions/1/relationships/speakers",
"related": "/v1/sessions/1/speakers"
}
},
"microlocation": {
"links": {
"self": "/v1/sessions/1/relationships/microlocation",
"related": "/v1/sessions/1/microlocation"
}
},
"event": {
"links": {
"self": "/v1/sessions/1/relationships/event",
"related": "/v1/sessions/1/event"
}
},
"session-type": {
"links": {
"self": "/v1/sessions/1/relationships/session-type",
"related": "/v1/sessions/1/session-type"
}
}
},
"attributes": {
"audio-url": "http://example.com/example",
"subtitle": "Title",
"ends-at": "2017-06-01T11:00:00.500127+00:00",
"language": "English",
"short-abstract": "Short Abstract",
"average-rating": 4.25,
"slides-url": "http://example.com/example",
"title": "Micropython Session",
"created-at": "2017-07-25T02:22:35.010307+00:00",
"signup-url": "http://example.com/example",
"long-abstract": "The Long Abstract",
"state": "draft",
"submitted-at": "2017-05-01T01:24:47.500127+00:00",
"comments": "Comment",
"video-url": "http://example.com/example",
"level": "Expert",
"deleted-at": null,
"starts-at": "2017-06-01T10:00:00.500127+00:00",
"is-mail-sent": false,
"last-modified-at": "2017-07-25T02:22:35.010307+00:00"
},
"type": "session",
"id": "1",
"links": {
"self": "/v1/sessions/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tracks/1/sessions"
}
}List Sessions under a Session Type ¶
List Sessions under a Session TypeGET/v1/session-types/{session_type_id}/sessions{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/session-types/1/sessions?sort=created-at&filter=[]
URI Parameters
- session_type_id
integer(required) Example: 1ID of the session_type in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: created-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"track": {
"links": {
"self": "/v1/sessions/1/relationships/track",
"related": "/v1/sessions/1/track"
}
},
"speakers": {
"links": {
"self": "/v1/sessions/1/relationships/speakers",
"related": "/v1/sessions/1/speakers"
}
},
"microlocation": {
"links": {
"self": "/v1/sessions/1/relationships/microlocation",
"related": "/v1/sessions/1/microlocation"
}
},
"event": {
"links": {
"self": "/v1/sessions/1/relationships/event",
"related": "/v1/sessions/1/event"
}
},
"session-type": {
"links": {
"self": "/v1/sessions/1/relationships/session-type",
"related": "/v1/sessions/1/session-type"
}
}
},
"attributes": {
"audio-url": "http://example.com/example",
"subtitle": "Title",
"ends-at": "2017-06-01T11:00:00.500127+00:00",
"language": "English",
"short-abstract": "Short Abstract",
"average-rating": 4.25,
"slides-url": "http://example.com/example",
"title": "Micropython Session",
"created-at": "2017-07-25T02:22:35.010307+00:00",
"signup-url": "http://example.com/example",
"long-abstract": "The Long Abstract",
"state": "draft",
"submitted-at": "2017-05-01T01:24:47.500127+00:00",
"comments": "Comment",
"video-url": "http://example.com/example",
"level": "Expert",
"deleted-at": null,
"starts-at": "2017-06-01T10:00:00.500127+00:00",
"is-mail-sent": false,
"last-modified-at": "2017-07-25T02:22:35.010307+00:00"
},
"type": "session",
"id": "1",
"links": {
"self": "/v1/sessions/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/session-types/1/sessions"
}
}List Sessions under a Microlocation ¶
List Sessions under a MicrolocationGET/v1/microlocations/{microlocation_id}/sessions{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/microlocations/1/sessions?sort=created-at&filter=[]
URI Parameters
- microlocation_id
integer(required) Example: 1ID of the ticket in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: created-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"track": {
"links": {
"self": "/v1/sessions/1/relationships/track",
"related": "/v1/sessions/1/track"
}
},
"speakers": {
"links": {
"self": "/v1/sessions/1/relationships/speakers",
"related": "/v1/sessions/1/speakers"
}
},
"microlocation": {
"links": {
"self": "/v1/sessions/1/relationships/microlocation",
"related": "/v1/sessions/1/microlocation"
}
},
"event": {
"links": {
"self": "/v1/sessions/1/relationships/event",
"related": "/v1/sessions/1/event"
}
},
"session-type": {
"links": {
"self": "/v1/sessions/1/relationships/session-type",
"related": "/v1/sessions/1/session-type"
}
}
},
"attributes": {
"audio-url": "http://example.com/example",
"subtitle": "Title",
"ends-at": "2017-06-01T11:00:00.500127+00:00",
"language": "English",
"short-abstract": "Short Abstract",
"average-rating": 4.25,
"slides-url": "http://example.com/example",
"title": "Micropython Session",
"created-at": "2017-07-25T02:22:35.010307+00:00",
"signup-url": "http://example.com/example",
"long-abstract": "The Long Abstract",
"state": "draft",
"submitted-at": "2017-05-01T01:24:47.500127+00:00",
"comments": "Comment",
"video-url": "http://example.com/example",
"level": "Expert",
"deleted-at": null,
"starts-at": "2017-06-01T10:00:00.500127+00:00",
"is-mail-sent": false,
"last-modified-at": "2017-07-25T02:22:35.010307+00:00"
},
"type": "session",
"id": "1",
"links": {
"self": "/v1/sessions/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/microlocations/1/sessions"
}
}List Sessions under a Speaker ¶
List Sessions under a SpeakerGET/v1/speakers/{speaker_id}/sessions{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/speakers/1/sessions?sort=created-at&filter=[]
URI Parameters
- speaker_id
integer(required) Example: 1ID of the Speaker in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: created-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"track": {
"links": {
"self": "/v1/sessions/1/relationships/track",
"related": "/v1/sessions/1/track"
}
},
"speakers": {
"links": {
"self": "/v1/sessions/1/relationships/speakers",
"related": "/v1/sessions/1/speakers"
}
},
"microlocation": {
"links": {
"self": "/v1/sessions/1/relationships/microlocation",
"related": "/v1/sessions/1/microlocation"
}
},
"event": {
"links": {
"self": "/v1/sessions/1/relationships/event",
"related": "/v1/sessions/1/event"
}
},
"session-type": {
"links": {
"self": "/v1/sessions/1/relationships/session-type",
"related": "/v1/sessions/1/session-type"
}
}
},
"attributes": {
"audio-url": "http://example.com/example",
"subtitle": "Title",
"ends-at": "2017-06-01T11:00:00.500127+00:00",
"language": "English",
"short-abstract": "Short Abstract",
"average-rating": 4.25,
"slides-url": "http://example.com/example",
"title": "Micropython Session",
"created-at": "2017-07-25T02:22:35.010307+00:00",
"signup-url": "http://example.com/example",
"long-abstract": "The Long Abstract",
"state": "draft",
"submitted-at": "2017-05-01T01:24:47.500127+00:00",
"comments": "Comment",
"video-url": "http://example.com/example",
"level": "Expert",
"deleted-at": null,
"starts-at": "2017-06-01T10:00:00.500127+00:00",
"is-mail-sent": false,
"last-modified-at": "2017-07-25T02:22:35.010307+00:00"
},
"type": "session",
"id": "1",
"links": {
"self": "/v1/sessions/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/speakers/1/sessions"
}
}Sessions States ¶
Session StatesGET/v1/sessions/states
Get possible session state transitions. (Public)
Example URI
GET https://api.eventyay.com/v1/sessions/states
Response
200Headers
Content-Type: application/jsonBody
{
"organizer": {
"accepted": {
"canceled": true,
"confirmed": true,
"rejected": true,
"withdrawn": true
},
"canceled": {
"accepted": true,
"confirmed": true,
"rejected": true,
"withdrawn": true
},
"confirmed": {
"accepted": true,
"canceled": true,
"rejected": true,
"withdrawn": true
},
"draft": {},
"pending": {
"accepted": true,
"confirmed": true,
"rejected": true,
"withdrawn": true
},
"rejected": {
"accepted": true,
"confirmed": true,
"withdrawn": true
},
"withdrawn": {}
},
"speaker": {
"accepted": {
"withdrawn": true
},
"canceled": {
"withdrawn": true
},
"confirmed": {
"withdrawn": true
},
"draft": {
"pending": true
},
"pending": {
"withdrawn": true
},
"rejected": {
"withdrawn": true
},
"withdrawn": {}
}
}Sessions State Change Mails ¶
Sessions State Change MailsGET/v1/sessions/mails
Get mail subject and message sent on changing session state. (Public)
Example URI
GET https://api.eventyay.com/v1/sessions/mails
Response
200Headers
Content-Type: application/jsonBody
{
"accepted": {
"message": "Hello,<br/><br/>This is an automatic message from {app_name}.<br/><br/>Your session status for the submission {session_name} for {event_name} was changed to \"Accepted\". Congratulations!<br/><br/>Your proposal will be scheduled by the event organizers and review team. Please (re)confirm your participation with the organizers of the event, if required.<br/><br/>You can also check the status and details of your submission on the session page {session_link}. You need to be logged in to view it.<br/><br/>More details about the event are on the event page at {event_link}.<br/><br/>Thank you.<br/><a href='{frontend_link}'>{app_name}</a>",
"subject": "Accepted! Congratulations Your submission for {event_name} titled {session_name} has been Accepted"
},
"canceled": {
"message": "Hello,<br/><br/>This is an automatic message from {app_name}.<br/><br/>Your session status for the submission {session_name} for {event_name} was changed to \"Canceled\".<br/><br/>The status change was done by event organizers. If there are questions about this change please contact the organizers.<br/><br/>You can also check the status and details of your submission on the session page {session_link}. You need to be logged in to view it.<br/><br/>More details about the event are on the event page at {event_link}.<br/><br/>Thank you.<br/><a href='{frontend_link}'>{app_name}</a>",
"subject": "Canceled! Your submission for {event_name} titled {session_name} has been Canceled"
},
"confirmed": {
"message": "Hello,<br/><br/>This is an automatic message from {app_name}.<br/><br/>Your session status for the submission {session_name} for {event_name} was changed to \"Confirmed\". Congratulations!<br/><br/>Your proposal will be scheduled by the event organizers and review team. Please inform the event organizers in case there are any changes to your participation.<br/><br/>You can also check the status and details of your submission on the session page {session_link}. You need to be logged in to view it.<br/><br/>More details about the event are on the event page at {event_link}.<br/><br/>Thank you.<br/><a href='{frontend_link}'>{app_name}</a>",
"subject": "Confirmed! Congratulations Your submission for {event_name} titled {session_name} has been Confirmed"
},
"pending": {
"message": "Hello,<br/><br/>This is an automatic message from {app_name}.<br/><br/>We have received your submission {session_name} for {event_name}<br/><br/>Your proposal will be reviewed by the event organizers and review team. The current status of your session is now \"Pending\".<br/><br/>You can also check the status and details of your submission on the session page {session_link}. You need to be logged in to view it.<br/><br/>More details about the event are on the event page at {event_link}.<br/><br/>Thank you.<br/><a href='{frontend_link}'>{app_name}</a>",
"subject": "Your speaker submission for {event_name} titled {session_name}"
},
"recipient": "Speaker",
"rejected": {
"message": "Hello,<br/><br/>This is an automatic message from {app_name}.<br/><br/>Unfortunately your submission {session_name} for {event_name} was not accepted. Your session status was changed to \"Rejected\".<br/><br/>The status change was done by event organizers. If there are questions about this change please contact the organizers.<br/><br/>You can also check the status and details of your submission on the session page {session_link}. You need to be logged in to view it.<br/><br/>More details about the event are on the event page at {event_link}.<br/><br/>Thank you.<br/><a href='{frontend_link}'>{app_name}</a>",
"subject": "Not Accepted. Your submission for {event_name} titled {session_name} was not accepted"
},
"withdrawn": {
"message": "Hello,<br/><br/>This is an automatic message from {app_name}.<br/><br/>Your session status for the submission {session_name} for {event_name} was changed to \"Withdrawn\".<br/><br/>The status change was done by event organizers. If there are questions about this change please contact the organizers.<br/><br/>You can also check the status and details of your submission on the session page {session_link}. You need to be logged in to view it.<br/><br/>More details about the event are on the event page at {event_link}.<br/><br/>Thank you.<br/><a href='{frontend_link}'>{app_name}</a>",
"subject": "Withdrawn! Your submission for {event_name} titled {session_name} has been Withdrawn"
}
}Session Type ¶
Data related to all the session types (such as talks, workshops, lightning talks) associated with the event.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the Session Type | string | yes |
length |
Length of the Session Type | string | 00:30 |
Session Type Collection ¶
Create Session TypePOST/v1/session-types{?sort,filter}
Create a new session type using an event_id.
Example URI
POST https://api.eventyay.com/v1/session-types?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"name": "Workshop",
"length": "00:30"
},
"type": "session-type"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/session-types/1/relationships/event",
"related": "/v1/session-types/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/session-types/1/relationships/sessions",
"related": "/v1/session-types/1/sessions"
}
}
},
"attributes": {
"name": "Workshop",
"length": "00:30",
"deleted-at": null
},
"type": "session-type",
"id": "1",
"links": {
"self": "/v1/session-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/session-types/1"
}
}Session Type Details ¶
Session Type DetailsGET/v1/session-types/{session_type_id}
Get a single session type.
Example URI
GET https://api.eventyay.com/v1/session-types/1
URI Parameters
- session_type_id
integer(required) Example: 1ID of the session_type in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/session-types/1/relationships/event",
"related": "/v1/session-types/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/session-types/1/relationships/sessions",
"related": "/v1/session-types/1/sessions"
}
}
},
"attributes": {
"name": "Workshop",
"deleted-at": null,
"length": "00:30"
},
"type": "session-type",
"id": "1",
"links": {
"self": "/v1/session-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/session-types/1"
}
}Update Session TypePATCH/v1/session-types/{session_type_id}
Update a single session type by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/session-types/1
URI Parameters
- session_type_id
integer(required) Example: 1ID of the session_type in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "Workshop 2",
"length": "01:30"
},
"type": "session-type",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/session-types/1/relationships/event",
"related": "/v1/session-types/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/session-types/1/relationships/sessions",
"related": "/v1/session-types/1/sessions"
}
}
},
"attributes": {
"name": "Workshop 2",
"deleted-at": null,
"length": "01:30"
},
"type": "session-type",
"id": "1",
"links": {
"self": "/v1/session-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/session-types/1"
}
}Delete Session TypeDELETE/v1/session-types/{session_type_id}
Delete a single session type.
Example URI
DELETE https://api.eventyay.com/v1/session-types/1
URI Parameters
- session_type_id
integer(required) Example: 1ID of the session_type in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}List Session Types under an Event ¶
List Session TypesGET/v1/events/{event_identifier}/session-types{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/events/1/session-types?sort=name&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/session-types/1/relationships/event",
"related": "/v1/session-types/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/session-types/1/relationships/sessions",
"related": "/v1/session-types/1/sessions"
}
}
},
"attributes": {
"length": "00:30",
"deleted-at": null,
"name": "Workshop"
},
"type": "session-type",
"id": "1",
"links": {
"self": "/v1/session-types/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/session-types"
}
}Get Session Type of a Session ¶
Get Session Type DetailsGET/v1/sessions/{session_id}/session-type
Get a single session type.
Example URI
GET https://api.eventyay.com/v1/sessions/1/session-type
URI Parameters
- session_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/session-types/1/relationships/event",
"related": "/v1/session-types/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/session-types/1/relationships/sessions",
"related": "/v1/session-types/1/sessions"
}
}
},
"attributes": {
"length": "00:30",
"deleted-at": null,
"name": "Workshop"
},
"type": "session-type",
"id": "1",
"links": {
"self": "/v1/session-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/session-types/1"
}
}Speakers ¶
Data related to the various speakers associated with the various sessions in the event.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
The name of the speaker | string | yes |
email |
The email of the speaker | string | yes |
photo-url |
URL of the photo of the speaker | string | - |
thumbnail-image-url |
Thumbnail image’s URL of the speaker | string | - |
small-image-url |
Small image’s URL of the speaker | string | - |
icon-image-url |
Icon image’s URL of the speaker | string | - |
short-biography |
Short biography of the speaker | string | - |
long-biography |
Long biography of the speaker | string | - |
speaking-experience |
Speaking experience of the speaker | string | - |
mobile |
Mobile number of the speaker | string | - |
location |
Name of the location of track | string | - |
website |
Personal website of the speaker | string | - |
twitter |
Twitter profile link of the speaker | string | - |
facebook |
Facebook profile link of the speaker | string | - |
github |
Github profile link of the speaker | string | - |
linkedin |
Linkedin profile link of the speakers | string | - |
organisation |
Name of the organisation which the speaker belongs to | string | - |
is-featured |
To state whether a speaker is a featured speaker in an event | boolean (default: false) |
- |
is-email-overridden |
To state whether email of the speaker is overridden | boolean (default: false) |
- |
position |
The speaker’s position in his/her organisation | string | - |
country |
Country where the speaker lives | string | - |
city |
City where the speaker lives | string | - |
gender |
Gender of the speaker | string | - |
heard-from |
How did the speaker get info about the event | string | - |
sponsorship-required |
If any kind of sponsorship is required by the speaker | string | - |
Speakers Collection ¶
Create SpeakerPOST/v1/speakers{?sort,filter}
Create a Speaker profile
Example URI
POST https://api.eventyay.com/v1/speakers?sort=speaking-experience&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: speaking-experience- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "speaker",
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
},
"user": {
"data": {
"type": "user",
"id": "1"
}
},
"sessions": {
"data": [
{
"type": "session",
"id": "1"
}
]
}
},
"attributes": {
"name": "firstSpeaker",
"email": "firstSpeaker@gmail.com",
"website": "https://firstSpeaker.com",
"city": "Delhi",
"gender": "Man",
"country": "India"
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"user": {
"links": {
"self": "/v1/speakers/1/relationships/user",
"related": "/v1/speakers/1/user"
}
},
"event": {
"links": {
"self": "/v1/speakers/1/relationships/event",
"related": "/v1/speakers/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/speakers/1/relationships/session",
"related": "/v1/speakers/1/sessions"
}
}
},
"attributes": {
"website": "https://firstSpeaker.com",
"city": "Delhi",
"short-biography": "",
"name": "firstSpeaker",
"speaking-experience": "",
"country": "India",
"twitter": null,
"is-featured": false,
"is-email-overridden": false,
"linkedin": null,
"email": "firstSpeaker@gmail.com",
"long-biography": "",
"mobile": null,
"github": null,
"facebook": null,
"gender": "Man",
"position": null,
"organisation": null,
"deleted-at": null,
"sponsorship-required": "",
"heard-from": null
},
"type": "speaker",
"id": "1",
"links": {
"self": "/v1/speakers/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/speakers/1"
}
}Speaker Details ¶
Speaker DetailsGET/v1/speakers/{speaker_id}
Get a single Speaker profile
Example URI
GET https://api.eventyay.com/v1/speakers/1
URI Parameters
- speaker_id
integer(required) Example: 1ID of the Speaker in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"user": {
"links": {
"self": "/v1/speakers/1/relationships/user",
"related": "/v1/speakers/1/user"
}
},
"event": {
"links": {
"self": "/v1/speakers/1/relationships/event",
"related": "/v1/speakers/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/speakers/1/relationships/session",
"related": "/v1/speakers/1/sessions"
}
}
},
"attributes": {
"website": "https://firstSpeaker.com",
"city": "Delhi",
"short-biography": "",
"name": "firstSpeaker",
"speaking-experience": "",
"country": "India",
"twitter": null,
"is-featured": false,
"is-email-overridden": false,
"linkedin": null,
"email": "firstSpeaker@gmail.com",
"long-biography": "",
"mobile": null,
"github": null,
"facebook": null,
"gender": "Man",
"position": null,
"deleted-at": null,
"organisation": null,
"sponsorship-required": "",
"heard-from": null
},
"type": "speaker",
"id": "1",
"links": {
"self": "/v1/speakers/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/speakers/1"
}
}Update SpeakerPATCH/v1/speakers/{speaker_id}
Update a single speaker by id.
Example URI
PATCH https://api.eventyay.com/v1/speakers/1
URI Parameters
- speaker_id
integer(required) Example: 1ID of the Speaker in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "firstSpeaker-Patched",
"email": "firstSpeaker_Patched@gmail.com",
"website": "https://firstSpeaker-Patched.com",
"city": "Delhi",
"gender": "Man",
"country": "India"
},
"type": "speaker",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"user": {
"links": {
"self": "/v1/speakers/1/relationships/user",
"related": "/v1/speakers/1/user"
}
},
"event": {
"links": {
"self": "/v1/speakers/1/relationships/event",
"related": "/v1/speakers/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/speakers/1/relationships/session",
"related": "/v1/speakers/1/sessions"
}
}
},
"attributes": {
"website": "https://firstSpeaker-Patched.com",
"city": "Delhi",
"short-biography": "",
"name": "firstSpeaker-Patched",
"speaking-experience": "",
"country": "India",
"twitter": null,
"is-featured": false,
"is-email-overridden": false,
"linkedin": null,
"email": "firstSpeaker_Patched@gmail.com",
"long-biography": "",
"mobile": null,
"github": null,
"facebook": null,
"gender": "Man",
"deleted-at": null,
"position": null,
"organisation": null,
"sponsorship-required": "",
"heard-from": null
},
"type": "speaker",
"id": "1",
"links": {
"self": "/v1/speakers/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/speakers/1"
}
}Delete SpeakerDELETE/v1/speakers/{speaker_id}
Delete a single speaker by id.
Example URI
DELETE https://api.eventyay.com/v1/speakers/1
URI Parameters
- speaker_id
integer(required) Example: 1ID of the Speaker in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}List Speakers under an Event ¶
List Speakers under an EventGET/v1/events/{event_identifier}/speakers{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/events/1/speakers?sort=speaking-experience&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: speaking-experience- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"user": {
"links": {
"self": "/v1/speakers/1/relationships/user",
"related": "/v1/speakers/1/user"
}
},
"event": {
"links": {
"self": "/v1/speakers/1/relationships/event",
"related": "/v1/speakers/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/speakers/1/relationships/sessions",
"related": "/v1/speakers/1/sessions"
}
}
},
"attributes": {
"website": "https://firstSpeaker.com",
"city": "Delhi",
"short-biography": "",
"name": "firstSpeaker",
"speaking-experience": "",
"country": "India",
"twitter": null,
"is-featured": false,
"is-email-overridden": false,
"linkedin": null,
"email": "firstSpeaker@gmail.com",
"long-biography": "",
"mobile": null,
"github": null,
"facebook": null,
"gender": "Man",
"position": null,
"deleted-at": null,
"organisation": null,
"sponsorship-required": "",
"heard-from": null
},
"type": "speaker",
"id": "1",
"links": {
"self": "/v1/speakers/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/speakers"
}
}List Speakers under a Session ¶
List Speakers under a SessionGET/v1/sessions/{session_id}/speakers{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/sessions/1/speakers?sort=speaking-experience&filter=[]
URI Parameters
- session_id
integer(required) Example: 1ID of the session in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: speaking-experience- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"user": {
"links": {
"self": "/v1/speakers/1/relationships/user",
"related": "/v1/speakers/1/user"
}
},
"event": {
"links": {
"self": "/v1/speakers/1/relationships/event",
"related": "/v1/speakers/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/speakers/1/relationships/sessions",
"related": "/v1/speakers/1/sessions"
}
}
},
"attributes": {
"website": "https://firstSpeaker.com",
"city": "Delhi",
"short-biography": "",
"name": "firstSpeaker",
"speaking-experience": "",
"country": "India",
"twitter": null,
"is-featured": false,
"is-email-overridden": false,
"linkedin": null,
"email": "firstSpeaker@gmail.com",
"long-biography": "",
"mobile": null,
"github": null,
"facebook": null,
"gender": "Man",
"position": null,
"deleted-at": null,
"organisation": null,
"sponsorship-required": "",
"heard-from": null
},
"type": "speaker",
"id": "1",
"links": {
"self": "/v1/speakers/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/sessions/1/speakers"
}
}List Speaker Profiles for a User ¶
List Speakers Profiles for a UserGET/v1/users/{user_id}/speakers{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/users/1/speakers?sort=speaking-experience&filter=[]
URI Parameters
- user_id
integer(required) Example: 1ID of the user in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: speaking-experience- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"user": {
"links": {
"self": "/v1/speakers/1/relationships/user",
"related": "/v1/speakers/1/user"
}
},
"event": {
"links": {
"self": "/v1/speakers/1/relationships/event",
"related": "/v1/speakers/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/speakers/1/relationships/sessions",
"related": "/v1/speakers/1/sessions"
}
}
},
"attributes": {
"website": "https://firstSpeaker.com",
"city": "Delhi",
"short-biography": "",
"name": "firstSpeaker",
"speaking-experience": "",
"country": "India",
"twitter": null,
"is-featured": false,
"is-email-overridden": false,
"linkedin": null,
"email": "firstSpeaker@gmail.com",
"long-biography": "",
"mobile": null,
"github": null,
"facebook": null,
"gender": "Man",
"position": null,
"deleted-at": null,
"organisation": null,
"sponsorship-required": "",
"heard-from": null
},
"type": "speaker",
"id": "1",
"links": {
"self": "/v1/speakers/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/1/speakers"
}
}Speakers Calls ¶
Announcement for call for speaker to accept session proposals from speakers.
| Parameter | Description | Type | Required |
|---|---|---|---|
announcement |
Announcement for speakers call | string | yes |
starts-at |
Start date of the speakers call | ISO 8601 (tz-aware) | yes |
ends-at |
End date of the speakers call | ISO 8601 (tz-aware) | yes |
hash |
Hash for speakers call | string | - |
privacy |
Privacy of speakers call | string | - |
Speakers Call Collection ¶
Create Speakers CallPOST/v1/speakers-calls{?sort,filter}
Create a new speakers call using an event_id.
Example URI
POST https://api.eventyay.com/v1/speakers-calls?sort=starts-at&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: starts-at- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"announcement": "Speaker Call Announcement",
"starts-at": "2017-06-01T01:24:47.500127+00:00",
"ends-at": "2017-06-20T01:24:47.500127+00:00",
"hash": "hash",
"privacy": "public"
},
"type": "speakers-call"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/speakers-calls/1/relationships/event",
"related": "/v1/speakers-calls/1/event"
}
}
},
"attributes": {
"announcement": "Speaker Call Announcement",
"starts-at": "2017-06-01T01:24:47.500127+00:00",
"ends-at": "2017-06-20T01:24:47.500127+00:00",
"deleted-at": null,
"hash": "hash",
"privacy": "public"
},
"type": "speakers-call",
"id": "1",
"links": {
"self": "/v1/speakers-calls/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/speaker-calls/1"
}
}Speakers Call Details ¶
Speakers Call DetailsGET/v1/speakers-calls/{speakers_call_id}
Get a single speakers call.
Example URI
GET https://api.eventyay.com/v1/speakers-calls/1
URI Parameters
- speakers_call_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/speakers-calls/1/relationships/event",
"related": "/v1/speakers-calls/1/event"
}
}
},
"attributes": {
"announcement": "Speaker Call Announcement",
"starts-at": "2017-06-01T01:24:47.500127+00:00",
"ends-at": "2017-06-20T01:24:47.500127+00:00",
"hash": "hash",
"deleted-at": null,
"privacy": "public"
},
"type": "speakers-call",
"id": "1",
"links": {
"self": "/v1/speakers-calls/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/speakers-calls/1"
}
}Update Speakers CallPATCH/v1/speakers-calls/{speakers_call_id}
Update a single speakers call by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/speakers-calls/1
URI Parameters
- speakers_call_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"announcement": "Speaker Call Announcement",
"starts-at": "2017-06-01T01:24:47.500127+00:00",
"ends-at": "2017-06-20T01:24:47.500127+00:00",
"hash": "hash",
"privacy": "public"
},
"type": "speakers-call",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/speakers-calls/1/relationships/event",
"related": "/v1/speakers-calls/1/event"
}
}
},
"attributes": {
"announcement": "Speaker Call Announcement",
"ends-at": "2017-06-20T01:24:47.500127+00:00",
"hash": "hash",
"starts-at": "2017-06-01T01:24:47.500127+00:00",
"deleted-at": null,
"privacy": "public"
},
"type": "speakers-call",
"id": "1",
"links": {
"self": "/v1/speakers-calls/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/speakers-calls/1"
}
}Delete Speakers CallDELETE/v1/speakers-calls/{speakers_call_id}
Delete a single speakers call.
Example URI
DELETE https://api.eventyay.com/v1/speakers-calls/1
URI Parameters
- speakers_call_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Get Speakers Call for an Event ¶
Get Speakers Call Details for an EventGET/v1/events/{event_identifier}/speakers-call
Example URI
GET https://api.eventyay.com/v1/events/1/speakers-call
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/speakers-calls/1/relationships/event",
"related": "/v1/speakers-calls/1/event"
}
}
},
"attributes": {
"announcement": "Speaker Call Announcement",
"ends-at": "2017-06-20T01:24:47.500127+00:00",
"hash": "hash",
"starts-at": "2017-06-01T01:24:47.500127+00:00",
"deleted-at": null,
"privacy": "public"
},
"type": "speakers-call",
"id": "1",
"links": {
"self": "/v1/speakers-calls/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/speakers-calls/1"
}
}Sponsors ¶
Data related to the various sponsors with their level, url and images associated with a specific event.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the Sponsor | string | yes |
description |
Description of the sponsor | string | - |
url |
Url of the sponsor | string | - |
level |
Level of the sponsor | integer | - |
type |
The type of the sponsor | string | - |
Sponsors Post Collection ¶
Create SponsorPOST/v1/sponsors
Create a new sponsor using an event_id.
Example URI
POST https://api.eventyay.com/v1/sponsors
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"name": "Fossasia",
"description": "Fossasia",
"logo-url": "http://example.com/example.png",
"url": "http://example.com",
"level": "1",
"type": "Gold"
},
"type": "sponsor"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/sponsors/1/relationships/event",
"related": "/v1/sponsors/1/event"
}
}
},
"attributes": {
"description": "Fossasia",
"level": "1",
"url": "http://example.com",
"logo-url": "http://example.com/example.png",
"deleted-at": null,
"type": "Gold",
"name": "Fossasia"
},
"type": "sponsor",
"id": "1",
"links": {
"self": "/v1/sponsors/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/sponsors/1"
}
}Sponsors Get Collection ¶
List All SponsorsGET/v1/events/{event_identifier}/sponsors{?sort,filter}
Get a list of Sponsors.
Example URI
GET https://api.eventyay.com/v1/events/1/sponsors?sort=level&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: level- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/sponsors/1/relationships/event",
"related": "/v1/sponsors/1/event"
}
}
},
"attributes": {
"description": "Fossasia",
"level": "1",
"url": "http://example.com",
"type": "Gold",
"deleted-at": null,
"logo-url": "http://example.com/example.png",
"name": "Fossasia"
},
"type": "sponsor",
"id": "1",
"links": {
"self": "/v1/sponsors/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/sponsors"
}
}Sponsor Details ¶
Sponsor DetailsGET/v1/sponsors/{sponsor_id}
Get a single sponsor.
Example URI
GET https://api.eventyay.com/v1/sponsors/1
URI Parameters
- sponsor_id
integer(required) Example: 1ID of the sponsor in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/sponsors/1/relationships/event",
"related": "/v1/sponsors/1/event"
}
}
},
"attributes": {
"description": "Fossasia",
"level": "1",
"url": "http://example.com",
"logo-url": "http://example.com/example.png",
"deleted-at": null,
"type": "Gold",
"name": "Fossasia"
},
"type": "sponsor",
"id": "1",
"links": {
"self": "/v1/sponsors/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/sponsors/1"
}
}Update SponsorPATCH/v1/sponsors/{sponsor_id}
Update a single sponsor by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/sponsors/1
URI Parameters
- sponsor_id
integer(required) Example: 1ID of the sponsor in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"description": "Example Description",
"url": "http://example1.com",
"level": "2",
"type": "Silver",
"name": "New Open Event Sponsor",
"logo-url": "http://example.com/example1.png"
},
"type": "sponsor",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/sponsors/1/relationships/event",
"related": "/v1/sponsors/1/event"
}
}
},
"attributes": {
"description": "Example Description",
"level": "2",
"url": "http://example.com",
"logo-url": "http://example.com/example1.png",
"deleted-at": null,
"type": "Silver",
"name": "New Open Event Sponsor"
},
"type": "sponsor",
"id": "1",
"links": {
"self": "/v1/sponsors/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/sponsors/1"
}
}Delete SponsorDELETE/v1/sponsors/{sponsor_id}
Delete a single sponsor.
Example URI
DELETE https://api.eventyay.com/v1/sponsors/1
URI Parameters
- sponsor_id
integer(required) Example: 1ID of the sponsor in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Exhibitors ¶
Data related to the various exhibitors with their name, url and images associated with a specific event.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the Exhibitor | string | yes |
description |
Description | string | - |
url |
URL | string | - |
position |
Sorting position of Exhibitor | integer | - |
logo_url |
Logo URL | string | - |
banner_url |
Banner URL | string | - |
video_url |
Video URL | string | - |
slides_url |
Slides URL | string | - |
contact-email |
Contact Email of the Exhibitor | string | - |
contact-link |
Contact Link of the Exhibitor | string | - |
Exhibitors Post Collection ¶
Create ExhibitorPOST/v1/exhibitors
Create a new exhibitor using an event_id.
Example URI
POST https://api.eventyay.com/v1/exhibitors
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"name": "Fossasia",
"description": "Fossasia",
"url": "http://example.com",
"logo-url": "http://example.com/logo.png",
"video-url": "http://example.com/video.mp4",
"slides-url": "http://example.com/slides.pdf",
"contact-email": "fossasia@fossasia.org",
"contact-link": "http://example.com",
"position": 1
},
"type": "exhibitor"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/exhibitors/1/relationships/event",
"related": "/v1/exhibitors/1/event"
}
}
},
"attributes": {
"name": "Fossasia",
"description": "Fossasia",
"url": "http://example.com",
"logo-url": "http://example.com/logo.png",
"banner-url": null,
"video-url": "http://example.com/video.mp4",
"slides-url": "http://example.com/slides.pdf",
"contact-email": "fossasia@fossasia.org",
"contact-link": "http://example.com",
"position": 1
},
"type": "exhibitor",
"id": "1",
"links": {
"self": "/v1/exhibitors/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/exhibitors/1"
}
}Exhibitors Get Collection ¶
List All ExhibitorsGET/v1/events/{event_identifier}/exhibitors{?sort,filter}
Get a list of Exhibitors.
Example URI
GET https://api.eventyay.com/v1/events/1/exhibitors?sort=position&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: position- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/exhibitors/1/relationships/event",
"related": "/v1/exhibitors/1/event"
}
}
},
"attributes": {
"description": "Fossasia",
"position": 0,
"url": "http://example.com",
"logo-url": "http://example.com/logo.png",
"banner-url": "http://example.com/banner.png",
"video-url": "http://example.com/video.mp4",
"slides-url": "http://example.com/slides.pdf",
"contact-email": "fossasia@fossasia.org",
"contact-link": "http://example.com",
"name": "Fossasia"
},
"type": "exhibitor",
"id": "1",
"links": {
"self": "/v1/exhibitors/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/exhibitors"
}
}Exhibitor Details ¶
Exhibitor DetailsGET/v1/exhibitors/{exhibitor_id}
Get a single exhibitor.
Example URI
GET https://api.eventyay.com/v1/exhibitors/1
URI Parameters
- exhibitor_id
integer(required) Example: 1ID of the exhibitor in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/exhibitors/1/relationships/event",
"related": "/v1/exhibitors/1/event"
}
}
},
"attributes": {
"description": "Fossasia",
"position": 0,
"url": "http://example.com",
"logo-url": "http://example.com/logo.png",
"banner-url": "http://example.com/banner.png",
"video-url": "http://example.com/video.mp4",
"slides-url": "http://example.com/slides.pdf",
"contact-email": "fossasia@fossasia.org",
"contact-link": "http://example.com",
"name": "Fossasia"
},
"type": "exhibitor",
"id": "1",
"links": {
"self": "/v1/exhibitors/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/exhibitors/1"
}
}Update ExhibitorPATCH/v1/exhibitors/{exhibitor_id}
Update a single exhibitor by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/exhibitors/1
URI Parameters
- exhibitor_id
integer(required) Example: 1ID of the exhibitor in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"description": "Example Description",
"url": "http://example1.com",
"position": 2,
"name": "New Open Event Exhibitor",
"logo-url": "http://example.com/example1.png",
"video-url": "http://example.com/video1.mp4",
"slides-url": "http://example.com/slides1.pdf",
"contact-email": "fossasia@fossasia.org",
"contact-link": "http://example.com"
},
"type": "exhibitor",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/exhibitors/1/relationships/event",
"related": "/v1/exhibitors/1/event"
}
}
},
"attributes": {
"name": "New Open Event Exhibitor",
"description": "Example Description",
"url": "http://example1.com",
"position": 2,
"logo-url": "http://example.com/example1.png",
"banner-url": null,
"video-url": "http://example.com/video1.mp4",
"contact-email": "fossasia@fossasia.org",
"contact-link": "http://example.com",
"slides-url": "http://example.com/slides1.pdf"
},
"type": "exhibitor",
"id": "1",
"links": {
"self": "/v1/exhibitors/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/exhibitors/1"
}
}Delete ExhibitorDELETE/v1/exhibitors/{exhibitor_id}
Delete a single exhibitor.
Example URI
DELETE https://api.eventyay.com/v1/exhibitors/1
URI Parameters
- exhibitor_id
integer(required) Example: 1ID of the exhibitor in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Tax ¶
Related to any tax related information that might be related with the tickets for the event.
| Parameter | Description | Type | Required | Public |
|---|---|---|---|---|
country |
Country of Tax | string | - | - |
name |
Name of the Tax | string | yes | yes |
rate |
Tax charges rate | float(0-100) | yes | yes |
tax-id |
A string based ID | string | yes | - |
registered-company |
Registered Company Name | string | - | - |
address |
Address of the comapany | string | - | - |
city |
City of the company | string | - | - |
state |
State of the company | string | - | - |
zip |
Zip Code of the company | integer | - | - |
invoice-footer |
A text to add on the footer | string | - | |
is-invoice-sent |
Yes/No whether invoice already sent or not | boolean (default: false) |
- | - |
is-tax-included-in-price |
Yes/No for whether tax included | boolean (default: false) |
- | yes |
should-send-invoice |
Yes/No for whether to send invoice or not | boolean (default: false) |
- | - |
Tax Collection ¶
List all TaxesGET/v1/taxes{?sort,filter}
Get a list of Taxes
Example URI
GET https://api.eventyay.com/v1/taxes?sort=rate&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: rate- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/taxes/1/relationships/event",
"related": "/v1/tax/1/event"
}
}
},
"attributes": {
"city": "example",
"name": "Service Tax",
"zip": 123456,
"should-send-invoice": false,
"country": "IN",
"address": "example",
"state": "example",
"invoice-footer": "example",
"rate": 1.23456789,
"is-tax-included-in-price": false,
"deleted-at": null,
"registered-company": "fossasia",
"tax-id": "1",
"is-invoice-sent": false
},
"type": "tax",
"id": "1",
"links": {
"self": "/v1/taxes/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/taxes"
}
}Create TaxPOST/v1/taxes{?sort,filter}
Create a new tax using an event_id.
Example URI
POST https://api.eventyay.com/v1/taxes?sort=rate&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: rate- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"city": "example",
"zip": "123456",
"country": "IN",
"is-tax-included-in-price": false,
"invoice-footer": "example",
"state": "example",
"tax-id": "123456789",
"name": "Service Tax",
"registered-company": "fossasia",
"address": "example",
"rate": "1.23456789",
"should-send-invoice": false,
"is-invoice-sent": false
},
"type": "tax"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/tax/1/relationships/event",
"related": "/v1/tax/1/event"
}
}
},
"attributes": {
"city": "example",
"zip": "123456",
"country": "IN",
"is-tax-included-in-price": false,
"invoice-footer": "example",
"state": "example",
"tax-id": "123456789",
"name": "Service Tax",
"registered-company": "fossasia",
"address": "example",
"rate": "1.23456789",
"deleted-at": null,
"should-send-invoice": false,
"is-invoice-sent": false
},
"type": "tax",
"id": "1",
"links": {
"self": "/v1/tax/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tax/1"
}
}Tax Details ¶
Tax DetailsGET/v1/taxes/{tax_id}
Get a single tax.
Example URI
GET https://api.eventyay.com/v1/taxes/1
URI Parameters
- tax_id
integer(required) Example: 1ID of the Tax in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/tax/1/relationships/event",
"related": "/v1/tax/1/event"
}
}
},
"attributes": {
"city": "example",
"zip": "123456",
"country": "IN",
"is-tax-included-in-price": false,
"invoice-footer": "example",
"state": "example",
"tax-id": "123456789",
"name": "Service Tax",
"registered-company": "fossasia",
"address": "example",
"rate": "1.23456789",
"deleted-at": null,
"should-send-invoice": false,
"is-invoice-sent": false
},
"type": "tax",
"id": "1",
"links": {
"self": "/v1/tax/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tax/1"
}
}Update TaxPATCH/v1/taxes/{tax_id}
Update a single tax by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/taxes/1
URI Parameters
- tax_id
integer(required) Example: 1ID of the Tax in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"city": "example1",
"zip": "123457",
"country": "IN",
"is-tax-included-in-price": false,
"invoice-footer": "example1",
"state": "example1",
"tax-id": "123456799",
"name": "GST",
"registered-company": "open event",
"address": "example1",
"rate": "2.3456789",
"should-send-invoice": false,
"is-invoice-sent": false
},
"type": "tax",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/tax/1/relationships/event",
"related": "/v1/tax/1/event"
}
}
},
"attributes": {
"city": "example1",
"zip": "123457",
"country": "IN",
"is-tax-included-in-price": false,
"invoice-footer": "example1",
"state": "example1",
"tax-id": "123456799",
"name": "GST",
"deleted-at": null,
"registered-company": "open event",
"address": "example1",
"rate": "2.3456789",
"should-send-invoice": false,
"is-invoice-sent": false
},
"type": "tax",
"id": "1",
"links": {
"self": "/v1/tax/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tax/1"
}
}Delete TaxDELETE/v1/taxes/{tax_id}
Delete a single tax.
Example URI
DELETE https://api.eventyay.com/v1/taxes/1
URI Parameters
- tax_id
integer(required) Example: 1ID of the Tax in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Get Tax details under an Event ¶
Get Tax details under an EventGET/v1/events/{event_identifier}/tax{?sort,filter}
Get tax details for an event.
Example URI
GET https://api.eventyay.com/v1/events/1/tax?sort=rate&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: rate- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "tax",
"attributes": {
"rate": 1.23456789,
"tax-id": "123456789",
"is-invoice-sent": false,
"zip": 123456,
"city": "example",
"name": "Service Tax",
"should-send-invoice": false,
"invoice-footer": "example",
"address": "example",
"registered-company": "fossasia",
"is-tax-included-in-price": false,
"deleted-at": null,
"country": "IN",
"state": "example"
},
"relationships": {
"event": {
"links": {
"self": "/v1/taxes/1/relationships/event",
"related": "/v1/tax/1/event"
}
}
},
"id": "1",
"links": {
"self": "/v1/taxes/1"
}
},
"links": {
"self": "/v1/taxes/1"
},
"jsonapi": {
"version": "1.0"
}
}Tickets ¶
Related to tickets (free, paid, donation) to the event.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the ticket | string | yes |
type |
Type of the ticket | string | yes |
description |
Description of the ticket | string | - |
price |
Price of the ticket | float | - |
quantity |
Total quantity of the ticket | integer | - |
min-order |
Min order of the ticket | string | - |
max-order |
Max order of the ticket | string | - |
position |
Position of the ticket | string | - |
sales-starts-at |
Start date of ticket sale | ISO 8601 (tz-aware) | yes |
sales-ends-at |
End date of ticket sale | ISO 8601 (tz-aware) | yes |
is-description-visible |
Yes/No to enter description | boolean (default: false) |
- |
is-checkin-restricted |
Yes/No to checkin restriction | boolean (deault: true) |
- |
auto-checkin-enabled |
Yes/No to enable auto checkin | boolean (default: false) |
- |
is-hidden |
Yes/No to hide ticket | boolean (default: false) |
- |
is-fee-absorbed |
Yes/No for ticket absorption | boolean (default: false) |
- |
Tickets Collection ¶
Create TicketPOST/v1/tickets{?sort,filter}
Create a new ticket using an event_id.
Example URI
POST https://api.eventyay.com/v1/tickets?sort=sales-starts-at&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: sales-starts-at- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"name": "ticket-name",
"description": "some description",
"type": "VIP-ticket",
"price": "100.00",
"quantity": "100",
"is-description-visible": "false",
"is-checkin-restricted": "true",
"auto-checkin-enabled": "false",
"position": "1",
"is-fee-absorbed": "false",
"sales-starts-at": "2017-06-01T01:24:47.500127+00:00",
"sales-ends-at": "2017-06-30T00:24:47.500127+00:00",
"is-hidden": "false",
"min-order": "1",
"max-order": "100"
},
"type": "ticket"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"ticket-tags": {
"links": {
"self": "/v1/tickets/1/relationships/ticket-tags",
"related": "/v1/tickets/1/ticket-tags"
}
},
"access-codes": {
"links": {
"self": "/v1/tickets/1/relationships/access-codes",
"related": "/v1/tickets/1/access-codes"
}
},
"event": {
"links": {
"self": "/v1/tickets/1/relationships/event",
"related": "/v1/tickets/1/event"
}
},
"discount-codes": {
"links": {
"self": "/v1/tickets/1/relationships/discount-codes",
"related": "/v1/tickets/1/discount-codes"
}
}
},
"attributes": {
"description": "some description",
"type": "VIP-ticket",
"price": 100,
"name": "ticket-name",
"max-order": 100,
"is-description-visible": false,
"is-checkin-restricted": "true",
"auto-checkin-enabled": "false",
"is-fee-absorbed": false,
"position": 1,
"quantity": 100,
"is-hidden": false,
"deleted-at": null,
"sales-ends-at": "2017-06-30T00:24:47.500127+00:00",
"min-order": 1,
"sales-starts-at": "2017-06-01T01:24:47.500127+00:00"
},
"type": "ticket",
"id": "3",
"links": {
"self": "/v1/tickets/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tickets/1"
}
}Ticket Details ¶
Ticket DetailsGET/v1/tickets/{ticket_id}
Get a single ticket.
Example URI
GET https://api.eventyay.com/v1/tickets/1
URI Parameters
- ticket_id
integer(required) Example: 1ID of the ticket in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"ticket-tags": {
"links": {
"self": "/v1/tickets/1/relationships/ticket-tags",
"related": "/v1/tickets/1/ticket-tags"
}
},
"access-codes": {
"links": {
"self": "/v1/tickets/1/relationships/access-codes",
"related": "/v1/tickets/1/access-codes"
}
},
"discount-codes": {
"links": {
"self": "/v1/tickets/1/relationships/discount-codes",
"related": "/v1/tickets/1/discount-codes"
}
},
"event": {
"links": {
"self": "/v1/tickets/1/relationships/event",
"related": "/v1/tickets/1/event"
}
}
},
"attributes": {
"description": "some description",
"type": "VIP-ticket",
"price": 100,
"name": "ticket-name",
"max-order": 100,
"is-description-visible": false,
"is-checkin-restricted": "true",
"auto-checkin-enabled": "false",
"is-fee-absorbed": false,
"position": 1,
"quantity": 100,
"is-hidden": false,
"deleted-at": null,
"sales-ends-at": "2017-06-30T00:24:47.500127+00:00",
"min-order": 1,
"sales-starts-at": "2017-06-01T01:24:47.500127+00:00"
},
"type": "ticket",
"id": "1",
"links": {
"self": "/v1/tickets/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tickets/1"
}
}Update TicketPATCH/v1/tickets/{ticket_id}
Update a single ticket by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/tickets/1
URI Parameters
- ticket_id
integer(required) Example: 1ID of the ticket in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "ticket-name",
"description": "some description",
"type": "VIP-ticket",
"price": "100.00",
"quantity": "100",
"is-description-visible": "false",
"is-checkin-restricted": "true",
"auto-checkin-enabled": "false",
"position": "1",
"is-fee-absorbed": "false",
"sales-starts-at": "2017-06-01T01:24:47.500127+00:00",
"sales-ends-at": "2017-06-30T00:24:47.500127+00:00",
"is-hidden": "false",
"min-order": "5",
"max-order": "100"
},
"type": "ticket",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"ticket-tags": {
"links": {
"self": "/v1/tickets/1/relationships/ticket-tags",
"related": "/v1/tickets/1/ticket-tags"
}
},
"access-codes": {
"links": {
"self": "/v1/tickets/1/relationships/access-codes",
"related": "/v1/tickets/1/access-codes"
}
},
"discount-codes": {
"links": {
"self": "/v1/tickets/1/relationships/discount-codes",
"related": "/v1/tickets/1/discount-codes"
}
},
"event": {
"links": {
"self": "/v1/tickets/1/relationships/event",
"related": "/v1/tickets/1/event"
}
}
},
"attributes": {
"description": "some description",
"type": "VIP-ticket",
"price": 100,
"name": "ticket-name",
"max-order": 100,
"is-description-visible": false,
"is-checkin-restricted": "true",
"auto-checkin-enabled": "false",
"is-fee-absorbed": false,
"position": 1,
"quantity": 100,
"is-hidden": false,
"deleted-at": null,
"sales-ends-at": "2017-06-30T00:24:47.500127+00:00",
"min-order": 5,
"sales-starts-at": "2017-06-01T01:24:47.500127+00:00"
},
"type": "ticket",
"id": "1",
"links": {
"self": "/v1/tickets/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tickets/1"
}
}Delete TicketDELETE/v1/tickets/{ticket_id}
Delete a single ticket.
Example URI
DELETE https://api.eventyay.com/v1/tickets/1
URI Parameters
- ticket_id
integer(required) Example: 1ID of the ticket in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}List Tickets under an Event ¶
List Tickets under an EventGET/v1/events/{event_identifier}/tickets{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/events/1/tickets?sort=sales-starts-at&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: sales-starts-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"ticket-tags": {
"links": {
"self": "/v1/tickets/1/relationships/ticket-tags",
"related": "/v1/tickets/1/ticket-tags"
}
},
"access-codes": {
"links": {
"self": "/v1/tickets/1/relationships/access-codes",
"related": "/v1/tickets/1/access-codes"
}
},
"discount-codes": {
"links": {
"self": "/v1/tickets/1/relationships/discount-codes",
"related": "/v1/tickets/1/discount-codes"
}
},
"event": {
"links": {
"self": "/v1/tickets/1/relationships/event",
"related": "/v1/tickets/1/event"
}
}
},
"attributes": {
"description": "some description",
"type": "VIP-ticket",
"price": 100,
"name": "ticket-name",
"max-order": 100,
"is-description-visible": false,
"is-checkin-restricted": "true",
"auto-checkin-enabled": "false",
"is-fee-absorbed": false,
"position": 1,
"quantity": 100,
"is-hidden": false,
"deleted-at": null,
"sales-ends-at": "2017-06-30T00:24:47.500127+00:00",
"min-order": 1,
"sales-starts-at": "2017-06-01T01:24:47.500127+00:00"
},
"type": "ticket",
"id": "1",
"links": {
"self": "/v1/tickets/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/tickets"
}
}List Tickets under a Ticket-tag ¶
List Tickets under a Ticket-tagGET/v1/ticket-tags/{ticket_tag_id}/tickets{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/ticket-tags/1/tickets?sort=sales-starts-at&filter=[]
URI Parameters
- ticket_tag_id
string(required) Example: 1id of the ticket-tag in integer.
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: sales-starts-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"ticket-tags": {
"links": {
"self": "/v1/tickets/1/relationships/ticket-tags",
"related": "/v1/tickets/1/ticket-tags"
}
},
"access-codes": {
"links": {
"self": "/v1/tickets/1/relationships/access-codes",
"related": "/v1/tickets/1/access-codes"
}
},
"discount-codes": {
"links": {
"self": "/v1/tickets/1/relationships/discount-codes",
"related": "/v1/tickets/1/discount-codes"
}
},
"event": {
"links": {
"self": "/v1/tickets/1/relationships/event",
"related": "/v1/tickets/1/event"
}
}
},
"attributes": {
"description": "some description",
"type": "VIP-ticket",
"price": 100,
"name": "ticket-name",
"max-order": 100,
"is-description-visible": false,
"is-checkin-restricted": "true",
"auto-checkin-enabled": "false",
"is-fee-absorbed": false,
"position": 1,
"quantity": 100,
"is-hidden": false,
"deleted-at": null,
"sales-ends-at": "2017-06-30T00:24:47.500127+00:00",
"min-order": 1,
"sales-starts-at": "2017-06-01T01:24:47.500127+00:00"
},
"type": "ticket",
"id": "1",
"links": {
"self": "/v1/tickets/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/ticket-tags/1/tickets"
}
}List Tickets for an Access Code ¶
List Tickets for an Access CodeGET/v1/access-codes/{access_code_id}/tickets{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/access-codes/1/tickets?sort=sales-starts-at&filter=[]
URI Parameters
- access_code_id
integer(required) Example: 1ID of the access code in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: sales-starts-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"ticket-tags": {
"links": {
"self": "/v1/tickets/1/relationships/ticket-tags",
"related": "/v1/tickets/1/ticket-tags"
}
},
"access-codes": {
"links": {
"self": "/v1/tickets/1/relationships/access-codes",
"related": "/v1/tickets/1/access-codes"
}
},
"discount-codes": {
"links": {
"self": "/v1/tickets/1/relationships/discount-codes",
"related": "/v1/tickets/1/discount-codes"
}
},
"event": {
"links": {
"self": "/v1/tickets/1/relationships/event",
"related": "/v1/tickets/1/event"
}
}
},
"attributes": {
"description": "some description",
"type": "VIP-ticket",
"price": 100,
"name": "ticket-name",
"max-order": 100,
"is-description-visible": false,
"is-checkin-restricted": "true",
"auto-checkin-enabled": "false",
"is-fee-absorbed": false,
"position": 1,
"quantity": 100,
"is-hidden": false,
"deleted-at": null,
"sales-ends-at": "2017-06-30T00:24:47.500127+00:00",
"min-order": 1,
"sales-starts-at": "2017-06-01T01:24:47.500127+00:00"
},
"type": "ticket",
"id": "1",
"links": {
"self": "/v1/tickets/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/access-codes/1/tickets"
}
}List Tickets for a Discount Code ¶
List Tickets for a Discount CodeGET/v1/discount-codes/{discount_code_id}/tickets{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/discount-codes/1/tickets?sort=sales-starts-at&filter=[]
URI Parameters
- discount_code_id
integer(required) Example: 1ID of the discount code in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: sales-starts-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "ticket",
"attributes": {
"sales-ends-at": "2017-06-30T00:24:47.500127+00:00",
"type": "VIP-ticket",
"price": 100,
"quantity": 100,
"is-description-visible": false,
"deleted-at": null,
"name": "some-ticket-name",
"max-order": 100,
"min-order": 1,
"description": "some description",
"sales-starts-at": "2017-06-01T01:24:47.500127+00:00",
"is-hidden": false,
"is-fee-absorbed": false,
"position": 1
},
"relationships": {
"attendees": {
"links": {
"self": "/v1/tickets/1/relationships/attendees",
"related": "/v1/attendees?ticket_id=1"
}
},
"access-codes": {
"links": {
"self": "/v1/tickets/1/relationships/access-codes",
"related": "/v1/tickets/1/access-codes"
}
},
"discount-codes": {
"links": {
"self": "/v1/tickets/1/relationships/discount-codes",
"related": "/v1/tickets/1/discount-codes"
}
},
"event": {
"links": {
"self": "/v1/tickets/1/relationships/event",
"related": "/v1/tickets/1/event"
}
},
"ticket-tags": {
"links": {
"self": "/v1/tickets/1/relationships/ticket-tags",
"related": "/v1/tickets/1/ticket-tags"
}
}
},
"id": "1",
"links": {
"self": "/v1/tickets/1"
}
}
],
"links": {
"self": "/v1/discount-codes/1/tickets"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}List Tickets for an Order ¶
List Tickets for an OrderGET/v1/orders/{order_identifier}/tickets
Example URI
GET https://api.eventyay.com/v1/orders/7201904e/tickets
URI Parameters
- order_identifier
string(required) Example: 7201904eIndetifier of the order
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"ticket-tags": {
"links": {
"self": "/v1/tickets/1/relationships/ticket-tags",
"related": "/v1/tickets/1/ticket-tags"
}
},
"event": {
"links": {
"self": "/v1/tickets/1/relationships/event",
"related": "/v1/tickets/1/event"
}
},
"discount-codes": {
"links": {
"self": "/v1/tickets/1/relationships/discount-codes",
"related": "/v1/tickets/1/discount-codes"
}
}
},
"attributes": {
"description": "some description",
"type": "VIP-ticket",
"price": 100,
"name": "ticket-name0",
"max-order": 100,
"is-description-visible": true,
"is-checkin-restricted": "true",
"auto-checkin-enabled": "false",
"is-fee-absorbed": true,
"position": 1,
"quantity": 100,
"is-hidden": false,
"deleted-at": null,
"sales-ends-at": "2018-06-30T00:24:47.500127+00:00",
"min-order": 1,
"sales-starts-at": "2017-06-01T01:24:47.500127+00:00"
},
"type": "ticket",
"id": "1",
"links": {
"self": "/v1/tickets/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/orders/7201904e-c695-4251-a30a-61765a37ff24/tickets"
}
}Attendees ¶
Related to ticket holders(attendees) of an event (free, paid, donation) to the event.
| Parameter | Description | Type | Required |
|---|---|---|---|
firstname |
First name of the Attendee | string | yes |
lastname |
Last name of the Attendee | string | yes |
email |
Email of the Attendee | string | - |
address |
Address of the Attendee | float | - |
city |
City of the Attendee | integer | - |
state |
State of the Attendee | string | - |
country |
Country of the Attendee | string | - |
is-checked-in |
If the attendee is checked in | boolean | - |
checkin-times |
Comma separated checkin times | string | - |
is-checked-out |
If the attendee has checked out | boolean | - |
attendee-notes |
Comma separated attendee notes | string | - |
pdf-url |
pdf url of the Attendee | url | - |
is-registered |
If the attendee is registered | boolean | - |
register-times |
Comma separated register times | string | - |
Send order receipts [v1/attendees/send-receipt]
Send email receipts to attendees [POST]
Send order receipts to attendees via email (requires organizer access).
-
Request
-
Headers
Accept: application/json Authorization: JWT <Auth Key> -
Body
{ "order-identifier": "xyz789" }
-
-
Response 200 (application/vnd.api+json)
{ "message": "receipt sent to attendees" }
Attendees Collection ¶
List Attendees under an order ¶
List All Attendees under an orderGET/v1/orders/{order_identifier}/attendees
Get a list of attendees of an order.
Example URI
GET https://api.eventyay.com/v1/orders/7201904e/attendees
URI Parameters
- order_identifier
string(required) Example: 7201904eIdentifier of the order
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"ticket": {
"links": {
"self": "/v1/attendees/1/relationships/ticket",
"related": "/v1/attendees/1/ticket"
}
},
"order": {
"links": {
"self": "/v1/attendees/1/relationships/order",
"related": "/v1/attendees/1/order"
}
},
"event": {
"links": {
"self": "/v1/attendees/1/relationships/event",
"related": "/v1/attendees/1/event"
}
},
"user": {
"links": {
"self": "/v1/attendees/1/relationships/user",
"related": "/v1/attendees/1/user"
}
}
},
"attributes": {
"facebook": null,
"address": "address",
"ticket-id": "31",
"is-checked-out": null,
"checkout-times": null,
"job-title": null,
"deleted-at": null,
"work-address": null,
"checkin-times": null,
"register-times": null,
"state": "example",
"country": "IN",
"lastname": "UnDoe",
"city": "example",
"phone": null,
"company": null,
"is-checked-in": false,
"is-registered": false,
"gender": null,
"shipping-address": null,
"blog": null,
"firstname": "John",
"website": null,
"billing-address": null,
"pdf-url": null,
"tax-business-info": null,
"home-address": null,
"work-phone": null,
"birth-date": null,
"github": null,
"twitter": null,
"email": "johndoe@example.com",
"attendee-notes": null
},
"type": "attendee",
"id": "1",
"links": {
"self": "/v1/attendees/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/orders/7201904e-c695-4251-a30a-61765a37ff24/attendees"
}
}List Attendees under an event ¶
List All Attendees under an eventGET/v1/events/{event_id}/attendees
Get a list of attendees of an event.
Example URI
GET https://api.eventyay.com/v1/events/1/attendees
URI Parameters
- event_id
integer(required) Example: 1Identifier of the event
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"ticket": {
"links": {
"self": "/v1/attendees/1/relationships/ticket",
"related": "/v1/attendees/1/ticket"
}
},
"order": {
"links": {
"self": "/v1/attendees/1/relationships/order",
"related": "/v1/attendees/1/order"
}
},
"event": {
"links": {
"self": "/v1/attendees/1/relationships/event",
"related": "/v1/attendees/1/event"
}
},
"user": {
"links": {
"self": "/v1/attendees/1/relationships/user",
"related": "/v1/attendees/1/user"
}
}
},
"attributes": {
"facebook": null,
"address": "address",
"ticket-id": "31",
"is-checked-out": null,
"checkout-times": null,
"job-title": null,
"deleted-at": null,
"work-address": null,
"checkin-times": null,
"register-times": null,
"state": "example",
"country": "IN",
"lastname": "UnDoe",
"city": "example",
"phone": null,
"company": null,
"is-checked-in": false,
"is-registered": false,
"gender": null,
"shipping-address": null,
"blog": null,
"firstname": "John",
"website": null,
"billing-address": null,
"pdf-url": null,
"tax-business-info": null,
"home-address": null,
"work-phone": null,
"birth-date": null,
"github": null,
"twitter": null,
"email": "johndoe@example.com",
"attendee-notes": null
},
"type": "attendee",
"id": "1",
"links": {
"self": "/v1/attendees/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/attendees"
}
}Search Attendees under an event ¶
Search All Attendees under an eventGET/v1/events/{event_id}/attendees/search
Search a list of attendees of an event.
Example URI
GET https://api.eventyay.com/v1/events/1/attendees/search
URI Parameters
- event_id
integer(required) Example: 1Identifier of the event
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"attendees": [
{
"facebook": null,
"address": "address",
"ticket-id": "31",
"is-checked-out": null,
"checkout-times": null,
"job-title": null,
"deleted-at": null,
"work-address": null,
"checkin-times": null,
"state": "example",
"country": "IN",
"lastname": "UnDoe",
"city": "example",
"phone": null,
"company": null,
"is-checked-in": false,
"is-registered": false,
"register-times": null,
"gender": null,
"shipping-address": null,
"blog": null,
"firstname": "John",
"website": null,
"billing-address": null,
"pdf-url": null,
"tax-business-info": null,
"home-address": null,
"work-phone": null,
"birth-date": null,
"github": null,
"twitter": null,
"email": "johndoe@example.com",
"attendee-notes": null
}
]
}List Attendees under a ticket ¶
List All Attendees under a ticketGET/v1/tickets/{ticket_id}/attendees
Get a list of attendees of a ticket.
Example URI
GET https://api.eventyay.com/v1/tickets/1/attendees
URI Parameters
- ticket_id
integer(required) Example: 1Identifier of the event
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"ticket": {
"links": {
"self": "/v1/attendees/1/relationships/ticket",
"related": "/v1/attendees/1/ticket"
}
},
"order": {
"links": {
"self": "/v1/attendees/1/relationships/order",
"related": "/v1/attendees/1/order"
}
},
"event": {
"links": {
"self": "/v1/attendees/1/relationships/event",
"related": "/v1/attendees/1/event"
}
},
"user": {
"links": {
"self": "/v1/attendees/1/relationships/user",
"related": "/v1/attendees/1/user"
}
}
},
"attributes": {
"facebook": null,
"address": "address",
"ticket-id": "1",
"is-checked-out": null,
"checkout-times": null,
"job-title": null,
"deleted-at": null,
"work-address": null,
"checkin-times": null,
"state": "example",
"country": "IN",
"lastname": "UnDoe",
"city": "example",
"phone": null,
"company": null,
"is-checked-in": false,
"is-registered": false,
"register-times": null,
"gender": null,
"shipping-address": null,
"blog": null,
"firstname": "John",
"website": null,
"billing-address": null,
"pdf-url": null,
"tax-business-info": null,
"home-address": null,
"work-phone": null,
"birth-date": null,
"github": null,
"twitter": null,
"email": "johndoe@example.com",
"attendee-notes": null
},
"type": "attendee",
"id": "1",
"links": {
"self": "/v1/attendees/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tickets/1/attendees"
}
}Attendee Details ¶
Attendee DetailsGET/v1/attendees/{attendee_id}
Get a single attendee.
Example URI
GET https://api.eventyay.com/v1/attendees/1
URI Parameters
- attendee_id
integer(required) Example: 1ID of the attendee in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"ticket": {
"links": {
"self": "/v1/attendees/1/relationships/ticket",
"related": "/v1/attendees/1/ticket"
}
},
"order": {
"links": {
"self": "/v1/attendees/1/relationships/order",
"related": "/v1/attendees/1/order"
}
}
},
"attributes": {
"facebook": null,
"address": "address",
"ticket-id": "31",
"is-checked-out": null,
"checkout-times": null,
"job-title": null,
"deleted-at": null,
"work-address": null,
"checkin-times": null,
"state": "example",
"country": "IN",
"lastname": "UnDoe",
"city": "example",
"phone": null,
"company": null,
"is-checked-in": false,
"is-registered": false,
"register-times": null,
"gender": null,
"shipping-address": null,
"blog": null,
"firstname": "John",
"website": null,
"billing-address": null,
"pdf-url": null,
"tax-business-info": null,
"home-address": null,
"work-phone": null,
"birth-date": null,
"github": null,
"twitter": null,
"email": "johndoe@example.com",
"attendee-notes": null
},
"type": "attendee",
"id": "1",
"links": {
"self": "/v1/attendees/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/attendees/1"
}
}Update AttendeePATCH/v1/attendees/{attendee_id}
Update a single attendee by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/attendees/1
URI Parameters
- attendee_id
integer(required) Example: 1ID of the attendee in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"firstname": "John",
"lastname": "Doe",
"email": "johndoe@example.com",
"address": "address",
"city": "example",
"state": "example",
"country": "IN",
"is-checked-in": "true",
"checkin-times": "2017-12-13T22:59:59.123456+00:00",
"attendee-notes": "example",
"pdf-url": "http://example.com"
},
"type": "attendee",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"ticket": {
"links": {
"self": "/v1/attendees/1/relationships/ticket",
"related": "/v1/attendees/1/ticket"
}
}
},
"attributes": {
"facebook": null,
"address": "address",
"ticket-id": "31",
"is-checked-out": null,
"checkout-times": null,
"job-title": null,
"deleted-at": null,
"work-address": null,
"checkin-times": null,
"state": "example",
"country": "IN",
"lastname": "UnDoe",
"city": "example",
"phone": null,
"company": null,
"is-checked-in": false,
"gender": null,
"shipping-address": null,
"blog": null,
"firstname": "John",
"website": null,
"billing-address": null,
"pdf-url": null,
"tax-business-info": null,
"home-address": null,
"work-phone": null,
"birth-date": null,
"github": null,
"twitter": null,
"email": "johndoe@example.com",
"attendee-notes": null
},
"type": "attendee",
"id": "1",
"links": {
"self": "/v1/attendees/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/attendees/1"
}
}Delete AttendeeDELETE/v1/attendees/{attendee_id}
Delete a single attendee.
Example URI
DELETE https://api.eventyay.com/v1/attendees/1
URI Parameters
- attendee_id
integer(required) Example: 1ID of the attendee in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Get Attendee State ¶
Get Attendee StateGET/v1/states{?event_id,attendee_id}
Check attendee state if attendee is registered or not.
Example URI
GET https://api.eventyay.com/v1/states?event_id=1&attendee_id=1
URI Parameters
- event_id
integer(required) Example: 1Identifier of the event
- attendee_id
integer(required) Example: 1ID of the attendee in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"is_registered": true,
"register_times": "2023-08-08 03:03:52.827812"
}Ticket Fees ¶
Ticket Fees basically stores the fee on a ticket
| Parameter | Description | Type | Required |
|---|---|---|---|
currency |
Currency of the ticket | string | - |
service-fee |
Service fee the ticket | float | - |
maximum-fee |
Maximum fee the ticket | float | - |
Ticket Fees Collection ¶
List Ticket FeesGET/v1/ticket-fees{?sort,filter}
Get a list of Ticket Fees.
Example URI
GET https://api.eventyay.com/v1/ticket-fees?sort=service-fee&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: service-fee- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"attributes": {
"currency": "USD",
"service-fee": 3.14,
"maximum-fee": 5.14
},
"type": "ticket-fee",
"id": 2,
"links": {
"self": "/v1/ticket-fees/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/ticket-fees"
}
}Create Ticket FeePOST/v1/ticket-fees{?sort,filter}
Create a new ticket fee.
Example URI
POST https://api.eventyay.com/v1/ticket-fees?sort=service-fee&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: service-fee- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "ticket-fee",
"attributes": {
"currency": "USD",
"service-fee": "3.14",
"maximum-fee": "5.14"
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"currency": "USD",
"service-fee": 3.14,
"maximum-fee": 5.14
},
"type": "ticket-fee",
"id": 1,
"links": {
"self": "/v1/ticket-fees/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/ticket-fees/1"
}
}Ticket Fee Details ¶
Get Ticket Fees DetailsGET/v1/ticket-fees/{id}
Get a single ticket fee details.
Example URI
GET https://api.eventyay.com/v1/ticket-fees/1
URI Parameters
- id
integer(required) Example: 1ID of the ticket fees as an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"currency": "USD",
"service-fee": 3.14,
"maximum-fee": 5.14
},
"type": "ticket-fee",
"id": 1,
"links": {
"self": "/v1/ticket-fees/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/ticket-fees/1"
}
}Update Ticket FeesPATCH/v1/ticket-fees/{id}
Update a single ticket fee by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/ticket-fees/1
URI Parameters
- id
integer(required) Example: 1ID of the ticket fees as an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"id": "1",
"type": "ticket-fee",
"attributes": {
"currency": "USD",
"service-fee": "2.14",
"maximum-fee": "3.14"
}
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"currency": "USD",
"service-fee": 2.14,
"maximum-fee": 3.14
},
"type": "ticket-fee",
"id": 1,
"links": {
"self": "/v1/ticket-fees/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/ticket-fees/1"
}
}Delete Ticket FeesDELETE/v1/ticket-fees/{id}
Delete a single ticket fee.
id(integer) - ID of the record to delete (required)
Example URI
DELETE https://api.eventyay.com/v1/ticket-fees/1
URI Parameters
- id
integer(required) Example: 1ID of the ticket fees as an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Tracks ¶
Data related to the various tracks (e.g, python, AI, etc.) associated with the various sessions in the event.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the track | string | yes |
description |
Description of the track | string | - |
color |
Color code of the track (can be in hex notation(e.g, #a04b4b) or decimal notation from 0 to 255(e.g, rgba(160, 75, 75, 0.5))) | string | yes |
font-color |
Font Color of the track (black/white: no user role - automatically updated) | string | - |
Tracks Collection ¶
Create TrackPOST/v1/tracks{?sort,filter}
Create a new track using an event_id.
Example URI
POST https://api.eventyay.com/v1/tracks?sort=color&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: color- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"name": "Main Track",
"description": "description",
"color": "#a04b4b"
},
"type": "track"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/tracks/1/relationships/event",
"related": "/v1/tracks/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/tracks/1/relationships/sessions",
"related": "/v1/tracks/1/sessions"
}
}
},
"attributes": {
"name": "Main Track",
"description": "description",
"color": "#a04b4b",
"deleted-at": null,
"font-color": "#ffffff"
},
"type": "track",
"id": "1",
"links": {
"self": "/v1/tracks/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tracks/1"
}
}Track Detail ¶
Get DetailsGET/v1/tracks/{track_id}
Get a single track.
Example URI
GET https://api.eventyay.com/v1/tracks/1
URI Parameters
- track_id
integer(required) Example: 1ID of the track in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/tracks/1/relationships/event",
"related": "/v1/tracks/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/tracks/1/relationships/sessions",
"related": "/v1/tracks/1/sessions"
}
}
},
"attributes": {
"name": "Main Track",
"description": "description",
"color": "#a04b4b",
"deleted-at": null,
"font-color": "#ffffff"
},
"type": "track",
"id": "1",
"links": {
"self": "/v1/tracks/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tracks/1"
}
}Update TrackPATCH/v1/tracks/{track_id}
Update a single track by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/tracks/1
URI Parameters
- track_id
integer(required) Example: 1ID of the track in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "Main Track",
"description": "description",
"color": "#a04b4b"
},
"type": "track",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/tracks/1/relationships/event",
"related": "/v1/tracks/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/tracks/1/relationships/sessions",
"related": "/v1/tracks/1/sessions"
}
}
},
"attributes": {
"color": "#a04b4b",
"description": "description",
"name": "Main Track",
"deleted-at": null,
"font-color": "#ffffff"
},
"type": "track",
"id": "1",
"links": {
"self": "/v1/tracks/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tracks/1"
}
}Delete TrackDELETE/v1/tracks/{track_id}
Delete a single track.
Example URI
DELETE https://api.eventyay.com/v1/tracks/1
URI Parameters
- track_id
integer(required) Example: 1ID of the track in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Tracks under an Event ¶
Get List of Tracks under an EventGET/v1/events/{event_identifier}/tracks{?sort,filter}
Get a single track.
Example URI
GET https://api.eventyay.com/v1/events/1/tracks?sort=name&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/tracks/1/relationships/event",
"related": "/v1/tracks/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/tracks/1/relationships/sessions",
"related": "/v1/tracks/1/sessions"
}
}
},
"attributes": {
"color": "#a04b4b",
"description": "description",
"name": "Main Track",
"deleted-at": null,
"font-color": "#ffffff"
},
"type": "track",
"id": "1",
"links": {
"self": "/v1/tracks/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/tracks"
}
}Tracks Details of a Session ¶
Get Track Details of a SessionGET/v1/sessions/{session_id}/track
Get a single track.
Example URI
GET https://api.eventyay.com/v1/sessions/1/track
URI Parameters
- session_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/tracks/1/relationships/event",
"related": "/v1/tracks/1/event"
}
},
"sessions": {
"links": {
"self": "/v1/tracks/1/relationships/sessions",
"related": "/v1/tracks/1/sessions"
}
}
},
"attributes": {
"color": "#a04b4b",
"description": "description",
"name": "Main Track",
"deleted-at": null,
"font-color": "#ffffff"
},
"type": "track",
"id": "1",
"links": {
"self": "/v1/tracks/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tracks/1"
}
}Notifications ¶
Notifications related to the various users about invites, ticket purchase, session proposal etc.
| Parameter | Description | Type | Required |
|---|---|---|---|
is-read |
Yes/No for read notification | boolean (default: false) |
- |
created-at |
Notification created time | ISO 8601 (tz-aware) | - |
Notifications Collection ¶
List All NotificationsGET/v1/users/{user_id}/notifications{?sort,filter}
Get a list of Notifications.
Example URI
GET https://api.eventyay.com/v1/users/2/notifications?sort=created-at&filter=[]
URI Parameters
- user_id
integer(required) Example: 2ID of the specific user in integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: created-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"user": {
"links": {
"self": "/v1/notifications/1/relationships/user",
"related": "/v1/notifications/1/user"
}
}
},
"attributes": {
"created-at": "2017-06-23T04:40:37.239724+00:00",
"is-read": false
},
"type": "notification",
"id": "1",
"links": {
"self": "/v1/notifications/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/2/notifications"
}
}Notifications Admin Collection ¶
List All NotificationsGET/v1/notifications{?sort,filter}
Get a list of Notifications.
Example URI
GET https://api.eventyay.com/v1/notifications?sort=created-at&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: created-at- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"user": {
"links": {
"self": "/v1/notifications/1/relationships/user",
"related": "/v1/notifications/1/user"
}
}
},
"attributes": {
"created-at": "2017-06-23T04:40:37.239724+00:00",
"is-read": false
},
"type": "notification",
"id": "1",
"links": {
"self": "/v1/notifications/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/notifications"
}
}Notification Detail ¶
Notification DetailGET/v1/notifications/{notification_id}
Get a single notification.
Example URI
GET https://api.eventyay.com/v1/notifications/1
URI Parameters
- notification_id
integer(required) Example: 1ID of the notification in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"user": {
"links": {
"self": "/v1/notifications/1/relationships/user",
"related": "/v1/notifications/1/user"
}
}
},
"attributes": {
"created-at": "2017-06-23T04:40:37.239724+00:00",
"is-read": false
},
"type": "notification",
"id": "1"
},
"jsonapi": {
"version": "1.0"
}
}Update NotificationPATCH/v1/notifications/{notification_id}
Update a single notification with id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/notifications/1
URI Parameters
- notification_id
integer(required) Example: 1ID of the notification in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"is-read": true
},
"type": "notification",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"user": {
"links": {
"self": "/v1/notifications/1/relationships/user",
"related": "/v1/notifications/1/user"
}
}
},
"attributes": {
"created-at": "2017-06-23T04:40:37.239724+00:00",
"is-read": true
},
"type": "notification",
"id": "1"
},
"jsonapi": {
"version": "1.0"
}
}Delete NotificationDELETE/v1/notifications/{notification_id}
Delete a single notification.
Example URI
DELETE https://api.eventyay.com/v1/notifications/1
URI Parameters
- notification_id
integer(required) Example: 1ID of the notification in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Email Notifications ¶
To turn Email Notifications ON/OFF related to the various events, session approval etc.
| Parameter | Description | Type | Required |
|---|---|---|---|
next-event |
Next event email notification | boolean (default=false) |
- |
new-paper |
New paper email notification | boolean (default=false) |
- |
session-accept-reject |
Session Accept/Reject email notification | boolean (default=false) |
- |
session-schedule |
Session schedule email notification | boolean (default=false) |
- |
after-ticket-purchase |
Email notification after ticket purchase | boolean (default=true) |
- |
event-id |
Event specific notification preferences | integer | - |
Email Notifications Admin Collection ¶
List All Email NotificationsGET/v1/email-notifications{?sort,filter}
Get a list of Notifications.
Example URI
GET https://api.eventyay.com/v1/email-notifications?sort=next-event&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: next-event- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"user": {
"links": {
"self": "/v1/email-notifications/1/relationships/user",
"related": "/v1/email-notifications/1/user"
}
},
"event": {
"links": {
"self": "/v1/email-notifications/1/relationships/event",
"related": "/v1/email-notifications/1/event"
}
}
},
"attributes": {
"next-event": false,
"new-paper": false,
"session-accept-reject": false,
"session-schedule": true,
"deleted-at": null,
"after-ticket-purchase": true,
"event-id": 1
},
"type": "email-notification",
"id": "1",
"links": {
"self": "/v1/email-notifications/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/email-notifications"
}
}Email Notifications Collection ¶
List All Email NotificationsGET/v1/users/{user_id}/email-notifications{?sort,filter}
Get a list of Notifications.
Example URI
GET https://api.eventyay.com/v1/users/2/email-notifications?sort=next-event&filter=[]
URI Parameters
- user_id
integer(required) Example: 2ID of the specific user in integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: next-event- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"user": {
"links": {
"self": "/v1/email-notifications/1/relationships/user",
"related": "/v1/email-notifications/1/user"
}
},
"event": {
"links": {
"self": "/v1/email-notifications/1/relationships/event",
"related": "/v1/email-notifications/1/event"
}
}
},
"attributes": {
"next-event": false,
"new-paper": false,
"session-accept-reject": false,
"session-schedule": true,
"deleted-at": null,
"after-ticket-purchase": true,
"event-id": 1
},
"type": "email-notification",
"id": "1",
"links": {
"self": "/v1/email-notifications/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/2/email-notifications"
}
}Email Notification Detail ¶
Email Notification DetailGET/v1/email-notifications/{email_notification_id}
Get a single email notification.
Example URI
GET https://api.eventyay.com/v1/email-notifications/1
URI Parameters
- email_notification_id
integer(required) Example: 1ID of the email_notifcaiton in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"user": {
"links": {
"self": "/v1/email-notifications/1/relationships/user",
"related": "/v1/email-notifications/1/user"
}
},
"event": {
"links": {
"self": "/v1/email-notifications/1/relationships/event",
"related": "/v1/email-notifications/1/event"
}
}
},
"attributes": {
"next-event": false,
"new-paper": false,
"session-accept-reject": false,
"session-schedule": true,
"deleted-at": null,
"after-ticket-purchase": true,
"event-id": 1
},
"type": "email-notification",
"id": "1",
"links": {
"self": "/v1/email-notifications/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/email-notifications/1"
}
}Update Email NotificationPATCH/v1/email-notifications/{email_notification_id}
Update a single email notification with id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/email-notifications/1
URI Parameters
- email_notification_id
integer(required) Example: 1ID of the email_notifcaiton in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"next-event": false,
"new-paper": false,
"session-accept-reject": false,
"session-schedule": true,
"after-ticket-purchase": true,
"event-id": 1
},
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"type": "email-notification",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"user": {
"links": {
"self": "/v1/email-notifications/1/relationships/user",
"related": "/v1/email-notifications/1/user"
}
},
"event": {
"links": {
"self": "/v1/email-notifications/1/relationships/event",
"related": "/v1/email-notifications/1/event"
}
}
},
"attributes": {
"next-event": false,
"new-paper": false,
"session-accept-reject": false,
"session-schedule": true,
"deleted-at": null,
"after-ticket-purchase": true,
"event-id": 1
},
"type": "email-notification",
"id": "1",
"links": {
"self": "/v1/email-notifications/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/email-notifications/1"
}
}Delete Email NotificationDELETE/v1/email-notifications/{email_notification_id}
Delete a single email notification.
Example URI
DELETE https://api.eventyay.com/v1/email-notifications/1
URI Parameters
- email_notification_id
integer(required) Example: 1ID of the email_notifcaiton in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}User Emails ¶
To add Alternate User Emails.
| Parameter | Description | Type | Required |
|---|---|---|---|
email-address |
Email Address of User | string | yes |
type |
Type of usage of User Email like personal, work etc | string | yes |
User Email Admin Collection ¶
List All User EmailsGET/v1/admin/user-emails{?sort,filter}
Get a list of User Emails.
Example URI
GET https://api.eventyay.com/v1/admin/user-emails?sort=type&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: type- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"user": {
"links": {
"self": "/v1/user-emails/1/relationships/user",
"related": "/v1/alternate-emails/1/user"
}
}
},
"attributes": {
"user-id": 1,
"deleted-at": null,
"email-address": "example@example.com",
"type": "work"
},
"type": "user-email",
"id": "1",
"links": {
"self": "/v1/user-emails/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/admin/user-emails"
}
}User Email Collection ¶
List All User EmailsGET/v1/users/{user_id}/alternate-emails{?sort,filter}
Get a list of user emails.
Example URI
GET https://api.eventyay.com/v1/users/1/alternate-emails?sort=type&filter=[]
URI Parameters
- user_id
integer(required) Example: 1ID of the specific user in integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: type- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "user-email",
"id": "1",
"relationships": {
"user": {
"links": {
"self": "/v1/user-emails/1/relationships/user",
"related": "/v1/alternate-emails/1/user"
}
}
},
"attributes": {
"user-id": 1,
"deleted-at": null,
"email-address": "example@example.com",
"type": "work"
},
"links": {
"self": "/v1/user-emails/1"
}
}
],
"links": {
"self": "/v1/users/1/alternate-emails"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}User Email Detail ¶
User Email DetailGET/v1/user-emails/{user_email_id}
Get a single user email.
Example URI
GET https://api.eventyay.com/v1/user-emails/1
URI Parameters
- user_email_id
integer(required) Example: 1ID of the user_email in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "user-email",
"id": "1",
"relationships": {
"user": {
"links": {
"self": "/v1/user-emails/1/relationships/user",
"related": "/v1/alternate-emails/1/user"
}
}
},
"attributes": {
"user-id": 1,
"deleted-at": null,
"email-address": "example@example.com",
"type": "work"
},
"links": {
"self": "/v1/user-emails/1"
}
},
"links": {
"self": "/v1/user-emails/1"
},
"jsonapi": {
"version": "1.0"
}
}Update User EmailPATCH/v1/user-emails/{user_email_id}
Update a single user email with id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/user-emails/1
URI Parameters
- user_email_id
integer(required) Example: 1ID of the user_email in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"email-address": "hello@example.com",
"type": "office"
},
"relationships": {
"user": {
"data": {
"type": "user",
"id": "1"
}
}
},
"type": "user-email",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "user-email",
"id": "1",
"relationships": {
"user": {
"links": {
"self": "/v1/user-emails/1/relationships/user",
"related": "/v1/alternate-emails/1/user"
}
}
},
"attributes": {
"user-id": 1,
"deleted-at": null,
"email-address": "hello@example.com",
"type": "office"
},
"links": {
"self": "/v1/user-emails/1"
}
},
"links": {
"self": "/v1/user-emails/1"
},
"jsonapi": {
"version": "1.0"
}
}Delete User EmailDELETE/v1/user-emails/{user_email_id}
Delete a single user email.
Example URI
DELETE https://api.eventyay.com/v1/user-emails/1
URI Parameters
- user_email_id
integer(required) Example: 1ID of the user_email in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Discount Codes ¶
Discount Codes related to the events.
| Parameter | Description | Type | Required |
|---|---|---|---|
code |
Discount Code | string | yes |
discount-url |
URL of the discount | string | - |
value |
Value of the discount | float | yes |
type |
Amount or Percentage | string | yes |
is-active |
If the discount code is active | boolean | - |
tickets-number |
Tickets Number for Discount Code | integer (>=0) | - |
min-quantity |
Minimum number of tickets for Discount Code | integer (>=0) | - |
max-quantity |
Maximum number of tickets for Discount Code | integer | - |
valid-from |
Discount Code valid from | ISO 8601 (tz-aware) | - |
valid-till |
Discount Code valid till | ISO 8601 (tz-aware) | - |
created-at |
Discount Code created at | ISO 8601 (tz-aware) | - |
used-for |
Discount Code used for: tickets or events | String | yes |
Event Discount Code Collection ¶
List All Event Discount CodesGET/v1/discount-codes{?sort,filter}
Get a list of Discount Codes.
Example URI
GET https://api.eventyay.com/v1/discount-codes?sort=code&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: code- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 2
},
"data": [
{
"relationships": {
"events": {
"links": {
"self": "/v1/discount-codes/1/relationships/events",
"related": "/v1/discount-codes/1/events"
}
},
"event": {
"links": {
"self": "/v1/discount-codes/1/relationships/event",
"related": "/v1/discount-codes/1/event"
}
}
},
"attributes": {
"code": "DC101",
"valid-from": "2099-06-18T18:30:00+00:00",
"min-quantity": 0,
"created-at": "2099-08-05T23:38:04.449623+00:00",
"tickets-number": 404,
"value": 100,
"max-quantity": 100,
"is-active": false,
"used-for": "event",
"deleted-at": null,
"valid-till": "2099-06-24T18:30:00+00:00",
"type": "amount",
"discount-url": "https://my-discount-url.com"
},
"type": "discount-code",
"id": 1,
"links": {
"self": "/v1/discount-codes/1"
}
},
{
"relationships": {
"event": {
"links": {
"self": "/v1/discount-codes/2/relationships/event",
"related": "/v1/discount-codes/2/event"
}
},
"tickets": {
"links": {
"self": "/v1/discount-codes/1/relationships/tickets",
"related": "/v1/discount-codes/1/tickets"
}
}
},
"attributes": {
"code": "DC101",
"valid-from": "2099-06-18T18:30:00+00:00",
"min-quantity": 0,
"created-at": "2099-08-23T14:07:33.175725+00:00",
"tickets-number": 404,
"value": 100,
"max-quantity": 100,
"is-active": false,
"used-for": "ticket",
"deleted-at": null,
"valid-till": "2099-06-24T18:30:00+00:00",
"type": "amount",
"discount-url": "https://my-discount-url.com"
},
"type": "discount-code",
"id": 2,
"links": {
"self": "/v1/discount-codes/2"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/discount-codes"
}
}Create Event Discount CodePOST/v1/discount-codes{?sort,filter}
Create a new Discount Code for event. (Only Admin)
Example URI
POST https://api.eventyay.com/v1/discount-codes?sort=code&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: code- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"code": "DC101",
"discount-url": "https://my-discount-url.com",
"value": "100",
"type": "amount",
"is-active": "false",
"tickets-number": "404",
"min-quantity": "0",
"max-quantity": "100",
"valid-from": "2099-06-18T18:30:00+00:00",
"valid-till": "2099-06-24T18:30:00+00:00",
"used-for": "event"
},
"type": "discount-code",
"relationships": {
"events": {
"data": [
{
"id": "1",
"type": "event"
}
]
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/discount-codes/1/relationships/event",
"related": "/v1/discount-codes/1/event"
}
}
},
"attributes": {
"code": "DC101",
"valid-from": "2017-06-18T18:30:00+00:00",
"min-quantity": 0,
"created-at": "2017-06-27T14:47:14.996906+00:00",
"tickets-number": 404,
"value": 100,
"max-quantity": 100,
"is-active": false,
"used-for": "event",
"deleted-at": null,
"valid-till": "2017-06-24T18:30:00+00:00",
"type": "amount",
"discount-url": "https://my-discount-url.com"
},
"type": "discount-code",
"id": 4,
"links": {
"self": "/v1/discount-codes/4"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/discount-codes/4"
}
}Ticket Discount Code Collection ¶
Create Ticket Discount CodePOST/v1/discount-codes
Create a new Discount Code for event. (Only by Co-organizers)
Example URI
POST https://api.eventyay.com/v1/discount-codes
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"code": "DC101",
"discount-url": "https://my-discount-url.com",
"value": "100",
"type": "percent",
"is-active": "false",
"tickets-number": "404",
"min-quantity": "0",
"max-quantity": "100",
"valid-from": "2099-06-18T18:30:00+00:00",
"valid-till": "2099-06-24T18:30:00+00:00",
"used-for": "ticket"
},
"type": "discount-code",
"relationships": {
"event": {
"data": {
"id": "1",
"type": "event"
}
},
"tickets": {
"data": [
{
"id": "1",
"type": "ticket"
}
]
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "discount-code",
"id": 1,
"attributes": {
"discount-url": "https://my-discount-url.com",
"deleted-at": null,
"used-for": "ticket",
"min-quantity": 0,
"value": 100,
"max-quantity": 100,
"valid-till": "2017-06-24T18:30:00+00:00",
"is-active": false,
"type": "percent",
"code": "DC101",
"valid-from": "2017-06-18T18:30:00+00:00",
"tickets-number": 404,
"created-at": "2018-06-26T16:03:33.494021+00:00"
},
"relationships": {
"event": {
"links": {
"self": "/v1/discount-codes/1/relationships/event",
"related": "/v1/discount-codes/1/event"
}
},
"tickets": {
"links": {
"self": "/v1/discount-codes/1/relationships/tickets",
"related": "/v1/discount-codes/1/tickets"
}
},
"marketer": {
"links": {
"self": "/v1/discount-codes/1/relationships/marketer",
"related": "/v1/discount-codes/1/marketer"
}
}
},
"links": {
"self": "/v1/discount-codes/1"
}
},
"links": {
"self": "/v1/discount-codes/1"
},
"jsonapi": {
"version": "1.0"
}
}List All Ticket Discount CodesGET/v1/events/{event_identifier}/discount-codes{?sort,filter}
Get a list of Discount Codes.
Example URI
GET https://api.eventyay.com/v1/events/1/discount-codes?sort=code&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: code- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/discount-codes/1/relationships/event",
"related": "/v1/discount-codes/1/event"
}
},
"tickets": {
"links": {
"self": "/v1/discount-codes/1/relationships/tickets",
"related": "/v1/discount-codes/1/tickets"
}
}
},
"attributes": {
"code": "DC101",
"valid-from": "2099-06-18T18:30:00+00:00",
"min-quantity": 0,
"created-at": "2099-06-20T09:59:23.740772+00:00",
"tickets-number": 404,
"value": 100,
"max-quantity": 100,
"is-active": false,
"used-for": "ticket",
"deleted-at": null,
"valid-till": "2099-06-24T18:30:00+00:00",
"type": "amount",
"discount-url": "https://my-discount-url.com"
},
"type": "discount-code",
"id": 1,
"links": {
"self": "/v1/discount-codes/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/discount-codes"
}
}Discount Code Detail ¶
Discount Code DetailGET/v1/discount-codes/{discount_code_id}
Get a single discount code.
Example URI
GET https://api.eventyay.com/v1/discount-codes/1
URI Parameters
- discount_code_id
integer(required) Example: 1ID of the discount code in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/discount-codes/1/relationships/events",
"related": "/v1/discount-codes/1/events"
}
},
"tickets": {
"links": {
"self": "/v1/discount-codes/1/relationships/tickets",
"related": "/v1/discount-codes/1/tickets"
}
}
},
"attributes": {
"code": "DC101",
"valid-from": "2099-06-18T18:30:00+00:00",
"min-quantity": 0,
"created-at": "2099-06-27T10:43:20.840012+00:00",
"tickets-number": 404,
"value": 100,
"max-quantity": 100,
"is-active": false,
"used-for": "ticket",
"deleted-at": null,
"valid-till": "2099-06-24T18:30:00+00:00",
"type": "amount",
"discount-url": "https://my-discount-url.com"
},
"type": "discount-code",
"id": 1,
"links": {
"self": "/v1/discount-codes/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/discount-codes/1"
}
}Update Discount CodePATCH/v1/discount-codes/{discount_code_id}
Update a single discount code with id (Check permission to edit).
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/discount-codes/1
URI Parameters
- discount_code_id
integer(required) Example: 1ID of the discount code in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"code": "DC101",
"discount-url": "https://my-discount-url.com",
"value": "50",
"type": "percent",
"is-active": "false",
"tickets-number": "404",
"min-quantity": "0",
"max-quantity": "100",
"valid-from": "2099-06-18T18:30:00+00:00",
"valid-till": "2099-06-24T18:30:00+00:00",
"used-for": "ticket"
},
"type": "discount-code",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/discount-codes/1/relationships/events",
"related": "/v1/discount-codes/1/events"
}
},
"marketer": {
"links": {
"self": "/v1/discount-codes/1/relationships/marketer",
"related": "/v1/discount-codes/1/marketer"
}
},
"tickets": {
"links": {
"self": "/v1/discount-codes/1/relationships/tickets",
"related": "/v1/discount-codes/1/tickets"
}
}
},
"attributes": {
"code": "DC101",
"valid-from": "2017-06-18T18:30:00+00:00",
"min-quantity": 0,
"created-at": "2017-06-20T09:59:23.740772+00:00",
"tickets-number": 404,
"value": 50,
"max-quantity": 100,
"is-active": false,
"deleted-at": null,
"used-for": "ticket",
"valid-till": "2017-06-24T18:30:00+00:00",
"type": "percent",
"discount-url": "https://my-discount-url.com"
},
"type": "discount-code",
"id": 1,
"links": {
"self": "/v1/discount-codes/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/discount-codes/1"
}
}Delete Discount CodeDELETE/v1/discount-codes/{discount_code_id}
Delete a single discount code (Check permission to delete).
Example URI
DELETE https://api.eventyay.com/v1/discount-codes/1
URI Parameters
- discount_code_id
integer(required) Example: 1ID of the discount code in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Get Discount Code Detail using the code ¶
Get Discount Code DetailGET/v1/events/{event_id}/discount-codes/{code}
Get a single discount code using a code.
Example URI
GET https://api.eventyay.com/v1/events/1/discount-codes/DC101
URI Parameters
- code
string(required) Example: DC101code associated with a discount code. (DC101 is an example of code)
- event_id
integer(required) Example: 1ID of the Event in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/discount-codes/1/relationships/event",
"related": "/v1/discount-codes/1/event"
}
}
},
"attributes": {
"code": "DC101",
"valid-from": "2099-06-18T18:30:00+00:00",
"min-quantity": 0,
"created-at": "2099-08-05T23:38:04.449623+00:00",
"tickets-number": 404,
"value": 100,
"max-quantity": 100,
"is-active": false,
"used-for": "event",
"deleted-at": null,
"valid-till": "2099-06-24T18:30:00+00:00",
"type": "amount",
"discount-url": "https://my-discount-url.com"
},
"type": "discount-code",
"id": 1,
"links": {
"self": "/v1/discount-codes/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/discount-codes/1"
}
}List Discount Codes under a User ¶
List All Discount Codes under a UserGET/v1/users/{user_id}/discount-codes{?sort,filter}
Get a list of Discount Codes.
Example URI
GET https://api.eventyay.com/v1/users/1/discount-codes?sort=code&filter=[]
URI Parameters
- user_id
string(required) Example: 1user id in the form of an integer.
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: code- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/discount-codes/1/relationships/event",
"related": "/v1/discount-codes/1/event"
}
},
"tickets": {
"links": {
"self": "/v1/discount-codes/1/relationships/tickets",
"related": "/v1/discount-codes/1/tickets"
}
}
},
"attributes": {
"code": "DC101",
"valid-from": "2099-06-18T18:30:00+00:00",
"min-quantity": 0,
"created-at": "2099-08-05T23:38:04.449623+00:00",
"tickets-number": 404,
"value": 100,
"max-quantity": 100,
"is-active": false,
"used-for": "event",
"deleted-at": null,
"valid-till": "2099-06-24T18:30:00+00:00",
"type": "amount",
"discount-url": "https://my-discount-url.com"
},
"type": "discount-code",
"id": 1,
"links": {
"self": "/v1/discount-codes/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/1/discount-codes"
}
}List Discount Codes under a Ticket ¶
List All Discount Codes under a TicketGET/v1/tickets/{ticket_id}/discount-codes{?sort,filter}
Get a list of Discount Codes applied on a given ticket.
Example URI
GET https://api.eventyay.com/v1/tickets/1/discount-codes?sort=code&filter=[]
URI Parameters
- ticket_id
string(required) Example: 1user id in the form of an integer.
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: code- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "discount-code",
"relationships": {
"tickets": {
"links": {
"self": "/v1/discount-codes/1/relationships/tickets",
"related": "/v1/discount-codes/1/tickets"
}
},
"marketer": {
"links": {
"self": "/v1/discount-codes/1/relationships/marketer",
"related": "/v1/discount-codes/1/marketer"
}
},
"event": {
"links": {
"self": "/v1/discount-codes/1/relationships/event",
"related": "/v1/discount-codes/1/event"
}
}
},
"attributes": {
"value": 100,
"created-at": "2099-06-26T16:03:33.494021+00:00",
"tickets-number": 404,
"code": "DC101",
"used-for": "ticket",
"is-active": false,
"max-quantity": 100,
"discount-url": "https://my-discount-url.com",
"type": "amount",
"min-quantity": 0,
"valid-from": "2099-06-18T18:30:00+00:00",
"valid-till": "2099-06-24T18:30:00+00:00",
"deleted-at": null
},
"id": 1,
"links": {
"self": "/v1/discount-codes/1"
}
}
],
"links": {
"self": "/v1/tickets/1/discount-codes"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}Get Discount Code Detail of an Event ¶
Get Discount Code Detail of an EventGET/v1/events/{event_identifier}/discount-code
Get a single discount code.
Example URI
GET https://api.eventyay.com/v1/events/1/discount-code
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/discount-codes/1/relationships/event",
"related": "/v1/discount-codes/1/event"
}
},
"events": {
"links": {
"self": "/v1/discount-codes/1/relationships/events",
"related": "/v1/discount-codes/1/events"
}
}
},
"attributes": {
"code": "DC101",
"valid-from": "2099-06-18T18:30:00+00:00",
"min-quantity": 0,
"created-at": "2099-08-05T23:38:04.449623+00:00",
"tickets-number": 404,
"value": 100,
"max-quantity": 100,
"is-active": false,
"used-for": "event",
"deleted-at": null,
"valid-till": "2099-06-24T18:30:00+00:00",
"type": "amount",
"discount-url": "https://my-discount-url.com"
},
"type": "discount-code",
"id": 1,
"links": {
"self": "/v1/discount-codes/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/discount-codes/1"
}
}Access Codes ¶
Access Codes related to the events.
| Parameter | Description | Type | Required |
|---|---|---|---|
code |
Access Code | string | yes |
access-url |
URL of the access code | string | - |
is-active |
If the access code is active | boolean | - |
tickets-number |
Tickets Number for Access Code | integer (>=0) | - |
min-quantity |
Minimum number of tickets for Access Code | integer (>=0) | - |
max-quantity |
Maximum number of tickets for Access Code | integer (>=0) | - |
valid-from |
Access Code valid from | ISO 8601 (tz-aware) | - |
valid-till |
Access Code valid till | ISO 8601 (tz-aware) | - |
created-at |
Access Code created at | ISO 8601 (tz-aware) | - |
Access Code Collection ¶
Create Access CodePOST/v1/access-codes{?sort,filter}
Create a new Access Code with event_id and user_id.
Example URI
POST https://api.eventyay.com/v1/access-codes?sort=code&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: code- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "access-code",
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
},
"marketer": {
"data": {
"type": "user",
"id": "1"
}
}
},
"attributes": {
"code": "AC101",
"access-url": "https://my-access-code-url.com",
"is-active": "false",
"tickets-number": "404",
"min-quantity": "0",
"max-quantity": "100",
"valid-from": "2017-06-18T18:30:00+00:00",
"valid-till": "2017-06-24T18:30:00+00:00"
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/access-codes/1/relationships/tickets",
"related": "/v1/access-codes/1/tickets"
}
},
"marketer": {
"links": {
"self": "/v1/access-codes/1/relationships/marketer",
"related": "/v1/access-codes/1/marketer"
}
},
"event": {
"links": {
"self": "/v1/access-codes/1/relationships/event",
"related": "/v1/access-codes/1/event"
}
}
},
"attributes": {
"code": "AC101",
"valid-from": "2017-06-18T18:30:00+00:00",
"access-url": "https://my-access-code-url.com",
"min-quantity": 0,
"tickets-number": 404,
"max-quantity": 100,
"deleted-at": null,
"is-active": false,
"valid-till": "2017-06-24T18:30:00+00:00"
},
"type": "access-code",
"id": 1,
"links": {
"self": "/v1/access-codes/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/access-codes/1"
}
}Access Code Detail ¶
Access Code DetailGET/v1/access-codes/{access_code_id}
Get a single access code.
Example URI
GET https://api.eventyay.com/v1/access-codes/1
URI Parameters
- access_code_id
integer(required) Example: 1ID of the access code in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/access-codes/1/relationships/tickets",
"related": "/v1/access-codes/1/tickets"
}
},
"marketer": {
"links": {
"self": "/v1/access-codes/1/relationships/marketer",
"related": "/v1/access-codes/1/marketer"
}
},
"event": {
"links": {
"self": "/v1/access-codes/1/relationships/event",
"related": "/v1/access-codes/1/event"
}
}
},
"attributes": {
"code": "AC101",
"valid-from": "2017-06-18T18:30:00+00:00",
"access-url": "https://my-access-code-url.com",
"min-quantity": 0,
"tickets-number": 404,
"max-quantity": 100,
"is-active": false,
"deleted-at": null,
"valid-till": "2017-06-24T18:30:00+00:00"
},
"type": "access-code",
"id": 1,
"links": {
"self": "/v1/access-codes/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/access-codes/1"
}
}Update Access CodePATCH/v1/access-codes/{access_code_id}
Update a single access code with id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/access-codes/1
URI Parameters
- access_code_id
integer(required) Example: 1ID of the access code in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"code": "AC101",
"access-url": "https://my-access-code-url.com",
"is-active": "true",
"tickets-number": "404",
"min-quantity": "0",
"max-quantity": "100",
"valid-from": "2017-06-18T18:30:00+00:00",
"valid-till": "2017-06-24T18:30:00+00:00"
},
"type": "access-code",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/access-codes/1/relationships/tickets",
"related": "/v1/access-codes/1/tickets"
}
},
"marketer": {
"links": {
"self": "/v1/access-codes/1/relationships/marketer",
"related": "/v1/access-codes/1/marketer"
}
},
"event": {
"links": {
"self": "/v1/access-codes/1/relationships/event",
"related": "/v1/access-codes/1/event"
}
}
},
"attributes": {
"code": "AC101",
"valid-from": "2017-06-18T18:30:00+00:00",
"access-url": "https://my-access-code-url.com",
"min-quantity": 0,
"tickets-number": 404,
"max-quantity": 100,
"is-active": true,
"deleted-at": null,
"valid-till": "2017-06-24T18:30:00+00:00"
},
"type": "access-code",
"id": 1,
"links": {
"self": "/v1/access-codes/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/access-codes/1"
}
}Delete Access CodeDELETE/v1/access-codes/{access_code_id}
Delete a single Access code.
Example URI
DELETE https://api.eventyay.com/v1/access-codes/1
URI Parameters
- access_code_id
integer(required) Example: 1ID of the access code in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Access Code Detail using the Code ¶
Access Code DetailGET/v1/events/{event_id}/access-codes/{code}
Get a single access code using the code.
Example URI
GET https://api.eventyay.com/v1/events/1/access-codes/AC101
URI Parameters
- code
string(required) Example: AC101code of the access-code.
- event_id
integer(required) Example: 1ID of the Event in the form of an integer.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/access-codes/1/relationships/tickets",
"related": "/v1/access-codes/1/tickets"
}
},
"marketer": {
"links": {
"self": "/v1/access-codes/1/relationships/marketer",
"related": "/v1/access-codes/1/marketer"
}
},
"event": {
"links": {
"self": "/v1/access-codes/1/relationships/event",
"related": "/v1/access-codes/1/event"
}
}
},
"attributes": {
"code": "AC101",
"valid-from": "2017-06-18T18:30:00+00:00",
"access-url": "https://my-access-code-url.com",
"min-quantity": 0,
"tickets-number": 404,
"max-quantity": 100,
"is-active": false,
"deleted-at": null,
"valid-till": "2017-06-24T18:30:00+00:00"
},
"type": "access-code",
"id": 1,
"links": {
"self": "/v1/access-codes/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/access-codes/1"
}
}Get Access Codes for an Event ¶
List All Access Codes of an EventGET/v1/events/{event_identifier}/access-codes{?sort,filter}
Get a list of Access Codes.
Example URI
GET https://api.eventyay.com/v1/events/1/access-codes?sort=code&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: code- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/access-codes/1/relationships/tickets",
"related": "/v1/access-codes/1/tickets"
}
},
"marketer": {
"links": {
"self": "/v1/access-codes/1/relationships/marketer",
"related": "/v1/access-codes/1/marketer"
}
},
"event": {
"links": {
"self": "/v1/access-codes/1/relationships/event",
"related": "/v1/access-codes/1/event"
}
}
},
"attributes": {
"code": "AC101",
"valid-from": "2017-06-18T18:30:00+00:00",
"access-url": "https://my-access-code-url.com",
"min-quantity": 0,
"tickets-number": 404,
"max-quantity": 100,
"is-active": true,
"deleted-at": null,
"valid-till": "2017-06-24T18:30:00+00:00"
},
"type": "access-code",
"id": 1,
"links": {
"self": "/v1/access-codes/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/access-codes"
}
}Get Access Codes for a User ¶
List All Access Codes for a UserGET/v1/users/{user_id}/access-codes{?sort,filter}
Get a list of Access Codes.
Example URI
GET https://api.eventyay.com/v1/users/1/access-codes?sort=code&filter=[]
URI Parameters
- user_id
integer(required) Example: 1ID of the specific user in integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: code- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/access-codes/1/relationships/tickets",
"related": "/v1/access-codes/1/tickets"
}
},
"marketer": {
"links": {
"self": "/v1/access-codes/1/relationships/marketer",
"related": "/v1/access-codes/1/marketer"
}
},
"event": {
"links": {
"self": "/v1/access-codes/1/relationships/event",
"related": "/v1/access-codes/1/event"
}
}
},
"attributes": {
"code": "AC101",
"valid-from": "2017-06-18T18:30:00+00:00",
"access-url": "https://my-access-code-url.com",
"min-quantity": 0,
"tickets-number": 404,
"max-quantity": 100,
"is-active": true,
"deleted-at": null,
"valid-till": "2017-06-24T18:30:00+00:00"
},
"type": "access-code",
"id": 1,
"links": {
"self": "/v1/access-codes/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/users/2/access-codes"
}
}Get Access Codes for a Ticket ¶
List All Access Codes for a TicketGET/v1/tickets/{ticket_id}/access-codes{?sort,filter}
Get a list of Access Codes.
Example URI
GET https://api.eventyay.com/v1/tickets/1/access-codes?sort=code&filter=[]
URI Parameters
- ticket_id
integer(required) Example: 1ID of the ticket in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: code- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"tickets": {
"links": {
"self": "/v1/access-codes/1/relationships/tickets",
"related": "/v1/access-codes/1/tickets"
}
},
"marketer": {
"links": {
"self": "/v1/access-codes/1/relationships/marketer",
"related": "/v1/access-codes/1/marketer"
}
},
"event": {
"links": {
"self": "/v1/access-codes/1/relationships/event",
"related": "/v1/access-codes/1/event"
}
}
},
"attributes": {
"code": "AC101",
"valid-from": "2017-06-18T18:30:00+00:00",
"access-url": "https://my-access-code-url.com",
"min-quantity": 0,
"tickets-number": 404,
"max-quantity": 100,
"is-active": true,
"deleted-at": null,
"valid-till": "2017-06-24T18:30:00+00:00"
},
"type": "access-code",
"id": 1,
"links": {
"self": "/v1/access-codes/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tickets/1/access-codes"
}
}Role Invites ¶
Role invites for Events. Can only be edited and entered by event organizers.
| Parameter | Description | Type | Required |
|---|---|---|---|
email |
Email of the user to send role invite | string | yes |
hash |
hash of the role invite | string | - |
status |
Status the invite. | string (default: pending) |
- |
created-at |
Discount Code created at | ISO 8601 (tz-aware) | - |
role-name |
Name of the role. | string (example: attendee) |
yes` |
Role Invites Collection ¶
Create Role InvitePOST/v1/role-invites{?sort,filter}
Create a new role invite with event_id.
Example URI
POST https://api.eventyay.com/v1/role-invites?sort=status&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: status- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"email": "example@example.com",
"created-at": "2017-06-20T09:59:23.740772+00:00",
"status": "pending",
"role-name": "organizer"
},
"relationships": {
"role": {
"data": {
"type": "role",
"id": "1"
}
},
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"type": "role-invite"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"role": {
"links": {
"self": "/v1/role-invites/1/relationships/role",
"related": "/v1/role-invites/1/role"
}
},
"event": {
"links": {
"self": "/v1/role-invites/1/relationships/event",
"related": "/v1/role-invites/1/event"
}
}
},
"attributes": {
"email": "example@example.com",
"hash": "149889783495332276669212664484219865405",
"created-at": "2017-06-20T09:59:23.740772+00:00",
"status": "pending",
"role-name": "organizer"
},
"type": "role-invite",
"id": "1",
"links": {
"self": "/v1/role-invites/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/role-invites/1"
}
}Role Invites Collection List ¶
List All Role InvitesGET/v1/events/{event_identifier}/role-invites{?sort,filter}
Get a list of Role invites.
Example URI
GET https://api.eventyay.com/v1/events/1/role-invites?sort=status&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: status- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"role": {
"links": {
"self": "/v1/role-invites/1/relationships/role",
"related": "/v1/role-invites/1/role"
}
},
"event": {
"links": {
"self": "/v1/role-invites/1/relationships/event",
"related": "/v1/role-invites/1/event"
}
}
},
"attributes": {
"email": "example@example.com",
"hash": "149889783495332276669212664484219865405",
"created-at": "2017-06-20T09:59:23.740772+00:00",
"status": "pending",
"role-name": "organizer"
},
"type": "role-invite",
"id": "1",
"links": {
"self": "/v1/role-invites/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/role-invites"
}
}Role Invite Details ¶
Role Invite DetailsGET/v1/role-invites/{role_invite_id}
Get a single role invite.
Example URI
GET https://api.eventyay.com/v1/role-invites/1
URI Parameters
- role_invite_id
integer(required) Example: 1ID of the role invite in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"role": {
"links": {
"self": "/v1/role-invites/1/relationships/role",
"related": "/v1/role-invites/1/role"
}
},
"event": {
"links": {
"self": "/v1/role-invites/1/relationships/event",
"related": "/v1/role-invites/1/event"
}
}
},
"attributes": {
"email": "example@example.com",
"hash": "149889783495332276669212664484219865405",
"created-at": "2017-06-20T09:59:23.740772+00:00",
"status": "pending",
"role-name": "attendee"
},
"type": "role-invite",
"id": "1",
"links": {
"self": "/v1/role-invites/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/role-invites/1"
}
}Delete Role InviteDELETE/v1/role-invites/{role_invite_id}
Delete a single role invite.
Example URI
DELETE https://api.eventyay.com/v1/role-invites/1
URI Parameters
- role_invite_id
integer(required) Example: 1ID of the role invite in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}User Email Details By Role Invite ¶
Get User Email Detail By Role Invite TokenPOST/v1/role_invites/user
Get a single user email by sending role invite hash.
Example URI
POST https://api.eventyay.com/v1/role_invites/user
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"token": "ABCDefghIJKLmnop"
}
}Response
200Headers
Content-Type: application/jsonBody
{
"email": "user0@example.com"
}Accept Role Invite ¶
Accept Role Invite using TokenPOST/v1/role_invites/accept-invite
Accept Role Invitation by role invite hash
Example URI
POST https://api.eventyay.com/v1/role_invites/accept-invite
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"token": "ABCDefghIJKLmnop"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"email": "user0@example.com",
"event": 1,
"name": "example",
"event_identifier": "b8324ae2",
"role": "organizer"
}Users Events Roles ¶
Users Events Roles for Events. Can only be edited, deleted and queried by event co-organizers.
Users Events Roles Collection List ¶
List All Users Events RolesGET/v1/events/{event_identifier}/users-events-roles{?filter}
Get a list of Users Events Roles.
Example URI
GET https://api.eventyay.com/v1/events/1/users-events-roles?filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "users-events-roles",
"relationships": {
"user": {
"links": {
"self": "/v1/users-events-roles/1/relationships/user",
"related": "/v1/users-events-roles/1/user"
}
},
"role": {
"links": {
"self": "/v1/users-events-roles/1/relationships/role",
"related": "/v1/users-events-roles/1/role"
}
},
"event": {
"links": {
"self": "/v1/users-events-roles/1/relationships/event",
"related": "/v1/users-events-roles/1/event"
}
}
},
"id": "1",
"links": {
"self": "/v1/users-events-roles/1"
}
}
],
"links": {
"self": "/v1/events/1/users-events-roles"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}Users Events Roles Details ¶
Users Events Roles DetailsGET/v1/users-events-roles/{users_events_roles_id}
Get a single users events roles.
Example URI
GET https://api.eventyay.com/v1/users-events-roles/1
URI Parameters
- users_events_roles_id
integer(required) Example: 1ID of the users events roles in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "users-events-roles",
"id": "1",
"relationships": {
"event": {
"links": {
"self": "/v1/users-events-roles/1/relationships/event",
"related": "/v1/users-events-roles/1/event"
}
},
"role": {
"links": {
"self": "/v1/users-events-roles/1/relationships/role",
"related": "/v1/users-events-roles/1/role"
}
},
"user": {
"links": {
"self": "/v1/users-events-roles/1/relationships/user",
"related": "/v1/users-events-roles/1/user"
}
}
}
},
"jsonapi": {
"version": "1.0"
}
}Delete Users Events RolesDELETE/v1/users-events-roles/{users_events_roles_id}
Delete a single users events roles.
Example URI
DELETE https://api.eventyay.com/v1/users-events-roles/1
URI Parameters
- users_events_roles_id
integer(required) Example: 1ID of the users events roles in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Image Size ¶
ADMIN
To create or modify data of this data layer, you will need admin access. You can get the data without admin access as well. Image sizes basically stores the configuration for the width, height and aspect ratio for full size, thumbnail and icon version of various images that is uploaded to the server.
| Parameter | Description | Type | Required |
|---|---|---|---|
full-width |
Full width of the image | integer | - |
full-height |
Full height of the image | integer | - |
full-quality |
Full quality of the image | integer | - |
full-aspect |
To maintain aspect ratio of the image or not | boolean (default: false) |
- |
icon-width |
Width of the icon | integer | - |
icon-height |
Height of the icon | integer | - |
icon-quality |
Quality of the icon | integer | - |
icon-aspect |
To maintain aspect ratio of the icon or not | boolean (default: false) |
- |
thumbnail-width |
Width of the thumbnail | integer | - |
thumbnail-height |
Height of the thumbnail | integer | - |
thumbnail-quality |
Quality of the thumbnail | integer | - |
thumbnail-aspect |
To maintain aspect ratio of the thumbnail or not | boolean (default: false) |
- |
logo-width |
Width of te logo | integer | - |
logo-height |
Height of the logo | integer | - |
type |
Type of the image | string | - |
Event Image Size Details ¶
Get Event Image Size DetailsGET/v1/event-image-sizes
Get a single Event image size.
Example URI
GET https://api.eventyay.com/v1/event-image-sizes
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"full-width": 1300,
"full-height": 500,
"full-aspect": null,
"full-quality": 80,
"icon-width": 75,
"icon-height": 30,
"icon-aspect": null,
"icon-quality": 80,
"thumbnail-width": 500,
"thumbnail-height": 200,
"thumbnail-aspect": null,
"thumbnail-quality": 80,
"logo-width": null,
"logo-height": null,
"type": "event-image"
},
"type": "event-image-size",
"id": "1",
"links": {
"self": "/v1/event-image-sizes/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-image-sizes/1"
}
}Update Event Image SizePATCH/v1/event-image-sizes
Update a single Event image size
Example URI
PATCH https://api.eventyay.com/v1/event-image-sizes
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"full-width": 1300,
"full-height": 500,
"full-aspect": false,
"full-quality": 80,
"icon-width": 75,
"icon-height": 30,
"icon-aspect": true,
"icon-quality": 80,
"thumbnail-width": 500,
"thumbnail-height": 200,
"thumbnail-aspect": true,
"thumbnail-quality": 80,
"logo-width": 32,
"logo-height": 32,
"type": "event-image"
},
"id": "1",
"type": "event-image-size"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"full-aspect": false,
"thumbnail-height": 200,
"thumbnail-aspect": true,
"icon-height": 30,
"icon-aspect": true,
"type": "event-image",
"icon-width": 75,
"icon-quality": 80,
"logo-width": 32,
"full-width": 1300,
"thumbnail-width": 500,
"thumbnail-quality": 80,
"full-height": 500,
"logo-height": 32,
"full-quality": 80
},
"type": "event-image-size",
"id": "1",
"links": {
"self": "/v1/event-image-sizes/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-image-sizes/1"
}
}Speaker Image Size Details ¶
Get Speaker Image Size DetailsGET/v1/speaker-image-sizes
Get a single Speaker image size.
Example URI
GET https://api.eventyay.com/v1/speaker-image-sizes
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"icon-size-quality": 80,
"small-size-width-height": 50,
"thumbnail-size-quality": null,
"icon-size-width-height": 35,
"type": "speaker-image",
"thumbnail-size-width-height": 500,
"small-size-quality": 80
},
"type": "speaker-image-size",
"id": "2",
"links": {
"self": "/v1/speaker-image-sizes/2"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/speaker-image-sizes/2"
}
}Update Speaker Image SizePATCH/v1/speaker-image-sizes
Update a single Speaker image size
Example URI
PATCH https://api.eventyay.com/v1/speaker-image-sizes
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"icon-size-quality": 80,
"small-size-width-height": 50,
"thumbnail-size-quality": null,
"icon-size-width-height": 35,
"type": "speaker-image",
"thumbnail-size-width-height": 500,
"small-size-quality": 80
},
"id": "2",
"type": "speaker-image-size"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"icon-size-quality": 80,
"small-size-width-height": 50,
"thumbnail-size-quality": null,
"icon-size-width-height": 35,
"type": "speaker-image",
"thumbnail-size-width-height": 500,
"small-size-quality": 80
},
"type": "speaker-image-size",
"id": "2",
"links": {
"self": "/v1/speaker-image-sizes/2"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/speaker-image-sizes/2"
}
}Roles ¶
ADMIN
To create or modify data of this data layer, you will need admin access. You can get the data without admin access as well.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the role | integer | yes |
title-name |
Title of the role | integer | - |
Roles Collection ¶
List RolesGET/v1/roles{?sort,filter}
Get a list of Roles.
Example URI
GET https://api.eventyay.com/v1/roles?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"attributes": {
"name": "example-coorganizer",
"title-name": "Co-organizer"
},
"type": "role",
"id": "1",
"links": {
"self": "/v1/roles/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/roles"
}
}Create RolePOST/v1/roles{?sort,filter}
Create a new general role by admins.
Example URI
POST https://api.eventyay.com/v1/roles?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "example-coorganizer",
"title-name": "Co-organizer"
},
"type": "role"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"name": "example-coorganizer",
"title-name": "Co-organizer"
},
"type": "role",
"id": "1",
"links": {
"self": "/v1/roles/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/roles/1"
}
}Role Details ¶
Get Role DetailsGET/v1/roles/{role_id}
Get a single role.
Example URI
GET https://api.eventyay.com/v1/roles/1
URI Parameters
- role_id
integer(required) Example: 1ID of the role in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"name": "example-coorganizer",
"title-name": "Co-organizer"
},
"type": "role",
"id": "1",
"links": {
"self": "/v1/roles/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/roles/1"
}
}Update RolePATCH/v1/roles/{role_id}
Update a single role by id (only admin).
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/roles/1
URI Parameters
- role_id
integer(required) Example: 1ID of the role in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "example-coorganizer",
"title-name": "Co-organizer"
},
"id": "1",
"type": "role"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"name": "example-coorganizer",
"title-name": "Co-organizer"
},
"type": "role",
"id": "1",
"links": {
"self": "/v1/roles/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/roles/1"
}
}Delete RoleDELETE/v1/roles/{role_id}
Delete a single Role.
Example URI
DELETE https://api.eventyay.com/v1/roles/1
URI Parameters
- role_id
integer(required) Example: 1ID of the role in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Get Role for a Role Invite ¶
Get Role Details for a Role InviteGET/v1/role-invites/{role_invite_id}/role
Get a single role.
Example URI
GET https://api.eventyay.com/v1/role-invites/1/role
URI Parameters
- role_invite_id
integer(required) Example: 1ID of the role invite in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"title-name": "Organizer",
"name": "organizer"
},
"type": "role",
"id": "1",
"links": {
"self": "/v1/roles/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/roles/1"
}
}Services ¶
ADMIN
To get or modify data of this data layer, you will need admin access. You can get the data without admin access as well.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the service | string | yes |
Services Collection ¶
List ServicesGET/v1/services{?sort,filter}
Get a list of Services.
Example URI
GET https://api.eventyay.com/v1/services?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"attributes": {
"name": "track"
},
"type": "service",
"id": "1",
"links": {
"self": "/v1/services/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/services"
}
}Services Details ¶
Get Service DetailsGET/v1/services/{service_id}
Get a single role.
Example URI
GET https://api.eventyay.com/v1/services/1
URI Parameters
- service_id
integer(required) Example: 1ID of the service in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"name": "track"
},
"type": "service",
"id": "1",
"links": {
"self": "/v1/services/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/services/1"
}
}Update ServicePATCH/v1/services/{service_id}
Update a single service by id (only admin).
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/services/1
URI Parameters
- service_id
integer(required) Example: 1ID of the service in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "track"
},
"id": "1",
"type": "service"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"name": "track"
},
"type": "service",
"id": "1",
"links": {
"self": "/v1/services/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/services/1"
}
}Event Role Permission ¶
ADMIN
To get or modify data of this data layer, you will need admin access. You can get the data without admin access as well.
| Parameter | Description | Type | Required |
|---|---|---|---|
can-create |
Permission of role to create a service | boolean | yes |
can-read |
Permission of role to read a service | boolean | yes |
can-update |
Permission of role to update a service | boolean | yes |
can-delete |
Permission of role to delete a service | boolean | yes |
Event Role Permission Collection ¶
List Event Role PermissionsGET/v1/event-role-permissions{?filter}
Get a list of Event Role Permissions.
Example URI
GET https://api.eventyay.com/v1/event-role-permissions?filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"attributes": {
"can-delete": true,
"can-read": true,
"can-create": true,
"can-update": true
},
"relationships": {
"role": {
"links": {
"related": "/v1/roles/1",
"self": "/v1/event-role-permissions/1/relationships/role"
}
},
"service": {
"links": {
"related": "/v1/services/1",
"self": "/v1/event-role-permissions/1/relationships/service"
}
}
},
"type": "event-role-permissions",
"id": "1",
"links": {
"self": "/v1/event-role-permissions/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-role-permissions"
}
}Event Role Permission Details ¶
Get Event Role Permission DetailsGET/v1/event-role-permissions/{event_role_permissions_id}
Get a single event role permission.
Example URI
GET https://api.eventyay.com/v1/event-role-permissions/1
URI Parameters
- event_role_permissions_id
integer(required) Example: 1ID of the events role permission in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"can-delete": true,
"can-create": true,
"can-update": true,
"can-read": true
},
"relationships": {
"role": {
"links": {
"related": "/v1/roles/1",
"self": "/v1/event-role-permissions/1/relationships/role"
}
},
"service": {
"links": {
"related": "/v1/services/1",
"self": "/v1/event-role-permissions/1/relationships/service"
}
}
},
"type": "event-role-permissions",
"id": "1",
"links": {
"self": "/v1/event-role-permissions/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-role-permissions/1"
}
}Update Event Role PermissionPATCH/v1/event-role-permissions/{event_role_permissions_id}
Update a single event role permission by id (only admin).
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/event-role-permissions/1
URI Parameters
- event_role_permissions_id
integer(required) Example: 1ID of the events role permission in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"can-delete": false,
"can-create": true,
"can-update": false,
"can-read": false
},
"id": "1",
"type": "event-role-permissions"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"can-delete": false,
"can-create": true,
"can-update": false,
"can-read": false
},
"relationships": {
"role": {
"links": {
"related": "/v1/roles/1",
"self": "/v1/event-role-permissions/1/relationships/role"
}
},
"service": {
"links": {
"related": "/v1/services/1",
"self": "/v1/event-role-permissions/1/relationships/service"
}
}
},
"type": "event-role-permissions",
"id": "1",
"links": {
"self": "/v1/event-role-permissions/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/event-role-permissions/1"
}
}Message Settings ¶
ADMIN
To get or modify data of this data layer, you will need admin access. You can get the data without admin access as well.
| Parameter | Description | Type | Required |
|---|---|---|---|
action |
Action of the message | string | - |
enabled |
Whether this Mail is enabled | boolean | - |
email-message |
Message of the Email | string | - |
notification-message |
Message of the Notification | string | - |
Message Setting Collection ¶
List Message SettingsGET/v1/message-settings{?filter}
Get a list of Message Settings.
Example URI
GET https://api.eventyay.com/v1/message-settings?filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"attributes": {
"enabled": true,
"action": "event_role",
"recipient": "User",
"email-subject": "Invitation to be {role} at {event}",
"email-message": "Hello {email},<br><br>You have been invited to be a <strong>{role}</strong> at <strong>{event}</strong>.<br>To accept the role please sign up using the following link:{ Link }"
},
"type": "message-settings",
"id": "1",
"links": {
"self": "/v1/message-settings/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/message-settings"
}
}Message Setting Details ¶
Get Message Setting DetailsGET/v1/message-settings/{message_settings_id}
Get a single message setting.
Example URI
GET https://api.eventyay.com/v1/message-settings/1
URI Parameters
- message_settings_id
integer(required) Example: 1ID of the message setting in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"enabled": true,
"action": "event_role",
"recipient": "User",
"email-subject": "Invitation to be {role} at {event}",
"email-message": "Hello {email},<br><br>You have been invited to be a <strong>{role}</strong> at <strong>{event}</strong>.<br>To accept the role please sign up using the following link:{ Link }"
},
"type": "message-setting",
"id": "1",
"links": {
"self": "/v1/message-settings/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/message-settings/1"
}
}Update Message SettingPATCH/v1/message-settings/{message_settings_id}
Update a single message setting by id (only admin).
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/message-settings/1
URI Parameters
- message_settings_id
integer(required) Example: 1ID of the message setting in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"enabled": true,
"action": "event_role"
},
"id": "1",
"type": "message-setting"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"enabled": true,
"action": "event_role",
"recipient": "User",
"email-subject": "Invitation to be {role} at {event}",
"email-message": "Hello {email},<br><br>You have been invited to be a <strong>{role}</strong> at <strong>{event}</strong>.<br>To accept the role please sign up using the following link:{ Link }"
},
"type": "message-setting",
"id": "1",
"links": {
"self": "/v1/message-settings/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/message-settings/1"
}
}Activity ¶
ADMIN*
To create or modify any data of this data layer, you will need admin access. However you get the schema without admin access.
| Parameter | Description | Type | Required |
|---|---|---|---|
actor |
One who performs the activity | string | - |
time |
Time of the activity | ISO 8601 (tz-aware) | - |
action |
Action performed in the activity | string | - |
Activity Collection ¶
List all ActivitiesGET/v1/activities{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/activities?sort=actor&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: actor- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"attributes": {
"action": "action",
"actor": "actor",
"time": "2017-07-19T18:44:14.208218+00:00"
},
"type": "activity",
"id": "1",
"links": {
"self": "/v1/activities/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/activities"
}
}Activity Details ¶
Get Activity DetailsGET/v1/activities/{activity_id}
Get a single activity.
Example URI
GET https://api.eventyay.com/v1/activities/1
URI Parameters
- activity_id
integer(required) Example: 1ID of the activity in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"action": "action",
"actor": "actor",
"time": "2017-07-19T18:44:14.208218+00:00"
},
"type": "activity",
"id": "1",
"links": {
"self": "/v1/activities/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/activities/1"
}
}Pages ¶
ADMIN
To create or modify any data of this data layer, you will need admin access. However you get the schema without admin access. Pages endpoints is used to create static pages such as about page or any other page that doesn’t need to be updated frequently and only a specific content is to be shown.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the page | string | yes |
title |
Title of the page | string | - |
url |
Url of the page | string | yes |
description |
Description of the page | string | yes |
language |
Language of the page | string | - |
index |
Position of the page | integer (default: 0 ) |
- |
place |
Place where the page will be located, currently footer and event are accepted |
string | - |
Page Collection ¶
Page SizesGET/v1/pages{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/pages?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"attributes": {
"name": "How it works",
"title": "How it works",
"url": "/how-it-works",
"description": "How it works",
"place": "footer",
"language": "English",
"index": 0
},
"type": "image-size",
"id": "1",
"links": {
"self": "/v1/image-sizes/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/pages"
}
}Create PagePOST/v1/pages{?sort,filter}
Create a new general page by admins.
Example URI
POST https://api.eventyay.com/v1/pages?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "How it works",
"title": "How it works",
"url": "/how-it-works",
"description": "How it works",
"place": "footer",
"language": "English",
"index": 0
},
"type": "page"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": "data"
}Page Details ¶
Get Page DetailsGET/v1/pages/{page_id}
Get a single page.
Example URI
GET https://api.eventyay.com/v1/pages/1
URI Parameters
- page_id
integer(required) Example: 1ID of the page in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"name": "How it works",
"title": "How it works",
"url": "/how-it-works",
"description": "How it works",
"place": "footer",
"language": "English",
"index": 0
},
"type": "page",
"id": "1",
"links": {
"self": "/v1/pages/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/pages/1"
}
}Update PagePATCH/v1/pages/{page_id}
Update a single page by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/pages/1
URI Parameters
- page_id
integer(required) Example: 1ID of the page in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "How it works",
"title": "How it works",
"url": "/how-it-works",
"description": "How it works",
"place": "footer",
"language": "English",
"index": 0
},
"type": "page",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"name": "How it works",
"title": "How it works",
"url": "/how-it-works",
"description": "How it works",
"place": "footer",
"language": "English",
"index": 0
},
"type": "page",
"id": "1",
"links": {
"self": "/v1/pages/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/pages/1"
}
}Delete PageDELETE/v1/pages/{page_id}
Delete a single page.
Example URI
DELETE https://api.eventyay.com/v1/pages/1
URI Parameters
- page_id
integer(required) Example: 1ID of the page in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Mails ¶
ADMIN
| Parameter | Description | Type |
|---|---|---|
recipient |
Recipient of the mail | string |
time |
Time of the mail | string |
action |
e.g Event Imported | string |
subject |
Subject of the mail | string |
message |
Email body | string |
Mail Collection ¶
Show all mailsGET/v1/mails{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/mails?sort=time&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: time- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"attributes": {
"action": "example",
"message": "example",
"subject": "example",
"recipient": "example@example.com",
"time": "2016-12-08T11:49:12.147941+00:00"
},
"type": "mail",
"id": "1",
"links": {
"self": "/v1/mails/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/mails"
}
}Mail Details ¶
Get Mail DetailsGET/v1/mails/{mail_id}
Example URI
GET https://api.eventyay.com/v1/mails/1
URI Parameters
- mail_id
integer(required) Example: 1ID of the mail in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"action": "example",
"message": "example",
"subject": "example",
"recipient": "example@example.com",
"time": "2016-12-08T11:49:12.147941+00:00"
},
"type": "mail",
"id": "1",
"links": {
"self": "/v1/mails/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/mails/1"
}
}Custom Forms ¶
Custom Forms related to the events.
| Parameter | Description | Type | Required |
|---|---|---|---|
form |
Custom Form | string | yes |
field-identifier |
Identifier for the custom form field | string | yes |
type |
Custom Form type, allowed: “text”, “checkbox”, “select”, “file”, “image”, “email”, “paragraph” | string | yes |
is-required |
If the custom form is required | boolean | - |
is-included |
If the custom form is included | boolean | - |
is-fixed |
If the custom form is fixed | boolean | - |
tickets-number |
Tickets Number for custom form | integer (>=0) | - |
Custom Form Collection ¶
Create Custom FormPOST/v1/custom-forms{?sort,filter}
Create a new Custom Form with event_id.
Example URI
POST https://api.eventyay.com/v1/custom-forms?sort=type&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: type- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "custom-form",
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"form": "speaker",
"type": "text",
"field-identifier": "name",
"is-required": "true",
"is-included": "false",
"is-fixed": "false"
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/custom-forms/1/relationships/event",
"related": "/v1/custom-forms/1/event"
}
}
},
"attributes": {
"is-required": true,
"form": "speaker",
"field-identifier": "name",
"is-included": false,
"is-fixed": false,
"type": "text"
},
"type": "custom-form",
"id": 1,
"links": {
"self": "/v1/custom-forms/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/custom-forms/1"
}
}Custom Form Detail ¶
Custom Form DetailGET/v1/custom-forms/{custom_form_id}
Get a single custom form.
Example URI
GET https://api.eventyay.com/v1/custom-forms/1
URI Parameters
- custom_form_id
integer(required) Example: 1ID of the custom form in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/custom-forms/1/relationships/event",
"related": "/v1/custom-forms/1/event"
}
}
},
"attributes": {
"is-required": true,
"form": "speaker",
"field-identifier": "name",
"is-fixed": false,
"is-included": false,
"type": "text"
},
"type": "custom-form",
"id": 1,
"links": {
"self": "/v1/custom-forms/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/custom-forms/1"
}
}Update Custom FormPATCH/v1/custom-forms/{custom_form_id}
Update a single custom form with id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/custom-forms/1
URI Parameters
- custom_form_id
integer(required) Example: 1ID of the custom form in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "custom-form",
"attributes": {
"form": "speaker",
"field-identifier": "name",
"type": "text",
"is-required": "false",
"is-included": "false",
"is-fixed": "false"
},
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/custom-forms/1/relationships/event",
"related": "/v1/custom-forms/1/event"
}
}
},
"attributes": {
"is-required": false,
"form": "speaker",
"field-identifier": "name",
"is-fixed": false,
"is-included": false,
"type": "text"
},
"type": "custom-form",
"id": 1,
"links": {
"self": "/v1/custom-forms/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/custom-forms/1"
}
}Delete Custom FormDELETE/v1/custom-forms/{custom_form_id}
Delete a single Access code.
Example URI
DELETE https://api.eventyay.com/v1/custom-forms/1
URI Parameters
- custom_form_id
integer(required) Example: 1ID of the custom form in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Event Custom Form Collection ¶
List All Custom Forms for an EventGET/v1/events/{event_identifier}/custom-forms{?sort,filter}
Get a list of Custom Forms for an event.
Example URI
GET https://api.eventyay.com/v1/events/1/custom-forms?sort=type&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: type- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/custom-forms/1/relationships/event",
"related": "/v1/custom-forms/1/event"
}
}
},
"attributes": {
"is-required": true,
"form": "speaker",
"field-identifier": "name",
"is-included": false,
"is-fixed": false,
"type": "text"
},
"type": "custom-form",
"id": 1,
"links": {
"self": "/v1/custom-forms/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/custom-forms"
}
}FAQ ¶
FAQs related to the events.
| Parameter | Description | Type | Required |
|---|---|---|---|
question |
Frequently Asked Questions related to the Event | string | yes |
answer |
Answer to the Frequently Asked Questions | string | yes |
FAQ Collection ¶
Create FAQPOST/v1/faqs{?sort,filter}
Create a new Question-Answer pair (FAQ) with event_id.
Example URI
POST https://api.eventyay.com/v1/faqs?sort=question&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: question- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "faq",
"relationships": {
"event": {
"data": {
"type": "event",
"id": "1"
}
}
},
"attributes": {
"question": "Sample Question",
"answer": "Sample Answer"
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"faq-type": {
"links": {
"self": "/v1/faqs/1/relationships/faq-type",
"related": "/v1/faqs/1/faq-type"
}
},
"event": {
"links": {
"self": "/v1/faqs/1/relationships/event",
"related": "/v1/faqs/1/event"
}
}
},
"attributes": {
"question": "Sample Question",
"deleted-at": null,
"answer": "Sample Answer"
},
"type": "faq",
"id": 1,
"links": {
"self": "/v1/faqs/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/faqs/1"
}
}FAQ Detail ¶
FAQ DetailGET/v1/faqs/{faq_id}
Get a single FAQ.
Example URI
GET https://api.eventyay.com/v1/faqs/1
URI Parameters
- faq_id
integer(required) Example: 1ID of the FAQ in the form of an integer
Request
Headers
Accept: application/vnd.api+jsonResponse
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/faqs/1/relationships/event",
"related": "/v1/faqs/1/event"
}
},
"faq-type": {
"links": {
"self": "/v1/faqs/1/relationships/faq-type",
"related": "/v1/faqs/1/faq-type"
}
}
},
"attributes": {
"question": "Sample Question",
"answer": "Sample Answer",
"deleted-at": null
},
"type": "faq",
"id": 1,
"links": {
"self": "/v1/faqs/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/faqs/1"
}
}Update FAQPATCH/v1/faqs/{faq_id}
Update a single FAQ with id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/faqs/1
URI Parameters
- faq_id
integer(required) Example: 1ID of the FAQ in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "faq",
"attributes": {
"question": "Sample Question",
"answer": "Sample Answer Changed"
},
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"faq-type": {
"links": {
"self": "/v1/faqs/1/relationships/faq-type",
"related": "/v1/faqs/1/faq-type"
}
},
"event": {
"links": {
"self": "/v1/faqs/1/relationships/event",
"related": "/v1/faqs/1/event"
}
}
},
"attributes": {
"question": "Sample Question",
"deleted-at": null,
"answer": "Sample Answer Changed"
},
"type": "faq",
"id": 1,
"links": {
"self": "/v1/faqs/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/faqs/1"
}
}Delete FAQDELETE/v1/faqs/{faq_id}
Delete a single FAQ.
Example URI
DELETE https://api.eventyay.com/v1/faqs/1
URI Parameters
- faq_id
integer(required) Example: 1ID of the FAQ in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Event FAQ Collection ¶
List All FAQs for an EventGET/v1/events/{event_identifier}/faqs{?sort,filter}
Get a list of FAQs for an event.
Example URI
GET https://api.eventyay.com/v1/events/1/faqs?sort=question&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: question- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"faq-type": {
"links": {
"self": "/v1/faqs/1/relationships/faq-type",
"related": "/v1/faqs/1/faq-type"
}
},
"event": {
"links": {
"self": "/v1/faqs/1/relationships/event",
"related": "/v1/faqs/1/event"
}
}
},
"attributes": {
"question": "Sample Question",
"deleted-at": null,
"answer": "Sample Answer"
},
"type": "faq",
"id": 1,
"links": {
"self": "/v1/faqs/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/faqs"
}
}FAQ Types ¶
FAQ Types related to the events.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name to be given to the FAQ type | string | yes |
FAQ Type Collection ¶
Create FAQ TypePOST/v1/faq-types{?sort,filter}
Example URI
POST https://api.eventyay.com/v1/faq-types?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "abc"
},
"type": "faq-type",
"relationships": {
"event": {
"data": {
"id": "1",
"type": "event"
}
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/faq-types/1/relationships/event",
"related": "/v1/faq-types/1/event"
}
},
"faqs": {
"links": {
"self": "/v1/faq-types/1/relationships/faqs",
"related": "/v1/faq-types/1/faqs"
}
}
},
"attributes": {
"name": "abc"
},
"type": "faq-type",
"id": "1",
"links": {
"self": "/v1/faq-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/faq-types/1"
}
}FAQ Type Detail ¶
FAQ Type DetailGET/v1/faq-types/{faq_type_id}
Get a single FAQ Type
Example URI
GET https://api.eventyay.com/v1/faq-types/1
URI Parameters
- faq_type_id
integer(required) Example: 1ID of the FAQ in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/faq-types/1/relationships/event",
"related": "/v1/faq-types/1/event"
}
},
"faqs": {
"links": {
"self": "/v1/faq-types/1/relationships/faqs",
"related": "/v1/faq-types/1/faqs"
}
}
},
"attributes": {
"name": "abc"
},
"type": "faq-type",
"id": "1",
"links": {
"self": "/v1/faq-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/faq-types/1"
}
}Update FAQ TypePATCH/v1/faq-types/{faq_type_id}
Update a single FAQ Type with id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/faq-types/1
URI Parameters
- faq_type_id
integer(required) Example: 1ID of the FAQ in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "xyz"
},
"type": "faq-type",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/faq-types/1/relationships/event",
"related": "/v1/faq-types/1/event"
}
},
"faqs": {
"links": {
"self": "/v1/faq-types/1/relationships/faqs",
"related": "/v1/faq-types/1/faqs"
}
}
},
"attributes": {
"name": "xyz"
},
"type": "faq-type",
"id": "1",
"links": {
"self": "/v1/faq-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/faq-types/1"
}
}Delete FAQ TypeDELETE/v1/faq-types/{faq_type_id}
Delete a single FAQ Type.
Example URI
DELETE https://api.eventyay.com/v1/faq-types/1
URI Parameters
- faq_type_id
integer(required) Example: 1ID of the FAQ in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Event FAQ Type Collection ¶
List All FAQ Types for an EventGET/v1/events/{event_identifier}/faq-types{?sort,filter}
Get a list of FAQ Types for an event.
Example URI
GET https://api.eventyay.com/v1/events/1/faq-types?sort=name&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/faq-types/1/relationships/event",
"related": "/v1/faq-types/1/event"
}
},
"faqs": {
"links": {
"self": "/v1/faq-types/1/relationships/faqs",
"related": "/v1/faq-types/1/faqs"
}
}
},
"attributes": {
"name": "abc"
},
"type": "faq-type",
"id": "1",
"links": {
"self": "/v1/faq-types/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/faq-types"
}
}FAQ FAQ Type Collection ¶
List All FAQ Types for a FAQGET/v1/faqs/{faq_identifier}/faq-type{?sort,filter}
Get a list of FAQ Types for a FAQ.
Example URI
GET https://api.eventyay.com/v1/faqs/1/faq-type?sort=name&filter=[]
URI Parameters
- faq_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/faq-types/1/relationships/event",
"related": "/v1/faq-types/1/event"
}
},
"faqs": {
"links": {
"self": "/v1/faq-types/1/relationships/faqs",
"related": "/v1/faq-types/1/faqs"
}
}
},
"attributes": {
"name": "abc"
},
"type": "faq-type",
"id": "1",
"links": {
"self": "/v1/faq-types/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/faq-types/1"
}
}Feedback ¶
feedbacks related to the events.
| Parameter | Description | Type | Required |
|---|---|---|---|
rating |
Rating for the overall event | float | yes |
comment |
Comments and suggestions about the event | string | - |
Feedback Collection ¶
Create FeedbackPOST/v1/feedbacks{?sort,filter}
Create a new feedback with event_id.
Example URI
POST https://api.eventyay.com/v1/feedbacks?sort=rating&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: rating- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"relationships": {
"session": {
"data": {
"type": "session",
"id": "1"
}
},
"user": {
"data": {
"type": "user",
"id": "1"
}
}
},
"attributes": {
"rating": 4,
"comment": "Awesome session."
},
"type": "feedback"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"session": {
"links": {
"self": "/v1/feedbacks/1/relationships/session",
"related": "/v1/feedbacks/1/event"
}
},
"user": {
"links": {
"self": "/v1/feedbacks/1/relationships/user",
"related": "/v1/feedbacks/1/user"
}
},
"event": {
"links": {
"self": "/v1/feedbacks/1/relationships/event",
"related": "/v1/feedbacks/1/event"
}
}
},
"attributes": {
"rating": 4,
"deleted-at": null,
"comment": "Awesome session."
},
"type": "feedback",
"id": 1,
"links": {
"self": "/v1/feedbacks/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/feedbacks/1"
}
}Feedback Detail ¶
Feedback DetailGET/v1/feedbacks/{feedback_id}
Get a single feedback.
Example URI
GET https://api.eventyay.com/v1/feedbacks/1
URI Parameters
- feedback_id
integer(required) Example: 1ID of the feedback in the form of an integer
Request
Headers
Accept: application/vnd.api+jsonResponse
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/feedbacks/1/relationships/event",
"related": "/v1/feedbacks/1/event"
}
},
"user": {
"links": {
"self": "/v1/feedbacks/1/relationships/user",
"related": "/v1/feedbacks/1/user"
}
}
},
"attributes": {
"rating": "4",
"comment": "Awesome event"
},
"type": "feedback",
"id": 1,
"links": {
"self": "/v1/feedbacks/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/feedbacks/1"
}
}Update FeedbackPATCH/v1/feedbacks/{feedback_id}
Update a single feedback with id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/feedbacks/1
URI Parameters
- feedback_id
integer(required) Example: 1ID of the feedback in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "feedback",
"attributes": {
"rating": "5",
"comment": "Awesome session"
},
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"event": {
"links": {
"self": "/v1/feedbacks/1/relationships/event",
"related": "/v1/feedbacks/1/event"
}
},
"user": {
"links": {
"self": "/v1/feedbacks/1/relationships/user",
"related": "/v1/feedbacks/1/user"
}
}
},
"attributes": {
"rating": "5",
"deleted-at": null,
"comment": "Awesome event"
},
"type": "feedback",
"id": 1,
"links": {
"self": "/v1/feedbacks/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/feedbacks/1"
}
}Delete FeedbackDELETE/v1/feedbacks/{feedback_id}
Delete a single feedback.
Example URI
DELETE https://api.eventyay.com/v1/feedbacks/1
URI Parameters
- feedback_id
integer(required) Example: 1ID of the feedback in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Event Feedback Collection ¶
List All Feedbacks for an EventGET/v1/events/{event_identifier}/feedbacks{?sort,filter}
Get a list of feedbacks for an event.
Example URI
GET https://api.eventyay.com/v1/events/1/feedbacks?sort=rating&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional) Example: rating- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"data": [
{
"relationships": {
"event": {
"links": {
"self": "/v1/feedbacks/1/relationships/event",
"related": "/v1/feedbacks/1/event"
}
},
"user": {
"links": {
"self": "/v1/feedbacks/1/relationships/user",
"related": "/v1/feedbacks/1/user"
}
}
},
"attributes": {
"rating": "4",
"deleted-at": null,
"comment": "Awesome event"
},
"type": "feedback",
"id": 1,
"links": {
"self": "/v1/feedbacks/1"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/feedbacks"
}
}User Permissions ¶
ADMIN
To create or modify any data of this data layer, you will need admin access. However you get the schema without admin access.
| Parameter | Description | Type | Required |
|---|---|---|---|
name |
Name of the user permission | string | yes |
description |
Description | string | - |
unverified-user |
allow for unverified user if set to true | boolean | - |
anonymous-user |
allow for ananymous user if set to true | boolean | yes |
User Permission Collection ¶
List all user permissionsGET/v1/user-permissions{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/user-permissions?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 2
},
"data": [
{
"attributes": {
"description": "Publish event (make event live)",
"unverified-user": false,
"name": "publish_event",
"anonymous-user": false
},
"type": "user-permission",
"id": "1",
"links": {
"self": "/v1/user-permissions/1"
}
},
{
"attributes": {
"description": "Create event",
"unverified-user": true,
"name": "create_event",
"deleted-at": null,
"anonymous-user": false
},
"type": "user-permission",
"id": "2",
"links": {
"self": "/v1/user-permissions/2"
}
}
],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/user-permissions"
}
}Create User PermissionPOST/v1/user-permissions{?sort,filter}
Example URI
POST https://api.eventyay.com/v1/user-permissions?sort=name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "example",
"description": "example",
"unverified-user": "false",
"anonymous-user": "false"
},
"type": "user-permission"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"name": "example",
"description": "example",
"unverified-user": "false",
"deleted-at": null,
"anonymous-user": "false"
},
"type": "user-permission",
"id": "1",
"links": {
"self": "/v1/user-permissions/3"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/user-permissions/3"
}
}User Permission Details ¶
Get User Permission DetailsGET/v1/user-permissions/{id}
Get a single resource.
Example URI
GET https://api.eventyay.com/v1/user-permissions/1
URI Parameters
- id
integer(required) Example: 1ID of the page in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"name": "example",
"description": "example",
"unverified-user": "false",
"deleted-at": null,
"anonymous-user": "false"
},
"type": "user-permission",
"id": "1",
"links": {
"self": "/v1/user-permissions/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/user-permissions/1"
}
}Update User PermissionPATCH/v1/user-permissions/{id}
Update a single resource by id.
id(integer) - ID of the record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/user-permissions/1
URI Parameters
- id
integer(required) Example: 1ID of the page in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "example",
"description": "example",
"unverified-user": "false",
"anonymous-user": "false"
},
"type": "user-permission",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"name": "example",
"description": "example",
"unverified-user": "false",
"deleted-at": null,
"anonymous-user": "false"
},
"type": "user-permission",
"id": "3",
"links": {
"self": "/v1/user-permissions/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/user-permissions/1"
}
}Delete User PermissionDELETE/v1/user-permissions/{id}
Delete a single resource.
Example URI
DELETE https://api.eventyay.com/v1/user-permissions/1
URI Parameters
- id
integer(required) Example: 1ID of the page in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Settings ¶
ADMIN
To update or get any attribute of this data layer, you will need admin access. However a part of the schema is available to the general registered user without admin access.
General
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
app-environment |
App Environment (Eg. Production, testing) | string | yes |
app-name |
Name of the application (Eg. Event Yay!, Open Event) | string | - |
tagline |
Tagline (Eg. Event Management and Ticketing, Home) | string | - |
secret |
App Secret | string | yes |
order-expiry-time |
Expiry time for orders in minutes | Integer(default: 15) | - |
is-paypal-activated |
Whether paypal payment is configured or not | boolean | - |
is-stripe-activated |
Whether stripe payment is configured or not | boolean | - |
is-omise-activated |
Whether omise payment is configured or not | boolean | - |
start_pg_event_id |
Event id for an event that needs to be displayed instead of default start page | string | - |
STORAGE
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
storage-place |
Storage of App (storage place, local, s3) | string | yes |
(S3)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
aws-key |
Amazon Web Services key | string | yes |
aws-secret |
Amazon Web Services secret | string | yes |
aws-bucket-name |
Amazon Web Services bucket name | string | yes |
aws-region |
Amazon Web Services region | string | yes |
(Google Storage)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
gs-key |
Google Storage key | string | yes |
gs-secret |
Google Storage Services secret | string | yes |
gs-bucket-name |
Google Storage bucket name | string | yes |
Social Login (Google Auth)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
google-client-id |
Google client id | string | yes |
google-client-secret |
Google client secret | string | yes |
(FB)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
fb-client-id |
Facebook client id | string | yes |
fb-client-secret |
Facebook client secret | string | yes |
(Twitter)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
tw-consumer-key |
Twitter client id | string | yes |
tw-consumer-secret |
Twitter client secret | string | yes |
(Instagram)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
in-client-id |
Instagram client id | string | yes |
in-client-secret |
Instagram client secret | string | yes |
Payment Gateway (Stripe Keys)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
stripe-client-id |
Stripe client id | string | yes |
stripe-secret-key |
Stripe secret key | string | yes |
stripe-publishable-key |
Stripe publishable key | string | yes |
(PayPal Credentials)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
paypal-mode |
Paypal mode | string | yes |
paypal-sandbox-client |
Paypal sandbox client | string | yes |
paypal-sandbox-secret |
Paypal sandbox secret | string | yes |
paypal-client |
Paypal client | string | yes |
paypal-secret |
Paypal secret | string | yes |
(Omise Credentials)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
omise-mode |
Omise mode | string | yes |
omise-test-public |
Omise Test Public Key | string | yes |
omise-test-secret |
Omise Test Secret Key | string | yes |
omise-live-public |
Omise Live Public Key | string | yes |
omise-live-secret |
Omise Live Secret Key | string | yes |
EMAIL (Email service)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
email-service |
Email service | string | yes |
email-from |
Email from | string | yes |
email-from-name |
Email Sender name | string | yes |
(Sendgrid)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
sengrid-key |
Sendgrid key | string | yes |
(SMTP)
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
smtp-host |
smtp host | string | yes |
smtp-username |
smtp username | string | yes |
smtp-password |
smtp password | string | yes |
smtp-port |
smtp port | string | yes |
smtp-encryption |
smtp encryption | string | yes |
Google Analytics
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
analytics-key |
Google analytics key | string | - |
Social links
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
google-url |
Google url | string | yes |
github-url |
Github url | string | yes |
twitter-url |
Twitter url | string | yes |
support-url |
Support url | string | yes |
facebook-url |
Facebook url | string | yes |
youtube-url |
Youtube url | string | yes |
Generators
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
android-app-url |
Android app url | string | yes |
web-app-url |
Web App url | string | yes |
Frontend Url
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
frontend-url |
Url of Open Event Frontend | string (url with scheme) | - |
Cookie Policy
| Parameter | Description | Type | Admin Only |
|---|---|---|---|
cookie-policy |
Warning to be displayed on the frontend | string | - |
cookie-policy-link |
Link to the full cookie policy | string | - |
Settings Details ¶
Show SettingsGET/v1/settings{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/settings?sort=app-name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: app-name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"app-environment": "testing",
"app-name": "Event Yay!",
"tagline": "Event Management and Ticketing",
"order-expiry-time": "15",
"storage-place": "s3",
"aws-key": "example1234",
"aws-secret": "example1234",
"aws-bucket-name": "myawsbucet",
"aws-region": "us-west",
"gs-key": "example1234",
"gs-secret": "example1234",
"gs-bucket-name": "mygsbucket",
"google-client-id": "example1234",
"google-client-secret": "example1234",
"fb-client-id": "example1234",
"fb-client-secret": "example1234",
"tw-consumer-key": "example1234",
"tw-consumer-secret": "example1234",
"in-client-id": "example1234",
"in-client-secret": "example1234",
"stripe-client-id": "example1234",
"stripe-secret-key": "example1234",
"stripe-publishable-key": "example1234",
"paypal-mode": "development",
"paypal-sandbox-secret": "example1234",
"paypal-sandbox-client": "example1234",
"paypal-secret": "example1234",
"paypal-client": "example1234",
"omise-mode": "development",
"omise-test-public": "example1234",
"omise-test-secret": "example1234",
"omise-live-public": "example1234",
"omise-live-secret": "example1234",
"email-service": "example",
"email-from": "example@example.com",
"email-from-name": "example",
"sendgrid-key": "example1234",
"smtp-host": "smtp.gmail.com",
"smtp-username": "example",
"smtp-password": "example",
"smtp-port": 25,
"smtp-encryption": "example1234",
"analytics-key": "example1234",
"google-url": "http://example.com",
"github-url": "http://example.com",
"twitter-url": "http://example.com",
"support-url": "http://example.com",
"facebook-url": "http://example.com",
"youtube-url": "http://example.com",
"android-app-url": "http://example.com",
"web-app-url": "http://example.com",
"static-domain": "http://example.com",
"frontend-url": "http://example.com",
"cookie-policy": "example",
"cookie-policy-link": "http://example.com",
"is-paypal-activated": false,
"is-stripe-activated": false
},
"type": "setting",
"id": "1",
"links": {
"self": "/v1/settings?id=1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/settings?id=1"
}
}Update SettingsPATCH/v1/settings{?sort,filter}
Example URI
PATCH https://api.eventyay.com/v1/settings?sort=app-name&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: app-name- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"app-environment": "testing",
"app-name": "Event Yay!",
"tagline": "Event Management and Ticketing",
"storage-place": "s3",
"aws-key": "example1234",
"aws-secret": "example1234",
"aws-bucket-name": "myawsbucet",
"aws-region": "us-west",
"gs-key": "example1234",
"gs-secret": "example1234",
"gs-bucket-name": "mygsbucket",
"google-client-id": "example1234",
"google-client-secret": "example1234",
"fb-client-id": "example1234",
"fb-client-secret": "example1234",
"tw-consumer-key": "example1234",
"tw-consumer-secret": "example1234",
"in-client-id": "example1234",
"in-client-secret": "example1234",
"stripe-client-id": "example1234",
"stripe-secret-key": "example1234",
"stripe-publishable-key": "example1234",
"paypal-mode": "development",
"paypal-sandbox-secret": "example1234",
"paypal-sandbox-client": "example1234",
"paypal-secret": "example1234",
"paypal-client": "example1234",
"omise-mode": "development",
"omise-test-public": "example1234",
"omise-test-secret": "example1234",
"omise-live-public": "example1234",
"omise-live-secret": "example1234",
"email-service": "example",
"email-from": "example@example.com",
"email-from-name": "example",
"sendgrid-key": "example1234",
"smtp-host": "smtp.gmail.com",
"smtp-username": "example",
"smtp-password": "example",
"smtp-port": 25,
"smtp-encryption": "example1234",
"analytics-key": "example1234",
"google-url": "http://example.com",
"github-url": "http://example.com",
"twitter-url": "http://example.com",
"support-url": "http://example.com",
"facebook-url": "http://example.com",
"youtube-url": "http://example.com",
"android-app-url": "http://example.com",
"web-app-url": "http://example.com",
"static-domain": "http://example.com",
"frontend-url": "http://example.com",
"cookie-policy": "example",
"cookie-policy-link": "http://example.com"
},
"type": "setting",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"app-environment": "testing",
"app-name": "Event Yay!",
"tagline": "Event Management and Ticketing",
"order-expiry-time": "15",
"storage-place": "s3",
"aws-key": "example1234",
"aws-secret": "example1234",
"aws-bucket-name": "myawsbucet",
"aws-region": "us-west",
"gs-key": "example1234",
"gs-secret": "example1234",
"gs-bucket-name": "mygsbucket",
"google-client-id": "example1234",
"google-client-secret": "example1234",
"fb-client-id": "example1234",
"fb-client-secret": "example1234",
"tw-consumer-key": "example1234",
"tw-consumer-secret": "example1234",
"in-client-id": "example1234",
"in-client-secret": "example1234",
"stripe-client-id": "example1234",
"stripe-secret-key": "example1234",
"stripe-publishable-key": "example1234",
"paypal-mode": "development",
"paypal-sandbox-secret": "example1234",
"paypal-sandbox-client": "example1234",
"paypal-secret": "example1234",
"paypal-client": "example1234",
"omise-mode": "development",
"omise-test-public": "example1234",
"omise-test-secret": "example1234",
"omise-live-public": "example1234",
"omise-live-secret": "example1234",
"email-service": "example",
"email-from": "example@example.com",
"email-from-name": "example",
"sendgrid-key": "example1234",
"smtp-host": "smtp.gmail.com",
"smtp-username": "example",
"smtp-password": "example",
"smtp-port": 25,
"smtp-encryption": "example1234",
"analytics-key": "example1234",
"google-url": "http://example.com",
"github-url": "http://example.com",
"twitter-url": "http://example.com",
"support-url": "http://example.com",
"facebook-url": "http://example.com",
"youtube-url": "http://example.com",
"android-app-url": "http://example.com",
"web-app-url": "http://example.com",
"static-domain": "http://example.com",
"frontend-url": "http://example.com",
"cookie-policy": "example",
"cookie-policy-link": "http://example.com",
"is-paypal-activated": false,
"is-stripe-activated": false
},
"type": "setting",
"id": "1",
"links": {
"self": "/v1/settings?id=1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/settings?id=1"
}
}Upload ¶
This group of APIs contain endpoints for uploading media files. The workflow is different for images and any other files. In image, a temporary cropped image is first uploaded using the Image Upload endpoint. For other files, there can be a single file or multiple files for uploading.
Image Upload ¶
A temporary cropped image is first uploaded using this endpoint. After saving the image in it’s prefered storage (local, google storage, s3, etc.), the URL for the temporary image is returned as response. This URL is then sent as form data to the necessary API, where it is then downloaded and resized and stored according to the need. force_local parameter can be set to true to force storage in local.
Upload an Image in temporary locationPOST/v1/upload/image{?force_local}
Example URI
POST https://api.eventyay.com/v1/upload/image?force_local=true
URI Parameters
- force_local
string(optional) Example: true
Request
Headers
Content-Type: application/json
Authorization: JWT <Auth Key>Body
{
"data": "data:image/gif;base64,R0lGODlhEAAQAMQAAORHHOVSKudfOulrSOp3WOyDZu6QdvCchPGolfO0o/XBs/fNwfjZ0frl3/zy7////wAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH5BAkAABAALAAAAAAQABAAAAVVICSOZGlCQAosJ6mu7fiyZeKqNKToQGDsM8hBADgUXoGAiqhSvp5QAnQKGIgUhwFUYLCVDFCrKUE1lBavAViFIDlTImbKC5Gm2hB0SlBCBMQiB0UjIQA7"
}Response
200Headers
Content-Type: application/jsonBody
{
"url": "/serve_static/media/temp/images/6a6614c7-d458-43de-a9bd-5c329e273bf0/U0lLbUt2SF/4d4dae9e-0bab-4e72-ba2f-e8e633a145e5.gif"
}File Upload ¶
This endpoint supports uploading of any kind of file or multiple files. If a single file is to be uploaded, send a single file in the keyword file, else if multiple files, send an array of files in the keyword files. After saving in it’s prefered storage (local, google storage, s3, etc.), the URL or array of URLs returned as response. force_local parameter can be set to true to force storage in local.
Upload a FilePOST/v1/upload/files{?force_local}
Example URI
POST https://api.eventyay.com/v1/upload/files?force_local=true
URI Parameters
- force_local
string(optional) Example: true
Request
Headers
Content-Type: multipart/form-data; boundary=---BOUNDARYBody
-----BOUNDARY
Content-Disposition: form-data; name="file"; filename="test.csv"
Content-Type: text/csvResponse
200Headers
Content-Type: application/jsonBody
{
"url": "/serve_static/media/temp/images/6a6614c7-d458-43de-a9bd-5c329e273bf0/U0lLbUt2SF/4d4dae9e-0bab-4e72-ba2f-e8e633a145e5.gif"
}Event Export ¶
This group of APIs help you to start a task for exporting a particular event in the zip format, ical and xcal. It also lets you start a task to export orders of an event as csv
Start Event Export as Zip ¶
This endpoint lets the user start a task of exporting the event in the zip format.
Start a Task to Export an Event as ZipPOST/v1/events/{event_identifier}/export/json
Example URI
POST https://api.eventyay.com/v1/events/1/export/json
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the event with the event_id as a collection of json files and archive it to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"image": true,
"video": true,
"document": true,
"audio": true
}Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Event Export as iCal file ¶
This endpoint lets the user start a task to export the event as an iCal file.
Start a Task to Export an Event as iCal eventGET/v1/events/{event_identifier}/export/ical
Example URI
GET https://api.eventyay.com/v1/events/1/export/ical
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the event with the event_id as an iCal event file.
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Event Export as xCalendar ¶
Start a Task to Export an Event as xCalendarGET/v1/events/{event_identifier}/export/xcal
Example URI
GET https://api.eventyay.com/v1/events/1/export/xcal
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the event with the event_id as an xcal file to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Event Export as Pentabarf XML ¶
Start a Task to Export an Event as Pentabarf XMLGET/v1/events/{event_identifier}/export/pentabarf
Example URI
GET https://api.eventyay.com/v1/events/1/export/pentabarf
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the event with the event_id as a pentabarf XML file to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Orders Export as CSV ¶
Start a Task to Export Orders of an Event as CSVGET/v1/events/{event_identifier}/export/orders/csv
Example URI
GET https://api.eventyay.com/v1/events/1/export/orders/csv
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the list of orders of the event with that event_id as a CSV file to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Orders Export as PDF ¶
Start a Task to Export Orders of an Event as PDFGET/v1/events/{event_identifier}/export/orders/pdf
Example URI
GET https://api.eventyay.com/v1/events/1/export/orders/pdf
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the list of orders of the event with that event_id as a PDF file to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Attendees Export as CSV ¶
Start a Task to Export Attendees of an Event as CSVGET/v1/events/{event_identifier}/export/attendees/csv
Example URI
GET https://api.eventyay.com/v1/events/1/export/attendees/csv
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the list of attendees of the event with that event_id as a CSV file to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Attendees Export as PDF ¶
Start a Task to Export Attendees of an Event as PDFGET/v1/events/{event_identifier}/export/attendees/pdf
Example URI
GET https://api.eventyay.com/v1/events/1/export/attendees/pdf
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the list of attendees of the event with that event_id as a PDF file to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Sessions Export as CSV ¶
Start a Task to Export Sessions of an Event as CSVPOST/v1/events/{event_identifier}/export/sessions/csv
Example URI
POST https://api.eventyay.com/v1/events/1/export/sessions/csv
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the list of sessions of the event with that event_id as a CSV file to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"status": "all"
}Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Speakers Export as CSV ¶
Start a Task to Export Speakers of an Event as CSVPOST/v1/events/{event_identifier}/export/speakers/csv
Example URI
POST https://api.eventyay.com/v1/events/1/export/speakers/csv
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the list of speakers of the event with that event_id as a CSV file to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"status": "all"
}Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Sessions Export as PDF ¶
Start a Task to Export Sessions of an Event as PDFGET/v1/events/{event_identifier}/export/sessions/pdf
Example URI
GET https://api.eventyay.com/v1/events/1/export/sessions/pdf
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the list of sessions of the event with that event_id as a PDF file to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Speakers Export as PDF ¶
Start a Task to Export Speakers of an Event as PDFGET/v1/events/{event_identifier}/export/speakers/pdf
Example URI
GET https://api.eventyay.com/v1/events/1/export/speakers/pdf
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier) Start a celery task to export the list of speakers of the event with that event_id as a PDF file to get it ready for downloading. Returns the task url to get the status of the export task.
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Start Badge Export as PDF ¶
Start a Task to Export Badge of an Event as PDFGET/v1/badge-forms/print-badge-pdf{?attendee_id,list_field_show}
Example URI
GET https://api.eventyay.com/v1/badge-forms/print-badge-pdf?attendee_id=1&list_field_show='email, name'
URI Parameters
- attendee_id
string(required) Example: 1ID of the attendee in the form of an integer.
- list_field_show
string(required) Example: 'email, name'list of fields to ne showed in badge, separated by comma.
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Event Import ¶
This group of APIs help you to start a task for importing zip containing JSON files into the server.
Start Event Import ¶
Start a celery task to import event along with all other import related data such as microlocation, session, speakers, etc. from the different json files present inside the zip file and save it inside a database.
Start a Task to Import an EventPOST/v1/events/import/json
Example URI
POST https://api.eventyay.com/v1/events/import/json
Request
Headers
Content-Type: multipart/form-data; boundary=---BOUNDARYBody
-----BOUNDARY
Content-Disposition: form-data; name="file"; filename="event1.zip"
Content-Type: application/zipResponse
200Headers
Content-Type: application/jsonBody
{
"task_url": "/v1/tasks/b7ca7088-876e-4c29-a0ee-b8029a64849a"
}Celery Tasks ¶
This API helps you to get the status of a celery task and the response
Task Details ¶
Get Task ResultGET/v1/tasks/{task_id}
Example URI
GET https://api.eventyay.com/v1/tasks/1
URI Parameters
- task_id
string(required) Example: 1id of the task. (b7ca7088-876e-4c29-a0ee-b8029a64849a is an example of identifier) Get the task status and the final result of the task as response
Request
Headers
Content-Type: application/json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"result": {
"download_url": "/v1/events/1/exports/http://localhost/static/media/exports/1/zip/OGpMM0w2RH/event1.zip"
},
"state": "SUCCESS"
}Event Statistics ¶
General:
| Parameter | Description | Type |
|---|---|---|
id |
Event Id | Integer |
identifier |
Event identifier | String |
speakers |
No. of speakers | Integer |
sponsors |
No. of sponsors | Integer |
sessions |
No. of sessions | Integer |
sessions_draft |
No. of draft sessions | Integer |
sessions_submitted |
No. of submitted sessions | Integer |
sessions_accepted |
No. of accepted sessions | Integer |
sessions_confirmed |
No. of confirmed sessions | Integer |
sessions_pending |
No. of pending sessions | Integer |
sessions_rejected |
No. of rejected sessions | Integer |
Event Statistics Details ¶
Show Event Statistics GeneralGET/v1/events/{event_identifier}/general-statistics
Example URI
GET https://api.eventyay.com/v1/events/1/general-statistics
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"speakers": 60,
"sessions": 60,
"sessions-pending": 10,
"sponsors": 441,
"sessions-submitted": 10,
"sessions-rejected": 10,
"sessions-confirmed": 10,
"identifier": "e03a8a32",
"sessions-accepted": 10,
"sessions-draft": 10
},
"type": "event-statistics-general",
"id": "1",
"links": {
"self": "/v1/events/1/statistics/general"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/statistics/general"
}
}Admin Statistics ¶
Event Statistics Details ¶
Events:
| Parameter | Description | Type |
|---|---|---|
id |
Id will be 1 | Integer |
draft |
No. of draft events | Integer |
published |
No. of published events | Integer |
past |
No. of past events | Integer |
Show Event StatisticsGET/v1/admin/statistics/events
Example URI
GET https://api.eventyay.com/v1/admin/statistics/events
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"past": 15,
"draft": 16,
"published": 1
},
"type": "admin-statistics-event",
"id": "1",
"links": {
"self": "/v1/admin/statistics/events"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/admin/statistics/events"
}
}Event Types Statistics Details ¶
Event Types:
| Parameter | Description | Type |
|---|---|---|
name |
Name of event type | string |
id |
Id of the event type | Integer |
count |
No. of events of event type | Integer |
Show Event Types StatisticsGET/v1/admin/statistics/event-types
Example URI
GET https://api.eventyay.com/v1/admin/statistics/event-types
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{}Event Topics Statistics Details ¶
Event Topics:
| Parameter | Description | Type |
|---|---|---|
name |
Name of event topic | string |
id |
Id of the event topic | Integer |
count |
No. of events of event topic | Integer |
Show Event Topics StatisticsGET/v1/admin/statistics/event-topics
Example URI
GET https://api.eventyay.com/v1/admin/statistics/event-topics
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{}User Statistics Details ¶
Users:
| Parameter | Description | Type |
|---|---|---|
id |
Id will be 1 | Integer |
super-admin |
No. of super admin users | Integer |
admin |
No. of admin users | Integer |
verified |
No. of verified users | Integer |
unverified |
No. of unverified users | Integer |
organizer |
No. of organizer users | Integer |
coorganizer |
No. of coorganizer users | Integer |
attendee |
No. of attendee users | Integer |
track-organizer |
No. of track organizer users | Integer |
Show User StatisticsGET/v1/admin/statistics/users
Example URI
GET https://api.eventyay.com/v1/admin/statistics/users
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"attendee": 0,
"verified": 1,
"admin": 1,
"coorganizer": 0,
"super-admin": 1,
"organizer": 16,
"track-organizer": 0,
"unverified": 2
},
"type": "admin-statistics-user",
"id": "1",
"links": {
"self": "/v1/admin/statistics/users"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/admin/statistics/users"
}
}Session Statistics Details ¶
Sessions:
| Parameter | Description | Type |
|---|---|---|
id |
Id will be 1 | Integer |
draft |
No. of draft sessions | Integer |
accepted |
No. of accepted sessions | Integer |
confirmed |
No. of confirmed sessions | Integer |
rejected |
No. of rejected sessions | Integer |
pending |
No. of pending sessions | Integer |
submitted |
No. of submitted sessions | Integer |
Show Session StatisticsGET/v1/admin/statistics/sessions
Example URI
GET https://api.eventyay.com/v1/admin/statistics/sessions
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"confirmed": 0,
"accepted": 1,
"submitted": 0,
"draft": 0,
"rejected": 0,
"pending": 0
},
"type": "admin-statistics-session",
"id": "1",
"links": {
"self": "/v1/admin/statistics/sessions"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/admin/statistics/sessions"
}
}Mail Statistics Details ¶
Mails:
| Parameter | Description | Type |
|---|---|---|
id |
Id will be 1 | Integer |
one-day |
No. of mails in past 1 day | Integer |
three-days |
No. of mails in past 3 days | Integer |
seven-day |
No. of mails in past 7 days | Integer |
thirty-day |
No. of mails in past 30 days | Integer |
Show Mail StatisticsGET/v1/admin/statistics/mails
Example URI
GET https://api.eventyay.com/v1/admin/statistics/mails
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"thirty-days": 0,
"one-day": 0,
"seven-days": 0,
"three-days": 0
},
"type": "admin-statistics-mail",
"id": "1",
"links": {
"self": "/v1/admin/statistics/mails"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/admin/statistics/mails"
}
}Order Statistics ¶
First order fields
| Parameter | Description | Type |
|---|---|---|
identifier |
Identifier of the event | String |
orders |
Contains info about no. of orders | Nested object |
tickets |
Contains info about no. of tickets | Nested object |
sales |
Contains info about sales amount | Nested object |
Nested fields
| Parameter | Description | Type |
|---|---|---|
total |
total orders/tickets/sales | Integer |
draft |
total orders/tickets/sales with this order status | Integer |
cancelled |
total orders/tickets/sales with this order status | Integer |
pending |
total orders/tickets/sales with this order status | Integer |
placed |
total orders/tickets/sales with this order status | Integer |
completed |
total orders/tickets/sales with this order status | Integer |
Order Statistics Details By Event ¶
Show Order Statistics By EventGET/v1/events/{event_identifier}/order-statistics
Example URI
GET https://api.eventyay.com/v1/events/1/order-statistics
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"tickets": {
"placed": 0,
"draft": 0,
"cancelled": 0,
"total": 0,
"expired": 0,
"pending": 0,
"completed": 0
},
"identifier": "09d9a4f1",
"orders": {
"placed": 0,
"draft": 0,
"cancelled": 0,
"total": 0,
"expired": 0,
"pending": 0,
"completed": 0
},
"sales": {
"placed": 0,
"draft": 0,
"cancelled": 0,
"total": 0,
"expired": 0,
"pending": 0,
"completed": 0
}
},
"type": "order-statistics-event",
"id": "1",
"links": {
"self": "/v1/events/1/order-statistics"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/events/1/order-statistics"
}
}Order Statistics Details By Ticket ¶
Show Order Statistics By TicketGET/v1/tickets/{ticket_id}/order-statistics
Example URI
GET https://api.eventyay.com/v1/tickets/1/order-statistics
URI Parameters
- ticket_id
string(required) Example: 1id of the ticket resource.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"attributes": {
"tickets": {
"placed": 0,
"draft": 0,
"cancelled": 0,
"total": 0,
"expired": 0,
"pending": 0
},
"orders": {
"placed": 0,
"draft": 0,
"cancelled": 0,
"total": 0,
"expired": 0,
"pending": 0
},
"sales": {
"placed": 0,
"draft": 0,
"cancelled": 0,
"total": 0,
"expired": 0,
"pending": 0
}
},
"type": "order-statistics-ticket",
"id": "1",
"links": {
"self": "/v1/tickets/1/order-statistics"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/tickets/1/order-statistics"
}
}Orders ¶
| Parameter | Description | Type | Required |
|---|---|---|---|
amount |
Total Amount of Order | Float | - |
address |
Address Of Purchaser | string | - |
city |
City of Purchaser | string | - |
state |
If the custom form is included | boolean | - |
country |
Country of the purchaser | boolean | - |
zipcode |
Zipcode of the address | string | - |
company |
Company for Billing Info | string | - |
tax-business-info |
Tax Business details for Billing Info | string | - |
is-billing-enabled |
Yes/No to signify if Billing Info is enabled or not | boolean (default: false) |
- |
payment-mode |
Mode of payment (free,stripe,paypal) | string | - |
status |
Status of the order(pending, completed, placed, cancelled, expired) | string (default=pending) | - |
discount_code_id |
ID of the discount code | string | - |
order-notes |
Notes associated with Order | string | - |
pdf-url |
URL to download the tickets | string | - |
Orders Collection ¶
List All OrdersGET/v1/orders{?sort,filter}
Get a list of all orders
Example URI
GET https://api.eventyay.com/v1/orders?sort=&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 1- sort
string(optional)Sort the resources according to the given attribute in ascending order. Append ‘-’ to sort in descending order.
- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 0
},
"data": [],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/orders"
}
}Create Order ¶
Create OrderPOST/v1/orders/create-order
Create a new Order
Example URI
POST https://api.eventyay.com/v1/orders/create-order
Request
Headers
Content-Type: application/json
Accept: application/json
Authorization: JWT <Auth Key>Body
{
"tickets": [
{
"id": 1,
"quantity": 2
},
{
"id": 2,
"quantity": 4
},
{
"id": 3,
"quantity": 3,
"price": 789.7
},
{
"id": 4,
"quantity": 3
}
],
"discount_code": "1"
}Response
200Headers
Content-Type: application/jsonBody
{
"data": {
"type": "order",
"attributes": {
"completed-at": null,
"paid-via": null,
"exp-year": null,
"discount-code-id": "1",
"status": "initializing",
"exp-month": null,
"country": null,
"is-billing-enabled": false,
"transaction-id": null,
"order-notes": null,
"tickets-pdf-url": null,
"payment-mode": null,
"city": null,
"tax-business-info": null,
"amount": 4745.81,
"identifier": "300d7722-7005-4776-89d7-037cc7ceec0d",
"brand": null,
"created-at": "2020-09-11T12:11:24.169351+00:00",
"zipcode": null,
"company": null,
"last4": null,
"state": null,
"cancel-note": null,
"address": null
},
"id": "1",
"relationships": {
"tickets": {
"links": {
"self": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d/relationships/ticket",
"related": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d/tickets"
}
},
"user": {
"links": {
"self": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d/relationships/user",
"related": "/v1/users/1"
}
},
"discount-code": {
"links": {
"self": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d/relationships/discount-code",
"related": "/v1/discount-codes/1"
}
},
"attendees": {
"links": {
"self": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d/relationships/attendee",
"related": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d/attendees"
}
},
"event": {
"links": {
"self": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d/relationships/event",
"related": "/v1/events/1"
}
},
"event-invoice": {
"links": {
"self": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d/relationships/event-invoice/",
"related": "/v1/event-invoices/1"
}
},
"marketer": {
"links": {
"self": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d/relationships/marketer"
}
}
},
"links": {
"self": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d"
}
},
"links": {
"self": "/v1/orders/300d7722-7005-4776-89d7-037cc7ceec0d"
}
}Order Detail ¶
Get Order DetailGET/v1/orders/{identifier}
Get a single Order detail.
Example URI
GET https://api.eventyay.com/v1/orders/1
URI Parameters
- identifier
string(required) Example: 1the identifier of the order.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/ticket",
"related": "/v1/orders/1/tickets"
}
},
"attendees": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/attendee",
"related": "/v1/orders/1/attendees"
}
},
"marketer": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/marketer"
}
},
"discount-code": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/discount-code"
}
},
"event": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/event",
"related": "/v1/events/1"
}
}
},
"attributes": {
"status": "confirmed",
"city": null,
"identifier": "ab25a170-f36d-4dd6-b99c-9c202e693afc",
"paid-via": null,
"exp-year": null,
"transaction-id": null,
"discount-code-id": null,
"brand": null,
"zipcode": null,
"company": null,
"tax-business-info": null,
"is-billing-enabled": false,
"payment-mode": "free",
"last4": null,
"state": null,
"address": null,
"exp-month": null,
"amount": 10,
"country": "India",
"completed-at": null,
"created-at": "2018-07-08T01:05:09.904696+00:00",
"order-notes": "example",
"tickets-pdf-url": "https://example.com/media/attendees/tickets/pdf/order_identifier.pdf"
},
"type": "order",
"id": "1",
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc"
}
}Update OrderPATCH/v1/orders/{identifier}
Update a single custom form with id.
id(integer) - Identifier of the order record to update (required)
Example URI
PATCH https://api.eventyay.com/v1/orders/1
URI Parameters
- identifier
string(required) Example: 1the identifier of the order.
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"payment-mode": "paypal",
"order-notes": "example"
},
"type": "order",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/ticket",
"related": "/v1/orders/1/tickets"
}
},
"attendees": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/attendee",
"related": "/v1/orders/1/attendees"
}
},
"marketer": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/marketer"
}
},
"user": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/user"
}
},
"discount-code": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/discount-code"
}
},
"event": {
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc/relationships/event",
"related": "/v1/events/1"
}
}
},
"attributes": {
"status": "confirmed",
"city": null,
"identifier": "ab25a170-f36d-4dd6-b99c-9c202e693afc",
"paid-via": null,
"exp-year": null,
"transaction-id": null,
"discount-code-id": null,
"brand": null,
"zipcode": null,
"company": null,
"tax-business-info": null,
"is-billing-enabled": false,
"payment-mode": "paypal",
"last4": null,
"state": null,
"address": null,
"exp-month": null,
"amount": 10,
"country": "India",
"completed-at": null,
"created-at": "2018-07-08T01:05:09.904696+00:00",
"order-notes": "sample,example",
"tickets-pdf-url": "https://example.com/media/attendees/tickets/pdf/order_identifier.pdf"
},
"type": "order",
"id": "1",
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/orders/ab25a170-f36d-4dd6-b99c-9c202e693afc"
}
}Create Order with on site Attendees ¶
Create Order with on site AttendeesPOST/v1/orders?onsite=true
Create a new Order with on site attendees
Example URI
POST https://api.eventyay.com/v1/orders?onsite=true
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"payment-mode": "free",
"country": "India",
"status": "pending",
"amount": null,
"order-notes": "example",
"on-site-tickets": [
{
"data": {
"attributes": {
"id": "1",
"quantity": "2"
},
"type": "on-site-ticket"
}
},
{
"data": {
"attributes": {
"id": "2",
"quantity": "3"
},
"type": "on-site-ticket"
}
}
]
},
"type": "order",
"relationships": {
"event": {
"data": {
"id": "1",
"type": "event"
}
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"relationships": {
"tickets": {
"links": {
"self": "/v1/orders/617ed24c-9a07-4084-b076-ed73552db27e/relationships/ticket",
"related": "/v1/orders/11/tickets"
}
},
"attendees": {
"data": [
{
"type": "attendee",
"id": "1"
}
],
"links": {
"self": "/v1/orders/617ed24c-9a07-4084-b076-ed73552db27e/relationships/attendee",
"related": "/v1/orders/11/attendees"
}
},
"marketer": {
"links": {
"self": "/v1/orders/617ed24c-9a07-4084-b076-ed73552db27e/relationships/marketer"
}
},
"user": {
"links": {
"self": "/v1/orders/617ed24c-9a07-4084-b076-ed73552db27e/relationships/user"
}
},
"discount-code": {
"links": {
"self": "/v1/orders/617ed24c-9a07-4084-b076-ed73552db27e/relationships/discount-code"
}
},
"event": {
"links": {
"self": "/v1/orders/617ed24c-9a07-4084-b076-ed73552db27e/relationships/event",
"related": "/v1/events/1"
}
}
},
"attributes": {
"status": "pending",
"city": null,
"identifier": "617ed24c-9a07-4084-b076-ed73552db27e",
"paid-via": null,
"exp-year": null,
"transaction-id": null,
"discount-code-id": null,
"brand": null,
"zipcode": null,
"company": null,
"tax-business-info": null,
"is-billing-enabled": false,
"payment-mode": "free",
"last4": null,
"state": null,
"payment-url": "https://www.sandbox.paypal.com/cgi-bin/webscr?token=EC-62113287PK247472B&cmd=_express-checkout",
"address": null,
"exp-month": null,
"amount": null,
"country": "India",
"completed-at": null,
"created-at": "2018-07-08T01:05:09.904696+00:00",
"order-notes": "example",
"tickets-pdf-url": "https://example.com/media/attendees/tickets/pdf/order_identifier.pdf"
},
"type": "order",
"id": "11",
"links": {
"self": "/v1/orders/1"
}
},
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/orders/11"
}
}Charge ¶
Charge for an OrderPOST/v1/orders/{order_identifier}/charge
Receive payments for an order
Example URI
POST https://api.eventyay.com/v1/orders/1/charge
URI Parameters
- order_identifier
Integer(required) Example: 1Identifier of the order in the form of an integer.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"stripe": "stripe_token",
"paypal_payer_id": null,
"paypal_payment_id": null
},
"type": "charge"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "charge",
"id": "1",
"attributes": {
"message": "success/failure message",
"status": true
},
"links": {
"self": "/v1/orders/1/charge"
}
},
"links": {
"self": "/v1/orders/1/charge"
},
"jsonapi": {
"version": "1.0"
}
}Orders under an Event ¶
List all Orders under an EventGET/v1/events/{event_identifier}/orders{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/events/1/orders?sort=payment-mode&filter=[]
URI Parameters
- event_identifier
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: payment-mode- filter
string(optional) Example: []
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"jsonapi": {
"version": "1.0"
},
"meta": {
"count": 1
},
"data": [
{
"id": "4",
"type": "order",
"relationships": {
"attendees": {
"links": {
"self": "/v1/orders/070abac6-44a7-423d-830f-f5f0ef4e83f2/relationships/attendee",
"related": "/v1/orders/070abac6-44a7-423d-830f-f5f0ef4e83f2/attendees"
}
},
"user": {
"links": {
"self": "/v1/orders/070abac6-44a7-423d-830f-f5f0ef4e83f2/relationships/user"
}
},
"tickets": {
"links": {
"self": "/v1/orders/070abac6-44a7-423d-830f-f5f0ef4e83f2/relationships/ticket",
"related": "/v1/orders/070abac6-44a7-423d-830f-f5f0ef4e83f2/tickets"
}
},
"marketer": {
"links": {
"self": "/v1/orders/070abac6-44a7-423d-830f-f5f0ef4e83f2/relationships/marketer"
}
},
"event": {
"links": {
"self": "/v1/orders/070abac6-44a7-423d-830f-f5f0ef4e83f2/relationships/event",
"related": "/v1/events/3"
}
},
"discount-code": {
"links": {
"self": "/v1/orders/070abac6-44a7-423d-830f-f5f0ef4e83f2/relationships/discount-code"
}
}
},
"links": {
"self": "/v1/orders/070abac6-44a7-423d-830f-f5f0ef4e83f2"
},
"attributes": {
"last4": null,
"brand": null,
"exp-year": null,
"paid-via": null,
"cancel-note": null,
"state": null,
"exp-month": null,
"status": "pending",
"completed-at": null,
"payment-mode": "stripe",
"transaction-id": null,
"amount": 10,
"address": null,
"city": null,
"country": "India",
"identifier": "070abac6-44a7-423d-830f-f5f0ef4e83f2",
"zipcode": null,
"company": null,
"tax-business-info": null,
"is-billing-enabled": false,
"discount-code-id": null,
"tickets-pdf-url": "https://example.com/media/attendees/tickets/pdf/order_identifier.pdf"
}
}
],
"links": {
"self": "/v1/orders"
}
}Orders under a User ¶
List all Orders under a UserGET/v1/users/{user_id}/orders{?sort,filter}
Get a list of all orders
Example URI
GET https://api.eventyay.com/v1/users/1/orders?sort=name&filter=[]
URI Parameters
- user_id
integer(required) Example: 1ID of the user in the form of an integer
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 0
},
"data": [],
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/orders"
}
}Create Paypal payment ¶
Create Paypal payment for an OrderPOST/orders/{order_identifier}/create-paypal-payment
Create paypal payment
Example URI
POST https://api.eventyay.com/orders/example/create-paypal-payment
URI Parameters
- order_identifier
string(required) Example: exampleIdentifier of the order in the form of a String.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"return_url": "https://localhost:5000/return_url",
"cancel_url": "https://localhost:5000/cancel_url"
},
"type": "paypal-payment"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"status": "true",
"payment_id": "example",
"error": null
}Calculate Order Amount ¶
Calculate Order AmountPOST/v1/orders/calculate-amount
Calculates the order amount
Example URI
POST https://api.eventyay.com/v1/orders/calculate-amount
Request
Headers
Content-Type: application/json
Accept: application/json
Authorization: JWT <Auth Key>Body
{
"tickets": [
{
"id": 1,
"quantity": 2
},
{
"id": 2,
"quantity": 4
},
{
"id": 3,
"quantity": 3,
"price": 789.7
},
{
"id": 4,
"quantity": 3
}
],
"discount_code": "1"
}Response
200Headers
Content-Type: application/jsonBody
{
"discount": 419.43,
"sub_total": 4021.87,
"tax": {
"amount": 723.94,
"included": false,
"name": "GST",
"percent": 18
},
"tickets": [
{
"discount": null,
"id": 1,
"name": "example",
"price": 123.5,
"quantity": 2,
"sub_total": 247,
"ticket_fee": 0
},
{
"discount": {
"amount": 45.63,
"code": "example",
"percent": 10,
"total": 182.52
},
"id": 2,
"name": "example",
"price": 456.3,
"quantity": 4,
"sub_total": 1642.68,
"ticket_fee": 0
},
{
"discount": {
"amount": 78.97,
"code": "example",
"percent": 10,
"total": 236.91
},
"id": 3,
"name": "example",
"price": 789.7,
"quantity": 3,
"sub_total": 2132.19,
"ticket_fee": 0
},
{
"discount": null,
"id": 4,
"name": "example",
"price": 0,
"quantity": 3,
"sub_total": 0,
"ticket_fee": 0
}
],
"total": 4745.81
}Admin Sales ¶
Sales:
| Parameter | Description | Type |
|---|---|---|
name |
Name of event | String |
sales |
sales block | Object |
starts_at |
Start time of event | String |
ends_at |
End time of event | String |
fee-percentage |
Fee percentage | Float |
payment-currency |
Currency of event | String |
revenue |
Total revenue | Integer |
ticket-count |
Number of tickets sold | Float |
location_name |
Place of event | String |
first_name |
First name of organizer | String |
last_name |
Last name of organizer | String |
email |
Email of marketer | String |
fullname |
Full name of marketer | String |
Sales by Events Details ¶
Show Sales by EventsGET/v1/admin/sales/by-events{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/admin/sales/by-events?sort=name&filter=
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: name- filter
string(optional)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "admin-sales-by-events",
"attributes": {
"name": "Event name",
"ends_at": "2018-08-08T15:00:02.394000+00:00",
"sales": {
"placed": {
"sales_total": 0,
"ticket_count": 0
},
"completed": {
"sales_total": 0,
"ticket_count": 0
},
"pending": {
"sales_total": 0,
"ticket_count": 0
}
},
"starts_at": "2018-08-07T22:00:00+00:00"
},
"id": "1",
"links": {
"self": "/v1/admin/sales/by-events"
}
}
],
"links": {
"self": "/v1/admin/sales/by-events"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}Sales by Organizers Details ¶
Show Sales by OrganizersGET/v1/admin/sales/by-organizers{?sort,filter}
Example URI
GET https://api.eventyay.com/v1/admin/sales/by-organizers?sort=first_name&filter=
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: first_name- filter
string(optional)
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "admin-sales-by-organizers",
"attributes": {
"first_name": null,
"last_name": null,
"sales": {
"placed": {
"sales_total": 0,
"ticket_count": 0
},
"completed": {
"sales_total": 0,
"ticket_count": 0
},
"pending": {
"sales_total": 0,
"ticket_count": 0
}
}
},
"id": "1",
"links": {
"self": "/v1/admin/sales/by-organizers"
}
}
],
"links": {
"self": "/v1/admin/sales/by-organizers"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}Sales by Location Details ¶
Show Sales by LocationGET/v1/admin/sales/by-location
Example URI
GET https://api.eventyay.com/v1/admin/sales/by-location
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "admin-sales-by-location",
"attributes": {
"location_name": "Berlin, Germany",
"sales": {
"placed": {
"sales_total": 0,
"ticket_count": 0
},
"completed": {
"sales_total": 0,
"ticket_count": 0
},
"pending": {
"sales_total": 0,
"ticket_count": 0
}
}
},
"links": {
"self": "/v1/admin/sales/by-location"
}
}
],
"links": {
"self": "/v1/admin/sales/by-location"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}Sales by Marketer Details ¶
Show Sales by MarketerGET/v1/admin/sales/by-marketer
Example URI
GET https://api.eventyay.com/v1/admin/sales/by-marketer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "admin-sales-by-marketer",
"attributes": {
"fullname": null,
"email": null,
"sales": {
"placed": {
"sales_total": 0,
"ticket_count": 0
},
"completed": {
"sales_total": 0,
"ticket_count": 0
},
"pending": {
"sales_total": 0,
"ticket_count": 0
}
}
},
"id": "1",
"links": {
"self": "/v1/admin/sales/by-marketer"
}
}
],
"links": {
"self": "/v1/admin/sales/by-marketer"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}Sales discounted Details ¶
Show Sales DiscountedGET/v1/admin/sales/discounted
Example URI
GET https://api.eventyay.com/v1/admin/sales/discounted
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [],
"links": {
"self": "/v1/admin/sales/discounted"
},
"meta": {
"count": 0
},
"jsonapi": {
"version": "1.0"
}
}Sales invoice detail ¶
Show Sales InvoicesGET/v1/admin/sales/invoices
Example URI
GET https://api.eventyay.com/v1/admin/sales/invoices
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [],
"links": {
"self": "/v1/admin/sales/invoices"
},
"meta": {
"count": 0
},
"jsonapi": {
"version": "1.0"
}
}Fees Sales Details ¶
Show Sales FeesGET/v1/admin/sales/fees
Example URI
GET https://api.eventyay.com/v1/admin/sales/fees
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "admin-sales-fees",
"attributes": {
"name": "event 1",
"fee-percentage": 20,
"revenue": 10,
"ticket-count": 42,
"payment-currency": "USD"
},
"id": "1",
"links": {
"self": "/v1/admin/sales/fees"
}
},
{
"type": "admin-sales-fees",
"attributes": {
"name": "event 2",
"fee-percentage": 20,
"revenue": 0,
"ticket-count": 3,
"payment-currency": "USD"
},
"id": "2",
"links": {
"self": "/v1/admin/sales/fees"
}
}
],
"links": {
"self": "/v1/admin/sales/fees"
},
"meta": {
"count": 5
},
"jsonapi": {
"version": "1.0"
}
}Event Copy ¶
To create copy of an event
Create Event Copy ¶
Create CopyPOST/v1/events/{identifier}/copy
Example URI
POST https://api.eventyay.com/v1/events/1/copy
URI Parameters
- identifier
string(required) Example: 1Identifier of the event or ID of the event to copy Creates the copy. Requires Co-Organizer access
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{}Response
200Headers
Content-Type: application/jsonBody
{
"copied": true,
"id": 25,
"identifier": "52d69149"
}Change Password ¶
This Groups APIs are used for change password request of the user.
Change Password ¶
Change password using old passwordPOST/v1/auth/change-password
Example URI
POST https://api.eventyay.com/v1/auth/change-password
Request
Headers
Content-Type: application/json
Authorization: JWT <Auth Key>Body
{
"data": {
"old-password": "fossasia",
"new-password": "eventyay"
}
}Response
200Headers
Content-Type: application/jsonBody
{
"email": "example@example.com",
"id": "1",
"name": "example",
"password-changed": true
}Reset Forgotten Password ¶
Change password through token received via email.
Get Reset Password TokenPOST/v1/auth/reset-password
Sends the token to reset the account associated with the provided email id via email.
Example URI
POST https://api.eventyay.com/v1/auth/reset-password
Request
Headers
Content-Type: application/jsonBody
{
"data": {
"email": "open_event_test_user@fossasia.org"
}
}Response
200Headers
Content-Type: application/jsonBody
{
"message": "Email Sent"
}Reset Password from TokenPATCH/v1/auth/reset-password
Example URI
PATCH https://api.eventyay.com/v1/auth/reset-password
Request
Headers
Content-Type: application/jsonBody
{
"data": {
"token": "token",
"password": "new password"
}
}Response
200Headers
Content-Type: application/jsonBody
{
"id": "1",
"email": "example@example.com",
"name": "John Doe"
}Email Verification ¶
This Group’s APIs are used for verifying user registrations
Resend Email Verification ¶
Get the email containing verification token again.
Get User Verification Token AgainPOST/v1/auth/resend-verification-email
Sends the token to verify the account associated with the provided email id via email.
Example URI
POST https://api.eventyay.com/v1/auth/resend-verification-email
Request
Headers
Content-Type: application/jsonBody
{
"data": {
"email": "open_event_test_user@fossasia.org"
}
}Response
200Headers
Content-Type: application/jsonBody
{
"message": "Verification email resent"
}Verify Email ¶
Verify the email via auth tokenPOST/v1/auth/verify-email
Verifies the user email via token.
Example URI
POST https://api.eventyay.com/v1/auth/verify-email
Request
Headers
Content-Type: application/jsonBody
{
"data": {
"token": "your token"
}
}Response
200Headers
Content-Type: application/jsonBody
{
"message": "Email Verified"
}Custom System Roles ¶
This Group’s APIs are used to list, create, delete or update Custom System Roles.
Custom System Roles Collections ¶
List All Custom System RolesGET/v1/custom-system-roles
Get a list of all Custom System Roles.
Example URI
GET https://api.eventyay.com/v1/custom-system-roles
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"jsonapi": {
"version": "1.0"
},
"meta": {
"count": 2
},
"links": {
"self": "/v1/custom-system-roles"
},
"data": [
{
"relationships": {
"panel-permissions": {
"links": {
"self": "/v1/custom-system-roles/1/relationships/panel-permissions",
"related": "/v1/custom-system-roles/1/panel-permissions"
}
}
},
"type": "custom-system-role",
"links": {
"self": "/v1/custom-system-roles/1"
},
"attributes": {
"name": "Sales Admin"
},
"id": "1"
},
{
"relationships": {
"panel-permissions": {
"links": {
"self": "/v1/custom-system-roles/2/relationships/panel-permissions",
"related": "/v1/custom-system-roles/2/panel-permissions"
}
}
},
"type": "custom-system-role",
"links": {
"self": "/v1/custom-system-roles/2"
},
"attributes": {
"name": "Marketer"
},
"id": "2"
}
]
}Create Custom System RolePOST/v1/custom-system-roles
Create a new custom system role using a name.
Example URI
POST https://api.eventyay.com/v1/custom-system-roles
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "Accountant"
},
"type": "custom-system-role"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/custom-system-roles/3"
},
"data": {
"relationships": {
"panel-permissions": {
"links": {
"self": "/v1/custom-system-roles/3/relationships/panel-permissions",
"related": "/v1/custom-system-roles/3/panel-permissions"
}
}
},
"type": "custom-system-role",
"links": {
"self": "/v1/custom-system-roles/3"
},
"attributes": {
"name": "Accountant"
},
"id": "3"
}
}Custom System Roles Details ¶
Get DetailsGET/v1/custom-system-roles/{custom_system_role_id}
Get a single custom system role.
Example URI
GET https://api.eventyay.com/v1/custom-system-roles/1
URI Parameters
- custom_system_role_id
integer(required) Example: 1ID of the custom system role in the form of an integer.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/custom-system-roles/1"
},
"data": {
"relationships": {
"panel-permissions": {
"links": {
"self": "/v1/custom-system-roles/1/relationships/panel-permissions",
"related": "/v1/custom-system-roles/1/panel-permissions"
}
}
},
"type": "custom-system-role",
"links": {
"self": "/v1/custom-system-roles/1"
},
"attributes": {
"name": "Marketer"
},
"id": "1"
}
}Update Custom System RolePATCH/v1/custom-system-roles/{custom_system_role_id}
id(integer) - ID of the record to update (required)
Update a single custom system role.
Example URI
PATCH https://api.eventyay.com/v1/custom-system-roles/1
URI Parameters
- custom_system_role_id
integer(required) Example: 1ID of the custom system role in the form of an integer.
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"name": "Manager"
},
"type": "custom-system-role",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"jsonapi": {
"version": "1.0"
},
"links": {
"self": "/v1/custom-system-roles/1"
},
"data": {
"relationships": {
"panel-permissions": {
"links": {
"self": "/v1/custom-system-roles/1/relationships/panel-permissions",
"related": "/v1/custom-system-roles/1/panel-permissions"
}
}
},
"type": "custom-system-role",
"links": {
"self": "/v1/custom-system-roles/1"
},
"attributes": {
"name": "Manager"
},
"id": "1"
}
}Delete Custom Systen RoleDELETE/v1/custom-system-roles/{custom_system_role_id}
Delete a single custom system.
Example URI
DELETE https://api.eventyay.com/v1/custom-system-roles/1
URI Parameters
- custom_system_role_id
integer(required) Example: 1ID of the custom system role in the form of an integer.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Get Custom System Role Details for a Panel Permission ¶
Get Custom System Role Details for a Panel PermissionGET/v1/panel-permissions/{panel_permission_id}/custom-system-roles
Get the details of the custom system roles for a panel permission.
Example URI
GET https://api.eventyay.com/v1/panel-permissions/1/custom-system-roles
URI Parameters
- panel_permission_id
integer(required) Example: 1ID of the panel permission in the form of an integer.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"jsonapi": {
"version": "1.0"
},
"meta": {
"count": 2
},
"links": {
"self": "/v1/custom-system-roles"
},
"data": [
{
"relationships": {
"panel-permissions": {
"links": {
"self": "/v1/custom-system-roles/1/relationships/panel-permissions",
"related": "/v1/custom-system-roles/1/panel-permissions"
}
}
},
"type": "custom-system-role",
"links": {
"self": "/v1/custom-system-roles/1"
},
"attributes": {
"name": "Sales Admin"
},
"id": "1"
},
{
"relationships": {
"panel-permissions": {
"links": {
"self": "/v1/custom-system-roles/3/relationships/panel-permissions",
"related": "/v1/custom-system-roles/3/panel-permissions"
}
}
},
"type": "custom-system-role",
"links": {
"self": "/v1/custom-system-roles/3"
},
"attributes": {
"name": "Accountant"
},
"id": "3"
}
]
}Panel Permissions ¶
This Group’s APIs are used to list, create, delete or update Panel Permissions.
Panel Permissions Collections ¶
List All Panel PermissionsGET/v1/panel-permissions
Get a list of all Panel Permissions.
Example URI
GET https://api.eventyay.com/v1/panel-permissions
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 10
},
"links": {
"self": "/v1/panel-permissions"
},
"data": [
{
"links": {
"self": "/v1/panel-permissions/1"
},
"id": "1",
"attributes": {
"can-access": true,
"panel-name": "sales"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/1/custom-system-roles",
"self": "/v1/panel-permissions/1/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
{
"links": {
"self": "/v1/panel-permissions/2"
},
"id": "2",
"attributes": {
"can-access": true,
"panel-name": "admin"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/2/custom-system-roles",
"self": "/v1/panel-permissions/2/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
{
"links": {
"self": "/v1/panel-permissions/3"
},
"id": "3",
"attributes": {
"can-access": true,
"panel-name": "events"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/3/custom-system-roles",
"self": "/v1/panel-permissions/3/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
{
"links": {
"self": "/v1/panel-permissions/4"
},
"id": "4",
"attributes": {
"can-access": true,
"panel-name": "sessions"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/4/custom-system-roles",
"self": "/v1/panel-permissions/4/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
{
"links": {
"self": "/v1/panel-permissions/5"
},
"id": "5",
"attributes": {
"can-access": true,
"panel-name": "users"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/5/custom-system-roles",
"self": "/v1/panel-permissions/5/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
{
"links": {
"self": "/v1/panel-permissions/6"
},
"id": "6",
"attributes": {
"can-access": true,
"panel-name": "permissions"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/6/custom-system-roles",
"self": "/v1/panel-permissions/6/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
{
"links": {
"self": "/v1/panel-permissions/7"
},
"id": "7",
"attributes": {
"can-access": true,
"panel-name": "messages"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/7/custom-system-roles",
"self": "/v1/panel-permissions/7/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
{
"links": {
"self": "/v1/panel-permissions/8"
},
"id": "8",
"attributes": {
"can-access": true,
"panel-name": "reports"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/8/custom-system-roles",
"self": "/v1/panel-permissions/8/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
{
"links": {
"self": "/v1/panel-permissions/9"
},
"id": "9",
"attributes": {
"can-access": true,
"panel-name": "settings"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/9/custom-system-roles",
"self": "/v1/panel-permissions/9/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
{
"links": {
"self": "/v1/panel-permissions/10"
},
"id": "10",
"attributes": {
"can-access": true,
"panel-name": "content"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/10/custom-system-roles",
"self": "/v1/panel-permissions/10/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
}
],
"jsonapi": {
"version": "1.0"
}
}Create Panel PermissionPOST/v1/panel-permissions
Create a new panel permission using a name.
Example URI
POST https://api.eventyay.com/v1/panel-permissions
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"can-access": true,
"panel-name": "marketing"
},
"type": "panel-permission"
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"self": "/v1/panel-permissions/1"
},
"data": {
"links": {
"self": "/v1/panel-permissions/1"
},
"id": "11",
"attributes": {
"can-access": true,
"panel-name": "marketing"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/1/custom-system-roles",
"self": "/v1/panel-permissions/1/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
"jsonapi": {
"version": "1.0"
}
}Panel Permission Details ¶
Get DetailsGET/v1/panel-permissions/{panel_permission_id}
Get a single panel permission.
Example URI
GET https://api.eventyay.com/v1/panel-permissions/1
URI Parameters
- panel_permission_id
integer(required) Example: 1ID of the panel permission in the form of an integer.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"self": "/v1/panel-permissions/1"
},
"data": {
"links": {
"self": "/v1/panel-permissions/1"
},
"id": "10",
"attributes": {
"can-access": true,
"panel-name": "content"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/1/custom-system-roles",
"self": "/v1/panel-permissions/1/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
"jsonapi": {
"version": "1.0"
}
}Update Panel PermissionPATCH/v1/panel-permissions/{panel_permission_id}
id(integer) - ID of the panel permission to update (required)
Update a single panel permission by setting the name and/or access type.
Example URI
PATCH https://api.eventyay.com/v1/panel-permissions/1
URI Parameters
- panel_permission_id
integer(required) Example: 1ID of the panel permission in the form of an integer.
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"attributes": {
"can-access": true,
"panel-name": "contents"
},
"type": "panel-permission",
"id": "1"
}
}Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"self": "/v1/panel-permissions/1"
},
"data": {
"links": {
"self": "/v1/panel-permissions/1"
},
"id": "1",
"attributes": {
"can-access": true,
"panel-name": "contents"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/1/custom-system-roles",
"self": "/v1/panel-permissions/1/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
},
"jsonapi": {
"version": "1.0"
}
}Delete Panel PermissionDELETE/v1/panel-permissions/{panel_permission_id}
Delete a single panel permission.
Example URI
DELETE https://api.eventyay.com/v1/panel-permissions/1
URI Parameters
- panel_permission_id
integer(required) Example: 1ID of the panel permission in the form of an integer.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Get Panel Permission Details for a Custom System Role ¶
Get Panel Permission Details for a Custom System RoleGET/v1/custom-system-roles/{custom_system_role_id}/panel-permissions
Get the details of the panel permission.
Example URI
GET https://api.eventyay.com/v1/custom-system-roles/1/panel-permissions
URI Parameters
- custom_system_role_id
integer(required) Example: 1ID of the custom system role in the form of an integer.
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"count": 1
},
"links": {
"self": "/v1/panel-permissions"
},
"data": [
{
"links": {
"self": "/v1/panel-permissions/1"
},
"id": "1",
"attributes": {
"can-access": true,
"panel-name": "sales"
},
"relationships": {
"custom-system-roles": {
"links": {
"related": "/v1/panel-permissions/1/custom-system-roles",
"self": "/v1/panel-permissions/1/relationships/custom-system-roles"
}
}
},
"type": "panel-permission"
}
],
"jsonapi": {
"version": "1.0"
}
}Favourite Events ¶
This Group’s APIs can be used for adding a particular event to the favourite list of the user.
Favourite Events Collection ¶
List All Favourite EventsGET/v1/user-favourite-events
Example URI
GET https://api.eventyay.com/v1/user-favourite-events
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "user-favourite-event",
"id": "1",
"relationships": {
"event": {
"links": {
"self": "/v1/user-favourite-events/1/relationships/event",
"related": "/v1/user-favourite-events/1/event"
}
},
"user": {
"links": {
"self": "/v1/user-favourite-events/1/relationships/user",
"related": "/v1/favourite-events/1/user"
}
}
},
"attributes": {
"deleted-at": null
},
"links": {
"self": "/v1/user-favourite-events/1"
}
}
],
"links": {
"self": "/v1/user-favourite-events"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}Create a Favourite EventPOST/v1/user-favourite-events
Example URI
POST https://api.eventyay.com/v1/user-favourite-events
Request
Headers
Authorization: JWT <Auth Key>
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "user-favourite-event",
"relationships": {
"event": {
"data": {
"id": "1",
"type": "event"
}
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "user-favourite-event",
"relationships": {
"user": {
"links": {
"self": "/v1/user-favourite-events/1/relationships/user",
"related": "/v1/favourite-events/1/user"
}
},
"event": {
"links": {
"self": "/v1/user-favourite-events/1/relationships/event",
"related": "/v1/user-favourite-events/1/event"
}
}
},
"attributes": {
"deleted-at": null
},
"id": "1",
"links": {
"self": "/v1/user-favourite-events/1"
}
},
"links": {
"self": "/v1/user-favourite-events/1"
},
"jsonapi": {
"version": "1.0"
}
}Favourite Events Detail ¶
Get DetailsGET/v1/user-favourite-events/{event_id}
Example URI
GET https://api.eventyay.com/v1/user-favourite-events/1
URI Parameters
- event_id
integer(required) Example: 1ID of the Event in the form of an integer
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"self": "/v1/user-favourite-events/1"
},
"jsonapi": {
"version": "1.0"
},
"data": {
"type": "user-favourite-event",
"links": {
"self": "/v1/user-favourite-events/1"
},
"id": "1",
"attributes": {
"deleted-at": null
},
"relationships": {
"user": {
"links": {
"related": "/v1/favourite-events/1/user",
"self": "/v1/user-favourite-events/1/relationships/user"
}
},
"event": {
"links": {
"related": "/v1/user-favourite-events/1/event",
"self": "/v1/user-favourite-events/1/relationships/event"
}
}
}
}
}Delete Favourite EventDELETE/v1/user-favourite-events/{event_id}
Example URI
DELETE https://api.eventyay.com/v1/user-favourite-events/1
URI Parameters
- event_id
integer(required) Example: 1ID of the Event in the form of an integer
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Favourite Sessions ¶
This Group’s APIs can be used for adding a particular session to the favourite list of the user.
Favourite Sessions Collection ¶
Create a Favourite SessionPOST/v1/user-favourite-sessions
Example URI
POST https://api.eventyay.com/v1/user-favourite-sessions
Request
Headers
Authorization: JWT <Auth Key>
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "user-favourite-session",
"relationships": {
"session": {
"data": {
"id": "1",
"type": "session"
}
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "user-favourite-session",
"relationships": {
"user": {
"links": {
"self": "/v1/user-favourite-sessions/1/relationships/user",
"related": "/v1/favourite-sessions/1/user"
}
},
"session": {
"links": {
"self": "/v1/user-favourite-sessions/1/relationships/session",
"related": "/v1/user-favourite-sessions/1/session"
}
}
},
"id": "1",
"links": {
"self": "/v1/user-favourite-sessions/1"
}
},
"links": {
"self": "/v1/user-favourite-sessions/1"
},
"jsonapi": {
"version": "1.0"
}
}Favourite Sessions Collection List ¶
List All Favourite Sessions of an UserGET/v1/users/1/user-favourite-sessions
Example URI
GET https://api.eventyay.com/v1/users/1/user-favourite-sessions
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "user-favourite-session",
"id": "1",
"relationships": {
"session": {
"links": {
"self": "/v1/user-favourite-sessions/1/relationships/session",
"related": "/v1/user-favourite-sessions/1/session"
}
},
"user": {
"links": {
"self": "/v1/user-favourite-sessions/1/relationships/user",
"related": "/v1/favourite-sessions/1/user"
}
}
},
"links": {
"self": "/v1/user-favourite-sessions/1"
}
}
],
"links": {
"self": "/v1/user-favourite-sessions"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}Favourite Sessions Collection List ¶
List All Favourite Sessions of a SessionGET/v1/sessions/1/user-favourite-sessions
Example URI
GET https://api.eventyay.com/v1/sessions/1/user-favourite-sessions
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "user-favourite-session",
"id": "1",
"relationships": {
"session": {
"links": {
"self": "/v1/user-favourite-sessions/1/relationships/session",
"related": "/v1/user-favourite-sessions/1/session"
}
},
"user": {
"links": {
"self": "/v1/user-favourite-sessions/1/relationships/user",
"related": "/v1/favourite-sessions/1/user"
}
}
},
"links": {
"self": "/v1/user-favourite-sessions/1"
}
}
],
"links": {
"self": "/v1/user-favourite-sessions"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}Favourite Sessions Collection List ¶
List All Favourite Sessions of an EventGET/v1/events/1/user-favourite-sessions
Example URI
GET https://api.eventyay.com/v1/events/1/user-favourite-sessions
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "user-favourite-session",
"id": "1",
"relationships": {
"session": {
"links": {
"self": "/v1/user-favourite-sessions/1/relationships/session",
"related": "/v1/user-favourite-sessions/1/session"
}
},
"user": {
"links": {
"self": "/v1/user-favourite-sessions/1/relationships/user",
"related": "/v1/favourite-sessions/1/user"
}
}
},
"links": {
"self": "/v1/user-favourite-sessions/1"
}
}
],
"links": {
"self": "/v1/user-favourite-sessions"
},
"meta": {
"count": 1
},
"jsonapi": {
"version": "1.0"
}
}Favourite Sessions Detail ¶
Get DetailsGET/v1/user-favourite-sessions/{session_id}
Example URI
GET https://api.eventyay.com/v1/user-favourite-sessions/1
URI Parameters
- session_id
integer(required) Example: 1ID of the Session in the form of an integer
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"links": {
"self": "/v1/user-favourite-sessions/1"
},
"jsonapi": {
"version": "1.0"
},
"data": {
"type": "user-favourite-session",
"links": {
"self": "/v1/user-favourite-sessions/1"
},
"id": "1",
"relationships": {
"user": {
"links": {
"related": "/v1/favourite-sessions/1/user",
"self": "/v1/user-favourite-sessions/1/relationships/user"
}
},
"session": {
"links": {
"related": "/v1/user-favourite-sessions/1/session",
"self": "/v1/user-favourite-sessions/1/relationships/session"
}
}
}
}
}Delete Favourite SessionDELETE/v1/user-favourite-sessions/{session_id}
Example URI
DELETE https://api.eventyay.com/v1/user-favourite-sessions/1
URI Parameters
- session_id
integer(required) Example: 1ID of the Session in the form of an integer
Request
Headers
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"meta": {
"message": "Object successfully deleted"
},
"jsonapi": {
"version": "1.0"
}
}Import Jobs ¶
This Group’s APIs are used for getting info of import jobs
Import Jobs Collection ¶
List All Import JobsGET/v1/import-jobs
Get a list of all import jobs
Example URI
GET https://api.eventyay.com/v1/import-jobs
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [
{
"type": "import-job",
"attributes": {
"starts-at": "2019-03-26T07:34:23.061153+00:00",
"result": "1",
"task": "a8e8b899-7537-4d09-bcd5-fd250a3efc06",
"result-status": "SUCCESS"
},
"id": "1",
"links": {
"self": "/v1/import-jobs/1"
}
},
{
"type": "import-job",
"attributes": {
"starts-at": "2019-03-26T07:47:31.285576+00:00",
"result": "2",
"task": "788ae813-1fcf-4c47-ab4a-80ff33abd097",
"result-status": "SUCCESS"
},
"id": "2",
"links": {
"self": "/v1/import-jobs/2"
}
}
],
"links": {
"self": "/v1/import-jobs"
},
"meta": {
"count": 2
},
"jsonapi": {
"version": "1.0"
}
}Video Streams ¶
Data related to video streams table
| Parameter | Description | Type | Required | Public |
|---|---|---|---|---|
name |
Name of Video Stream | string | yes | yes |
url |
URL of Video Stream | Url | yes | yes |
password |
Password of video stream | string | - | - |
additional_information |
Addition Description about Video Stream | string | - | - |
extra |
Extra options on video streams like autoplay, loop or bbb_options | - | - | - |
Video streams ¶
List all Video StreamsGET/v1/video-streams{?sort,filter}
Get a list of all Video Streams
Example URI
GET https://api.eventyay.com/v1/video-streams?sort=url&filter=[]
URI Parameters
- page[size]
integer(optional) Example: 10- page[number]
integer(optional) Example: 2- sort
string(optional) Example: url- filter
string(optional) Example: []
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [],
"links": {
"self": "/v1/video-streams?page%5Bsize%5D=10&page%5Bnumber%5D=2&sort=url&filter=%5B%5D"
},
"meta": {
"count": 0
},
"jsonapi": {
"version": "1.0"
}
}Badge Forms ¶
Badge Forms related to the events.
| Parameter | Description | Type | Required |
|---|---|---|---|
badge-color |
Badge Color | string | - |
badge-size |
Badge Size | string | - |
badge-id |
Badge Id | string | yes |
badge-image-url |
Badge Image Url | String | - |
badge-orientation |
Badge Orientation | String | - |
Get Badge Form By Ticket ¶
Get Badge Form By TicketGET/v1/tickets/{ticket_id}/badge-forms
Get badge form.
Example URI
GET https://api.eventyay.com/v1/tickets/1/badge-forms
URI Parameters
- ticket_id
integer(required) Example: 1ID of the ticket in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
[
{
"custom_field": "example",
"field_identifier": "example",
"id": 1
}
]Station Store Paxs ¶
Create Station Store Paxs ¶
Create Station Store PaxsPOST/v1/station-store-paxs
Create station store paxs.
Example URI
POST https://api.eventyay.com/v1/station-store-paxs
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "station-store-pax",
"relationships": {
"station": {
"data": {
"type": "station",
"id": "1"
}
},
"session": {
"data": {
"type": "session",
"id": "1"
}
}
},
"attributes": {
"current_pax": "10"
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "station-store-pax",
"relationships": {
"session": {
"links": {
"self": "/v1/station-store-paxs/1/relationships/session",
"related": "/v1/sessions/1"
}
},
"station": {
"links": {
"self": "/v1/station-store-paxs/1/relationships/station",
"related": "/v1/stations/1"
}
}
},
"attributes": {
"current-pax": 10,
"modified-at": "2023-07-28T04:30:48.251435+00:00",
"created-at": "2023-07-28T04:30:48.251430+00:00"
},
"id": 1,
"links": {
"self": "/v1/station-store-paxs/1"
}
},
"links": {
"self": "/v1/station-store-paxs/1"
},
"jsonapi": {
"version": "1.0"
}
}Get Station Store Paxs By Station and Session ¶
Get Station Store Paxs By Station and SessionGET/v1/stations/{station_id}/sessions/{session_id}/station-store-paxs
Get station store paxs By station and session.
Example URI
GET https://api.eventyay.com/v1/stations/1/sessions/1/station-store-paxs
URI Parameters
- station_id
integer(required) Example: 1ID of the station in the form of an integer
- session_id
integer(required) Example: 1ID of the session in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [],
"links": {
"self": "/v1/stations/1/sessions/1/station-store-paxs"
},
"meta": {
"count": 0
},
"jsonapi": {
"version": "1.0"
}
}Stations ¶
Create Station ¶
Create StationPOST/v1/station
Create station.
Example URI
POST https://api.eventyay.com/v1/station
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "station",
"attributes": {
"station-name": "station name",
"station-type": "registration"
},
"relationships": {
"event": {
"data": {
"id": "1",
"type": "event"
}
},
"microlocation": {
"data": {
"id": "1",
"type": "microlocation"
}
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "station",
"relationships": {
"event": {
"links": {
"self": "/v1/station/1/relationships/event",
"related": "/v1/station/1"
}
},
"microlocation": {
"links": {
"self": "/v1/station/1/relationships/microlocation",
"related": "/v1/station/1"
}
}
},
"attributes": {
"station-name": "station name",
"station-type": "registration"
},
"id": 1,
"links": {
"self": "/v1/station/1"
}
},
"links": {
"self": "/v1/station/1"
},
"jsonapi": {
"version": "1.0"
}
}Get Station ¶
Get StationGET/v1/stations/{station_id}
Get station.
Example URI
GET https://api.eventyay.com/v1/stations/1
URI Parameters
- station_id
integer(required) Example: 1ID of the station in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "station",
"attributes": {
"station-type": "example",
"station-name": "example"
},
"relationships": {
"event": {
"links": {
"self": "/v1/stations/1/relationships/event",
"related": "/v1/events/1"
}
},
"microlocation": {
"links": {
"self": "/v1/stations/1/relationships/microlocation"
}
}
},
"id": 1,
"links": {
"self": "/v1/stations/1"
}
},
"links": {
"self": "/v1/stations/1"
},
"jsonapi": {
"version": "1.0"
}
}Get Stations by Event ¶
Get Stations by EventGET/v1/events/{event_id}/stations
Get Stations by event.
Example URI
GET https://api.eventyay.com/v1/events/1/stations
URI Parameters
- event_id
integer(required) Example: 1ID of the station in the form of an integer
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/vnd.api+jsonBody
{
"data": [],
"links": {
"self": "/v1/events/1/stations"
},
"meta": {
"count": 0
},
"jsonapi": {
"version": "1.0"
}
}Users Check In ¶
For using the API you need(mostly) to register as an user check in. Registering gives you access to all non admin API endpoints. After registration, you need to create your JWT access token to send requests to the API endpoints.
Get Registration Stats ¶
Get Registration StatsGET/v1/user-check-in/stats/event/{event_id}?session_ids=1
Get registration stats.
Example URI
GET https://api.eventyay.com/v1/user-check-in/stats/event/1?session_ids=1
URI Parameters
- event_id
integer(required) Example: 1ID of the event in the form of an integer
Request
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>Response
200Headers
Content-Type: application/jsonBody
{
"session_stats": [
{
"check_in": 0,
"check_out": 0,
"manual_count": {},
"session_id": "1",
"session_name": "example",
"speakers": [],
"track_name": "example"
}
],
"total_attendee": 0,
"total_not_checked_in": 0,
"total_registered": 0,
"total_session_checked_in": 0,
"total_session_checked_out": 0,
"total_track_checked_in": 0,
"total_track_checked_out": 0,
"track_stats": []
}Create User Check In ¶
Create User Check InPOST/v1/user-check-in
Create User Check In.
Example URI
POST https://api.eventyay.com/v1/user-check-in
Request
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>Body
{
"data": {
"type": "user_check_in",
"attributes": {},
"relationships": {
"station": {
"data": {
"id": "1",
"type": "station"
}
},
"session": {
"data": {
"id": "1",
"type": "session"
}
},
"ticket_holder": {
"data": {
"id": "1",
"type": "attendee"
}
}
}
}
}Response
201Headers
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "user_check_in",
"attributes": {
"message": "Ticket register successful.",
"success": true
},
"id": 1,
"links": {
"self": "/v1/user-check-in/1"
}
},
"links": {
"self": "/v1/user-check-in/1"
},
"jsonapi": {
"version": "1.0"
}
}
Social Links ¶
You can add various social links such as facebook, twitter, website, blog link, etc. related to the event.
namelinkSocial Links Post Collection ¶
/v1/social-links{?sort,filter}Create a new social link using event_id.
Example URI
integer(optional) Example: 10integer(optional) Example: 2string(optional) Example: namestring(optional) Example: []Headers
Content-Type: application/vnd.api+jsonAuthorization: JWT <Auth Key>
Body
{ "data": { "relationships": { "event": { "data": { "type": "event", "id": "1" } } }, "attributes": { "name": "Facebook Url", "link": "http://facebook.com/facebook", "identifier": "example" }, "type": "social-link" } }201Headers
Content-Type: application/vnd.api+jsonBody
{ "data": { "relationships": { "event": { "links": { "self": "/v1/social-links/1/relationships/event", "related": "/v1/social-links/1/event" } } }, "attributes": { "link": "http://facebook.com/facebook", "deleted-at": null, "name": "Facebook Url", "identifier": "example" }, "type": "social-link", "id": "1", "links": { "self": "/v1/social-links/1" } }, "jsonapi": { "version": "1.0" }, "links": { "self": "/v1/social-links/1" } }Social Links Get Collection ¶
/v1/events/{event_identifier}/social-links{?sort,filter}Get a list of Social Links.
Example URI
string(required) Example: 1identifier or event id of the event. (b8324ae2 is an example of identifier)
integer(optional) Example: 10integer(optional) Example: 2string(optional) Example: namestring(optional) Example: []Headers
Accept: application/vnd.api+jsonAuthorization: JWT <Auth Key>
200Headers
Content-Type: application/vnd.api+jsonBody
{ "meta": { "count": 1 }, "data": [ { "relationships": { "event": { "links": { "self": "/v1/social-links/1/relationships/event", "related": "/v1/social-links/1/event" } } }, "attributes": { "link": "http://facebook.com/facebook", "deleted-at": null, "name": "Facebook Url", "identifier": "example" }, "type": "social-link", "id": "1", "links": { "self": "/v1/social-links/1" } } ], "jsonapi": { "version": "1.0" }, "links": { "self": "/v1/events/1/social-links" } }Social Links ¶
/v1/social-links/{link_id}Example URI
integer(required) Example: 1ID of the Social Link in the form of an integer
Headers
Accept: application/vnd.api+jsonAuthorization: JWT <Auth Key>
200Headers
Content-Type: application/vnd.api+jsonBody
{ "data": { "relationships": { "event": { "links": { "self": "/v1/social-links/1/relationships/event", "related": "/v1/social-links/1/event" } } }, "attributes": { "link": "http://facebook.com/facebook", "deleted-at": null, "name": "Facebook Url", "identifier": "example" }, "type": "social-link", "id": "1", "links": { "self": "/v1/social-links/1" } }, "jsonapi": { "version": "1.0" }, "links": { "self": "/v1/social-links/1" } }/v1/social-links/{link_id}Update a single social link by
id.id(integer) - ID of the record to update (required)Example URI
integer(required) Example: 1ID of the Social Link in the form of an integer
Headers
Content-Type: application/vnd.api+jsonAuthorization: JWT <Auth Key>
Body
{ "data": { "attributes": { "name": "Facebook Page Url", "link": "http://facebook.com/facebook", "identifier": "example" }, "type": "social-link", "id": "1" } }200Headers
Content-Type: application/vnd.api+jsonBody
{ "data": { "relationships": { "event": { "links": { "self": "/v1/social-links/1/relationships/event", "related": "/v1/social-links/1/event" } } }, "attributes": { "link": "http://facebook.com/facebook", "deleted-at": null, "name": "Facebook Page Url", "identifier": "example" }, "type": "social-link", "id": "1", "links": { "self": "/v1/social-links/1" } }, "jsonapi": { "version": "1.0" }, "links": { "self": "/v1/social-links/1" } }/v1/social-links/{link_id}Delete a single social link.
Example URI
integer(required) Example: 1ID of the Social Link in the form of an integer
Headers
Accept: application/vnd.api+jsonAuthorization: JWT <Auth Key>
200Headers
Content-Type: application/vnd.api+jsonBody
{ "meta": { "message": "Object successfully deleted" }, "jsonapi": { "version": "1.0" } }