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":