Back to top

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 token
POST/auth/session

Example URI

POST https://api.eventyay.com/auth/session
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "email": "email@example.com",
  "password": "password"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZGVudGl0eSI6MSwiaWF0IjoxNDk2OTU2ODMwLCJuYmYiOjE0OTY5NTY4MzAsImV4cCI6MTQ5NzA0MzIzMH0.bjl0"
}

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 Users
GET/v1/users{?sort,filter}

Get a list of Users.

Example URI

GET https://api.eventyay.com/v1/users?sort=email&filter=
URI Parameters
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: email
filter
string (optional) 
Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "count": 1
  },
  "data": [
    {
      "relationships": {
        "events": {
          "links": {
            "self": "/v1/users/3/relationships/events",
            "related": "/v1/users/3/events"
          }
        },
        "attendees": {
          "links": {
            "self": "/v1/users/3/relationships/attendees",
            "related": "/v1/users/3/attendees"
          }
        },
        "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"
          }
        },
        "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,
        "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"
      },
      "type": "user",
      "id": "2",
      "links": {
        "self": "/v1/users/2"
      }
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/users"
  }
}

Create User
POST/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
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: email
filter
string (optional) 
Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "email": "example@example.com",
      "password": "password",
      "avatar_url": "http://example.com/example.png",
      "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  201
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "events": {
        "links": {
          "self": "/v1/users/3/relationships/events",
          "related": "/v1/users/3/events"
        }
      },
      "attendees": {
        "links": {
          "self": "/v1/users/3/relationships/attendees",
          "related": "/v1/users/3/attendees"
        }
      },
      "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"
        }
      },
      "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,
      "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"
    },
    "type": "user",
    "id": "2",
    "links": {
      "self": "/v1/users/2"
    }
  }
}

User Details

Get Details
GET/v1/users/{user_id}

Get a single user.

Example URI

GET https://api.eventyay.com/v1/users/2
URI Parameters
HideShow
user_id
integer (required) Example: 2

ID of the user in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "events": {
        "links": {
          "self": "/v1/users/3/relationships/events",
          "related": "/v1/users/3/events"
        }
      },
      "attendees": {
        "links": {
          "self": "/v1/users/3/relationships/attendees",
          "related": "/v1/users/3/attendees"
        }
      },
      "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"
        }
      },
      "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,
      "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"
    },
    "type": "user",
    "id": "2",
    "links": {
      "self": "/v1/users/2"
    }
  }
}

Update User
PATCH/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
HideShow
user_id
integer (required) Example: 2

ID of the user in the form of an integer

Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "password": "password",
      "avatar_url": "http://example.com/example.png",
      "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",
      "thumbnail-image-url": "http://example.com/example.png",
      "small-image-url": "http://example.com/example.png",
      "icon-image-url": "http://example.com/example.png"
    },
    "type": "user",
    "id": "2"
  }
}
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "events": {
        "links": {
          "self": "/v1/users/3/relationships/events",
          "related": "/v1/users/3/events"
        }
      },
      "attendees": {
        "links": {
          "self": "/v1/users/3/relationships/attendees",
          "related": "/v1/users/3/attendees"
        }
      },
      "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"
        }
      },
      "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,
      "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"
    },
    "type": "user",
    "id": "2",
    "links": {
      "self": "/v1/users/2"
    }
  }
}

Delete User
DELETE/v1/users/{user_id}

Delete a single user.

Example URI

DELETE https://api.eventyay.com/v1/users/2
URI Parameters
HideShow
user_id
integer (required) Example: 2

ID of the user in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "message": "Object successfully deleted"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Get User Details for a Notification

Get User Details for a Notification
GET/v1/notifications/{notification_id}/user

Get the details of the user.

Example URI

GET https://api.eventyay.com/v1/notifications/1/user
URI Parameters
HideShow
notification_id
integer (required) Example: 1

ID of the notification in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "email-notifications": {
        "links": {
          "self": "/v1/users/1/relationships/email-notifications",
          "related": "/v1/users/1/email-notifications"
        }
      },
      "notifications": {
        "links": {
          "self": "/v1/users/1/relationships/notifications",
          "related": "/v1/users/1/notifications"
        }
      },
      "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,
      "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
    },
    "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 Invoice
GET/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
HideShow
event_invoice_id
integer (required) Example: 1

ID of the event invoice in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "email-notifications": {
        "links": {
          "self": "/v1/users/1/relationships/email-notifications",
          "related": "/v1/users/1/email-notifications"
        }
      },
      "notifications": {
        "links": {
          "self": "/v1/users/1/relationships/notifications",
          "related": "/v1/users/1/notifications"
        }
      },
      "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,
      "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
    },
    "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 Speaker
GET/v1/speakers/{speaker_id}/user

Get the details of the user.

Example URI

GET https://api.eventyay.com/v1/speakers/1/user
URI Parameters
HideShow
speaker_id
integer (required) Example: 1

ID of the speaker in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "email-notifications": {
        "links": {
          "self": "/v1/users/1/relationships/email-notifications",
          "related": "/v1/users/1/email-notifications"
        }
      },
      "notifications": {
        "links": {
          "self": "/v1/users/1/relationships/notifications",
          "related": "/v1/users/1/notifications"
        }
      },
      "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,
      "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
    },
    "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 Code
GET/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
HideShow
access_code_id
integer (required) Example: 1

ID of the access code in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "email-notifications": {
        "links": {
          "self": "/v1/users/1/relationships/email-notifications",
          "related": "/v1/users/1/email-notifications"
        }
      },
      "notifications": {
        "links": {
          "self": "/v1/users/1/relationships/notifications",
          "related": "/v1/users/1/notifications"
        }
      },
      "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,
      "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
    },
    "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 Notification
GET/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
HideShow
email_notification_id
integer (required) Example: 1

ID of the email notification in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "email-notifications": {
        "links": {
          "self": "/v1/users/1/relationships/email-notifications",
          "related": "/v1/users/1/email-notifications"
        }
      },
      "notifications": {
        "links": {
          "self": "/v1/users/1/relationships/notifications",
          "related": "/v1/users/1/notifications"
        }
      },
      "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,
      "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
    },
    "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 Code
GET/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
HideShow
discount_code_id
integer (required) Example: 1

ID of the discount code in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "email-notifications": {
        "links": {
          "self": "/v1/users/1/relationships/email-notifications",
          "related": "/v1/users/1/email-notifications"
        }
      },
      "notifications": {
        "links": {
          "self": "/v1/users/1/relationships/notifications",
          "related": "/v1/users/1/notifications"
        }
      },
      "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,
      "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
    },
    "type": "user",
    "id": "1",
    "links": {
      "self": "/v1/users/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/users/1"
  }
}

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 Types
GET/v1/event-types{?sort}

Get a list of Event Types.

Example URI

GET https://api.eventyay.com/v1/event-types?sort=name
URI Parameters
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: name
Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Type
POST/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
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: name
Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "name": "Camp, Treat & Retreat"
    },
    "type": "event-type"
  }
}
Response  201
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Details
GET/v1/event-types/{event_type_id}

Get a single event type.

Example URI

GET https://api.eventyay.com/v1/event-types/1
URI Parameters
HideShow
event_type_id
integer (required) Example: 1

ID of the event type in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Type
PATCH/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
HideShow
event_type_id
integer (required) Example: 1

ID of the event type in the form of an integer

Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "name": "Camp, Treat & Retreat"
    },
    "type": "event-type",
    "id": "1"
  }
}
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Type
DELETE/v1/event-types/{event_type_id}

Delete a single event type.

Example URI

DELETE https://api.eventyay.com/v1/event-types/1
URI Parameters
HideShow
event_type_id
integer (required) Example: 1

ID of the event type in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "message": "Object successfully deleted"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Event Type of an Event

Event Type Details of an Event
GET/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
HideShow
event_identifier
string (required) Example: 1

identifier or event id of the event. (b8324ae2 is an example of identifier)

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 -

Event Topics Collection

List All Event Topics
GET/v1/event-topics{?sort}

Get a list of Event Topics.

Example URI

GET https://api.eventyay.com/v1/event-topics?sort=name
URI Parameters
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: name
Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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"
      },
      "type": "event-topic",
      "id": "1",
      "links": {
        "self": "/v1/event-topics/1"
      }
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/event-topics"
  }
}

Create Event Topic
POST/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
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: name
Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "name": "Travel & Outdoor"
    },
    "type": "event-topic"
  }
}
Response  201
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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"
    },
    "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 Details
GET/v1/event-topics/{event_topic_id}

Get a single event topic.

Example URI

GET https://api.eventyay.com/v1/event-topics/1
URI Parameters
HideShow
event_topic_id
integer (required) Example: 1

ID of the event topic in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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"
    },
    "type": "event-topic",
    "id": "1",
    "links": {
      "self": "/v1/event-topics/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/event-topics/1"
  }
}

Update Event Topic
PATCH/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
HideShow
event_topic_id
integer (required) Example: 1

ID of the event topic in the form of an integer

Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "name": "Travel & Outdoor"
    },
    "type": "event-topic",
    "id": "1"
  }
}
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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"
    },
    "type": "event-type",
    "id": "1",
    "links": {
      "self": "/v1/event-topics/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/event-topics/1"
  }
}

Delete Event Topic
DELETE/v1/event-topics/{event_topic_id}

Delete a single event topic.

Example URI

DELETE https://api.eventyay.com/v1/event-topics/1
URI Parameters
HideShow
event_topic_id
integer (required) Example: 1

ID of the event topic in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "message": "Object successfully deleted"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Event Topic of an Event

Event Topic Details of an Event
GET/v1/events/{event_identifier}/event-topic

Example URI

GET https://api.eventyay.com/v1/events/1/event-topic
URI Parameters
HideShow
event_identifier
string (required) Example: 1

identifier or event id of the event. (b8324ae2 is an example of identifier)

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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"
    },
    "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 Topic
GET/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
HideShow
event_sub_topic_id
integer (required) Example: 1

ID of the event sub topic in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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"
    },
    "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 Topics
GET/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
HideShow
event_topic_id
integer (required) Example: 1

ID of the event topic.

page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: name
Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Topic
POST/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
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: name
Request
HideShow
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  201
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Details
GET/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
HideShow
event_sub_topic_id
integer (required) Example: 1

ID of the event sub topic in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Topic
PATCH/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
HideShow
event_sub_topic_id
integer (required) Example: 1

ID of the event sub topic in the form of an integer

Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "name": "Climbing"
    },
    "type": "event-sub-topic",
    "id": "1"
  }
}
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Topic
DELETE/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
HideShow
event_sub_topic_id
integer (required) Example: 1

ID of the event sub topic in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "message": "Object successfully deleted"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Event Sub Topic of an Event

Event Sub Topic Details of an Event
GET/v1/events/{event_identifier}/event-sub-topic

Example URI

GET https://api.eventyay.com/v1/events/1/event-sub-topic
URI Parameters
HideShow
event_identifier
string (required) Example: 1

identifier or event id of the event. (b8324ae2 is an example of identifier)

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Placeholder
GET/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
HideShow
custom_placeholder_id
integer (required) Example: 1

ID of the Custom Placeholder in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Placeholders
GET/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
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: name
filter
string (optional) Example: []
Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Placeholder
POST/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
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: name
filter
string (optional) Example: []
Request
HideShow
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  201
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Details
GET/v1/custom-placeholders/{id}

Example URI

GET https://api.eventyay.com/v1/custom-placeholders/1
URI Parameters
HideShow
id
integer (required) Example: 1

ID of the Custom Placeholder in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Placeholder
PATCH/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
HideShow
id
integer (required) Example: 1

ID of the Custom Placeholder in the form of an integer

Request
HideShow
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  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 Placeholder
DELETE/v1/custom-placeholders/{id}

Delete a single resource.

Example URI

DELETE https://api.eventyay.com/v1/custom-placeholders/1
URI Parameters
HideShow
id
integer (required) Example: 1

ID of the Custom Placeholder in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "message": "Object successfully deleted"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Custom Placeholder Details of Event Sub-topic

Custom Placeholder Details of Event Sub-topic
GET/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
HideShow
event_sub_topic_id
integer (required) Example: 1

ID of the event sub-topic in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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 -
organizer-name Name of the event organizer string -
organizer-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 -
is-ticketing-enabled Does the event use Open Event ticketing system boolean (default: true) -
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-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-organizer-info - boolean(default: false) -

Events Collection

List All Events
GET/v1/events{?sort,filter}

Get a list of events.

Example URI

GET https://api.eventyay.com/v1/events?sort=identifier&filter=[]
URI Parameters
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: identifier
filter
string (optional) Example: []
Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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"
          }
        },
        "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",
        "organizer-description": "example",
        "is-map-shown": true,
        "original-image-url": "http://example.com/example.png",
        "onsite-details": "example",
        "organizer-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-organizer-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",
        "is-ticketing-enabled": true,
        "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,
        "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"
      },
      "type": "event",
      "id": "1",
      "links": {
        "self": "/v1/events/1"
      }
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/events"
  }
}

Create Event
POST/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
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: identifier
filter
string (optional) Example: []
Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "name": "example",
      "external-event-url": "http://example.com",
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "ends-at": "2016-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",
      "organizer-name": "example",
      "is-map-shown": "true",
      "organizer-description": "example",
      "is-sessions-speakers-enabled": "true",
      "privacy": "public",
      "state": "draft",
      "ticket-url": "http://example.com",
      "code-of-conduct": "example",
      "is-ticketing-enabled": "true",
      "payment-country": "US",
      "payment-currency": "USD",
      "paypal-email": "example@example.com",
      "is-tax-enabled": "true",
      "can-pay-by-paypal": "true",
      "can-pay-by-stripe": "true",
      "can-pay-by-cheque": "true",
      "can-pay-by-bank": "true",
      "can-pay-onsite": "true",
      "cheque-details": "example",
      "bank-details": "example",
      "onsite-details": "example",
      "is-sponsors-enabled": "false",
      "has-organizer-info": "false"
    },
    "type": "event"
  }
}
Response  201
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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"
        }
      },
      "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "http://example.com/example.png",
      "onsite-details": "example",
      "organizer-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-organizer-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",
      "is-ticketing-enabled": true,
      "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,
      "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"
    },
    "type": "event",
    "id": "1",
    "links": {
      "self": "/v1/events/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/events/1"
  }
}

Event Details

Event Details
GET/v1/events/{event_identifier}

Get a single event.

Example URI

GET https://api.eventyay.com/v1/events/1
URI Parameters
HideShow
event_identifier
string (required) Example: 1

identifier or event id of the event. (b8324ae2 is an example of identifier)

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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"
        }
      },
      "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "http://example.com/example.png",
      "onsite-details": "example",
      "organizer-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-organizer-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",
      "is-ticketing-enabled": true,
      "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,
      "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"
    },
    "type": "event",
    "id": "1",
    "links": {
      "self": "/v1/events/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/events/1"
  }
}

Update Event
PATCH/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
HideShow
event_identifier
string (required) Example: 1

identifier or event id of the event. (b8324ae2 is an example of identifier)

Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "name": "example1",
      "external-event-url": "http://example11.com",
      "starts-at": "2016-12-14T23:59:59.123456+05:30",
      "ends-at": "2016-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",
      "organizer-name": "example1",
      "is-map-shown": "false",
      "organizer-description": "example1",
      "is-sessions-speakers-enabled": "false",
      "privacy": "private",
      "state": "published",
      "ticket-url": "http://example1.com",
      "code-of-conduct": "example1",
      "is-ticketing-enabled": "false",
      "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-onsite": "false",
      "cheque-details": "example1",
      "bank-details": "example1",
      "onsite-details": "example1",
      "is-sponsors-enabled": "false",
      "has-organizer-info": "false"
    },
    "id": "1",
    "type": "event"
  }
}
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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"
        }
      },
      "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": "example1@example1.com",
      "thumbnail-image-url": null,
      "schedule-published-on": null,
      "payment-currency": "USD",
      "organizer-description": "example1",
      "is-map-shown": false,
      "original-image-url": "http://example1.com/example1.png",
      "onsite-details": "example1",
      "organizer-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-organizer-info": false,
      "is-sessions-speakers-enabled": false,
      "privacy": "private",
      "code-of-conduct": "example1",
      "state": "published",
      "latitude": 12.23456789,
      "starts-at": "2016-12-14T18:29:59.123456+00:00",
      "searchable-location-name": "example1",
      "is-ticketing-enabled": false,
      "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"
    },
    "type": "event",
    "id": "1",
    "links": {
      "self": "/v1/events/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/events/1"
  }
}

Delete Event
DELETE/v1/events/{event_identifier}

Delete a single event.

Example URI

DELETE https://api.eventyay.com/v1/events/1
URI Parameters
HideShow
event_identifier
string (required) Example: 1

identifier or event id of the event. (b8324ae2 is an example of identifier)

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "message": "Object successfully deleted"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Events of an Event Type

List All Events of an Event Type
GET/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
HideShow
event_type_id
integer (required) Example: 1

ID 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
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
        "organizer-description": "example",
        "is-map-shown": true,
        "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
        "onsite-details": "example",
        "organizer-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-organizer-info": false,
        "state": "draft",
        "latitude": 1.23456789,
        "starts-at": "2016-12-13T23:59:59.123456+00:00",
        "searchable-location-name": "Draft",
        "is-ticketing-enabled": true,
        "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"
      },
      "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 Topic
GET/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
HideShow
event_topic_id
integer (required) Example: 1

ID 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
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
        "organizer-description": "example",
        "is-map-shown": true,
        "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
        "onsite-details": "example",
        "organizer-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-organizer-info": false,
        "state": "draft",
        "latitude": 1.23456789,
        "starts-at": "2016-12-13T23:59:59.123456+00:00",
        "searchable-location-name": "Draft",
        "is-ticketing-enabled": true,
        "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"
      },
      "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-topic
GET/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
HideShow
event_sub_topic_id
integer (required) Example: 1

ID 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
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
        "organizer-description": "example",
        "is-map-shown": true,
        "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
        "onsite-details": "example",
        "organizer-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-organizer-info": false,
        "state": "draft",
        "latitude": 1.23456789,
        "starts-at": "2016-12-13T23:59:59.123456+00:00",
        "searchable-location-name": "Draft",
        "is-ticketing-enabled": true,
        "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"
      },
      "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 User
GET/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
HideShow
user_id
integer (required) Example: 1

ID 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
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
        "organizer-description": "example",
        "is-map-shown": true,
        "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
        "onsite-details": "example",
        "organizer-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-organizer-info": false,
        "state": "draft",
        "latitude": 1.23456789,
        "starts-at": "2016-12-13T23:59:59.123456+00:00",
        "searchable-location-name": "Draft",
        "is-ticketing-enabled": true,
        "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"
      },
      "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 Code
GET/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
HideShow
discount_code_id
integer (required) Example: 1

ID 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
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
        "organizer-description": "example",
        "is-map-shown": true,
        "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
        "onsite-details": "example",
        "organizer-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-organizer-info": false,
        "state": "draft",
        "latitude": 1.23456789,
        "starts-at": "2016-12-13T23:59:59.123456+00:00",
        "searchable-location-name": "Draft",
        "is-ticketing-enabled": true,
        "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"
      },
      "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 Ticket
GET/v1/tickets/{ticket_id}/event

Example URI

GET https://api.eventyay.com/v1/tickets/1/event
URI Parameters
HideShow
ticket_id
integer (required) Example: 1

ID of the ticket in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Microlocation
GET/v1/microlocations/{microlocation_id}/event

Example URI

GET https://api.eventyay.com/v1/microlocations/1/event
URI Parameters
HideShow
microlocation_id
integer (required) Example: 1

ID of the microlocation in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Sponsor
GET/v1/sponsors/{sponsor_id}/event

Example URI

GET https://api.eventyay.com/v1/sponsors/1/event
URI Parameters
HideShow
sponsor_id
integer (required) Example: 1

ID of the sponsor link in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Call
GET/v1/speakers-calls/{speakers_call_id}/event

Example URI

GET https://api.eventyay.com/v1/speakers-calls/1/event
URI Parameters
HideShow
speakers_call_id
integer (required) Example: 1

ID of the speakers call link in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Track
GET/v1/tracks/{track_id}/event

Example URI

GET https://api.eventyay.com/v1/tracks/1/event
URI Parameters
HideShow
track_id
integer (required) Example: 1

ID of the track in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Type
GET/v1/session-types/{session_type_id}/event

Example URI

GET https://api.eventyay.com/v1/session-types/1/event
URI Parameters
HideShow
session_type_id
integer (required) Example: 1

ID of the Session Type in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Tax
GET/v1/tax/{tax_id}/event

Example URI

GET https://api.eventyay.com/v1/tax/1/event
URI Parameters
HideShow
tax_id
integer (required) Example: 1

ID of the tax in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Invoice
GET/v1/event-invoices/{event_invoice_id}/event

Example URI

GET https://api.eventyay.com/v1/event-invoices/1/event
URI Parameters
HideShow
event_invoice_id
integer (required) Example: 1

ID of the Event Invoice in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Code
GET/v1/discount-codes/{discount_code_id}/event

Example URI

GET https://api.eventyay.com/v1/discount-codes/1/event
URI Parameters
HideShow
discount_code_id
integer (required) Example: 1

ID of the discount code in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Session
GET/v1/sessions/{session_id}/event

Example URI

GET https://api.eventyay.com/v1/sessions/1/event
URI Parameters
HideShow
session_id
integer (required) Example: 1

ID of the session in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Tag
GET/v1/ticket-tags/{ticket_tag_id}/event

Example URI

GET https://api.eventyay.com/v1/ticket-tags/1/event
URI Parameters
HideShow
ticket_tag_id
integer (required) Example: 1

ID of the ticket tag in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Invite
GET/v1/role-invites/{role_invite_id}/event

Example URI

GET https://api.eventyay.com/v1/role-invites/1/event
URI Parameters
HideShow
role_invite_id
integer (required) Example: 1

ID of the role invite in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Speaker
GET/v1/speakers/{speaker_id}/event

Example URI

GET https://api.eventyay.com/v1/speakers/1/event
URI Parameters
HideShow
speaker_id
integer (required) Example: 1

ID of the speaker in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Notification
GET/v1/email-notifications/{email_notification_id}/event

Example URI

GET https://api.eventyay.com/v1/email-notifications/1/event
URI Parameters
HideShow
email_notification_id
integer (required) Example: 1

ID of the email notification in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Attendee
GET/v1/attendees/{attendee_id}/event

Example URI

GET https://api.eventyay.com/v1/attendees/1/event
URI Parameters
HideShow
attendee_id
integer (required) Example: 1

ID of the attendee in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "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 Form
GET/v1/custom-forms/{custom_form_id}/event

Example URI

GET https://api.eventyay.com/v1/custom-forms/1/event
URI Parameters
HideShow
custom_form_id
integer (required) Example: 1

ID of the custom form in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "type": "event",
    "id": "1",
    "links": {
      "self": "/v1/events/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/events/1"
  }
}

Get Event for a FAQ

Event Details for a FAQ
GET/v1/faqs/{faq_id}/event

Example URI

GET https://api.eventyay.com/v1/faqs/1/event
URI Parameters
HideShow
faq_id
integer (required) Example: 1

ID of the faq in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "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",
      "organizer-description": "example",
      "is-map-shown": true,
      "original-image-url": "https://www.w3schools.com/html/pic_mountain.jpg",
      "onsite-details": "example",
      "organizer-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-organizer-info": false,
      "state": "draft",
      "latitude": 1.23456789,
      "starts-at": "2016-12-13T23:59:59.123456+00:00",
      "searchable-location-name": "Draft",
      "is-ticketing-enabled": true,
      "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"
    },
    "type": "event",
    "id": "1",
    "links": {
      "self": "/v1/events/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/events/1"
  }
}

Get Event for a Order

Event Details for a Order
GET/v1/orders/{order_identifier}/event

Example URI

GET https://api.eventyay.com/v1/orders/7201904e/event
URI Parameters
HideShow
order_identifier
string (required) Example: 7201904e

Identifier of the order

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "organizers": {
        "links": {
          "self": "/v1/events/1/relationships/organizers",
          "related": "/v1/users"
        }
      },
      "ticket-tags": {
        "links": {
          "self": "/v1/events/1/relationships/ticket-tags",
          "related": "/v1/events/1/ticket-tags"
        }
      },
      "speakers-call": {
        "links": {
          "self": "/v1/events/1/relationships/speakers-call",
          "related": "/v1/events/1/speakers-call"
        }
      },
      "tax": {
        "links": {
          "self": "/v1/events/1/relationships/tax",
          "related": "/v1/events/1/tax"
        }
      },
      "coorganizers": {
        "links": {
          "self": "/v1/events/1/relationships/coorganizers",
          "related": "/v1/users"
        }
      },
      "session-types": {
        "links": {
          "self": "/v1/events/1/relationships/session-types",
          "related": "/v1/events/1/session-types"
        }
      },
      "microlocations": {
        "links": {
          "self": "/v1/events/1/relationships/microlocations",
          "related": "/v1/events/1/microlocations"
        }
      },
      "orders": {
        "links": {
          "self": "/v1/events/1/relationships/orders",
          "related": "/v1/events/1/orders"
        }
      },
      "speakers": {
        "links": {
          "self": "/v1/events/1/relationships/speakers",
          "related": "/v1/events/1/speakers"
        }
      },
      "event-copyright": {
        "links": {
          "self": "/v1/events/1/relationships/event-copyright",
          "related": "/v1/events/1/event-copyright"
        }
      },
      "attendees": {
        "links": {
          "self": "/v1/events/1/relationships/attendees",
          "related": "/v1/events/1/attendees"
        }
      },
      "custom-forms": {
        "links": {
          "self": "/v1/events/1/relationships/custom-forms",
          "related": "/v1/events/1/custom-forms"
        }
      },
      "track-organizers": {
        "links": {
          "self": "/v1/events/1/relationships/track-organizers",
          "related": "/v1/users"
        }
      },
      "event-type": {
        "links": {
          "self": "/v1/events/1/relationships/event-type",
          "related": "/v1/events/1/event-type"
        }
      },
      "discount-codes": {
        "links": {
          "self": "/v1/events/1/relationships/discount-codes",
          "related": "/v1/events/1/discount-codes"
        }
      },
      "event-sub-topic": {
        "links": {
          "self": "/v1/events/1/relationships/event-sub-topic",
          "related": "/v1/events/1/event-sub-topic"
        }
      },
      "sessions": {
        "links": {
          "self": "/v1/events/1/relationships/sessions",
          "related": "/v1/events/1/sessions"
        }
      },
      "event-topic": {
        "links": {
          "self": "/v1/events/1/relationships/event-topic",
          "related": "/v1/events/1/event-topic"
        }
      },
      "registrars": {
        "links": {
          "self": "/v1/events/1/relationships/registrars",
          "related": "/v1/users"
        }
      },
      "sponsors": {
        "links": {
          "self": "/v1/events/1/relationships/sponsors",
          "related": "/v1/events/1/sponsors"
        }
      },
      "tracks": {
        "links": {
          "self": "/v1/events/1/relationships/tracks",
          "related": "/v1/events/1/tracks"
        }
      },
      "access-codes": {
        "links": {
          "self": "/v1/events/1/relationships/access-codes",
          "related": "/v1/events/1/access-codes"
        }
      },
      "role-invites": {
        "links": {
          "self": "/v1/events/1/relationships/role-invites",
          "related": "/v1/events/1/role-invites"
        }
      },
      "tickets": {
        "links": {
          "self": "/v1/events/1/relationships/tickets",
          "related": "/v1/events/1/tickets"
        }
      },
      "social-links": {
        "links": {
          "self": "/v1/events/1/relationships/social-links",
          "related": "/v1/events/1/social-links"
        }
      },
      "moderators": {
        "links": {
          "self": "/v1/events/1/relationships/moderators",
          "related": "/v1/users"
        }
      },
      "event-invoices": {
        "links": {
          "self": "/v1/events/1/relationships/event-invoices",
          "related": "/v1/events/1/event-invoices"
        }
      }
    },
    "attributes": {
      "payment-country": null,
      "paypal-email": null,
      "code-of-conduct": "",
      "schedule-published-on": null,
      "payment-currency": null,
      "organizer-description": "",
      "is-map-shown": false,
      "original-image-url": "https://cdn.pixabay.com/photo/2013/11/23/16/25/birds-216412_1280.jpg",
      "onsite-details": null,
      "organizer-name": null,
      "longitude": null,
      "large-image-url": null,
      "timezone": "Asia/Kolkata",
      "can-pay-onsite": false,
      "deleted-at": null,
      "ticket-url": null,
      "can-pay-by-paypal": false,
      "location-name": null,
      "is-sponsors-enabled": false,
      "is-sessions-speakers-enabled": false,
      "privacy": "public",
      "has-organizer-info": false,
      "state": "Draft",
      "latitude": null,
      "starts-at": "2002-05-30T04:00:10+00:00",
      "searchable-location-name": null,
      "is-ticketing-enabled": true,
      "can-pay-by-cheque": false,
      "description": "",
      "pentabarf-url": null,
      "xcal-url": null,
      "logo-url": null,
      "can-pay-by-bank": false,
      "is-tax-enabled": false,
      "icon-image-url": null,
      "ical-url": null,
      "name": "New Event",
      "bank-details": null,
      "thumbnail-image-url": null,
      "created-at": "2017-08-13T21:41:20.468748+00:00",
      "can-pay-by-stripe": false,
      "cheque-details": null,
      "external-event-url": null,
      "identifier": "4f27fefe",
      "ends-at": "2022-05-30T04:00:10+00:00"
    },
    "type": "event",
    "id": "1",
    "links": {
      "self": "/v1/events/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/events/1"
  }
}

Invoices

Data related to an invoice for the event.

Parameter Description Type Required
status Status of the event order string -
identifier Unique ID for the invoice string -
paypal-token Paypal Token for the event organizer string -
transaction-id ID for Transaction string -
brand Brand for event invoice string -
created-at Time of creation of order ISO 8601 (tz-aware) -
payment-mode Payment Mode string -
stripe-token Stripe Token for the event organizer string -
last4 - string -
address Billing Address string -
city City for Billing Address string -
state State for Billing Address string -
country Country for Billing Address string -
zipcode Zipcode for Billing Address string -
exp-month Expiring Month integer -
exp-year Expiring Year integer -
amount Amount of the order float -
completed-at Completion of Invoice Order ISO 8601 (tz-aware) -
paid-via Payment procedure string -

Event Invoices

  • page%5bsize%5d (optional, integer, 10) - Maximum number of resources in a single paginated response.
    • page%5bnumber%5d (optional, integer, 2) - Page number to fetched for the paginated response.
    • sort (optional, string, created-at) - Sort the resources according to the given attribute in ascending order. Append ‘-’ to sort in descending order.
    • filter (optional, string, []) - Filter according to the flask-rest-jsonapi filtering system. Please refer: http://flask-rest-jsonapi.readthedocs.io/en/latest/filtering.html for more.

Get Event Invoices
GET/v1/event-invoices

Get a list of event invoices.

Example URI

GET https://api.eventyay.com/v1/event-invoices
Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "count": 1
  },
  "data": [
    {
      "relationships": {
        "event": {
          "links": {
            "self": "/v1/event-invoices/1/relationships/event",
            "related": "/v1/event-invoices/1/event"
          }
        },
        "user": {
          "links": {
            "self": "/v1/event-invoices/1/relationships/user",
            "related": "/v1/event-invoices/1/user"
          }
        }
      },
      "attributes": {
        "status": "pending",
        "city": null,
        "identifier": "3fe1aa02-34dd-41ea-a0a9-f7a0259b90b5",
        "paypal-token": null,
        "exp-year": null,
        "transaction-id": null,
        "country": null,
        "brand": null,
        "created-at": "2017-06-08T11:24:57.344803+00:00",
        "zipcode": null,
        "payment-mode": null,
        "stripe-token": null,
        "last4": null,
        "state": null,
        "address": null,
        "exp-month": null,
        "amount": 100,
        "completed-at": null,
        "paid-via": null
      },
      "type": "event-invoice",
      "id": "1",
      "links": {
        "self": "/v1/event-invoices/1"
      }
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/event-invoices"
  }
}

Event Invoices Details

Event Invoices Details
GET/v1/event-invoices/{event_invoice_id}

Get a single event invoice.

Example URI

GET https://api.eventyay.com/v1/event-invoices/1
URI Parameters
HideShow
event_invoice_id
integer (required) Example: 1

ID of the event invoice in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "discount-code": {
        "links": {
          "self": "/v1/event-invoices/5/relationships/discount-code",
          "related": "/v1event-invoices/5/discount-code"
        }
      },
      "event": {
        "links": {
          "self": "/v1/event-invoices/5/relationships/event",
          "related": "/v1/event-invoices/5/event"
        }
      },
      "user": {
        "links": {
          "self": "/v1/event-invoices/5/relationships/user",
          "related": "/v1/event-invoices/5/user"
        }
      }
    },
    "attributes": {
      "status": "pending",
      "city": "city",
      "identifier": "b88639c9-5a41-45ea-884d-977876baa08f",
      "paypal-token": "1234",
      "invoice-pdf-url": null,
      "transaction-id": "ae43awer",
      "country": "US",
      "brand": "brand",
      "created-at": "2017-06-28T08:10:14.968538+00:00",
      "zipcode": "40004",
      "payment-mode": "mode",
      "stripe-token": "fssfda432",
      "last4": "5445",
      "state": "state",
      "address": "address",
      "exp-month": 10,
      "amount": 500,
      "completed-at": null,
      "exp-year": 2100,
      "paid-via": "stripe"
    },
    "type": "event-invoice",
    "id": "5",
    "links": {
      "self": "/v1/event-invoices/5"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/event-invoices/5"
  }
}

Update Event Invoices
PATCH/v1/event-invoices/{event_invoice_id}

Update a single event invoice by id.

  • id (integer) - ID of the record to update (required)

Example URI

PATCH https://api.eventyay.com/v1/event-invoices/1
URI Parameters
HideShow
event_invoice_id
integer (required) Example: 1

ID of the event invoice in the form of an integer

Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "paypal-token": "1234",
      "exp-year": "2100",
      "transaction-id": "ae43awer",
      "brand": "brand",
      "payment-mode": "mode",
      "stripe-token": "fssfda432",
      "last4": "5445",
      "address": "address",
      "city": "city",
      "state": "state",
      "country": "US",
      "zipcode": "40004",
      "exp-month": "10",
      "amount": 500,
      "paid-via": "stripe"
    },
    "type": "event-invoice",
    "id": "1"
  }
}
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "discount-code": {
        "links": {
          "self": "/v1/event-invoices/5/relationships/discount-code",
          "related": "/v1event-invoices/5/discount-code"
        }
      },
      "event": {
        "links": {
          "self": "/v1/event-invoices/5/relationships/event",
          "related": "/v1/event-invoices/5/event"
        }
      },
      "user": {
        "links": {
          "self": "/v1/event-invoices/5/relationships/user",
          "related": "/v1/event-invoices/5/user"
        }
      }
    },
    "attributes": {
      "status": "pending",
      "city": "city",
      "identifier": "b88639c9-5a41-45ea-884d-977876baa08f",
      "paypal-token": "1234",
      "invoice-pdf-url": null,
      "transaction-id": "ae43awer",
      "country": "US",
      "brand": "brand",
      "created-at": "2017-06-28T08:10:14.968538+00:00",
      "zipcode": "40004",
      "payment-mode": "mode",
      "stripe-token": "fssfda432",
      "last4": "5445",
      "state": "state",
      "address": "address",
      "exp-month": 10,
      "amount": 500,
      "completed-at": null,
      "exp-year": 2100,
      "paid-via": "stripe"
    },
    "type": "event-invoice",
    "id": "5",
    "links": {
      "self": "/v1/event-invoices/5"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/event-invoices/5"
  }
}

Delete Event Invoices
DELETE/v1/event-invoices/{event_invoice_id}

Delete a single event invoice.

Example URI

DELETE https://api.eventyay.com/v1/event-invoices/1
URI Parameters
HideShow
event_invoice_id
integer (required) Example: 1

ID of the event invoice in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "message": "Object successfully deleted"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Event Invoice List of an Event

List Event Invoices of an Event
GET/v1/events/{event_identifier}/event-invoices

Get a single event invoice.

Example URI

GET https://api.eventyay.com/v1/events/1/event-invoices
URI Parameters
HideShow
event_identifier
string (required) Example: 1

identifier or event id of the event. (b8324ae2 is an example of identifier)

page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 1
sort
string (optional) Example: status
filter
string (optional) Example: []
Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "count": 1
  },
  "data": [
    {
      "relationships": {
        "discount-code": {
          "links": {
            "self": "/v1/event-invoices/1/relationships/discount-code",
            "related": "/v1event-invoices/1/discount-code"
          }
        },
        "event": {
          "links": {
            "self": "/v1/event-invoices/1/relationships/event",
            "related": "/v1/event-invoices/1/event"
          }
        },
        "user": {
          "links": {
            "self": "/v1/event-invoices/1/relationships/user",
            "related": "/v1/event-invoices/1/user"
          }
        }
      },
      "attributes": {
        "status": "pending",
        "city": "city",
        "identifier": "1881f5f8-2936-4796-b51e-b9a97a54ba9a",
        "paypal-token": "1234",
        "invoice-pdf-url": null,
        "transaction-id": "ae43awer",
        "country": "US",
        "brand": "brand",
        "created-at": "2017-08-06T23:45:30.564344+00:00",
        "zipcode": "40004",
        "payment-mode": "mode",
        "stripe-token": "fssfda432",
        "last4": "5445",
        "state": "state",
        "address": "address",
        "exp-month": 10,
        "amount": 500,
        "completed-at": null,
        "exp-year": 2100,
        "paid-via": "stripe"
      },
      "type": "event-invoice",
      "id": "1",
      "links": {
        "self": "/v1/event-invoices/1"
      }
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/events/1/event-invoices"
  }
}

Event Invoice List of a User

List Event Invoices of a User
GET/v1/users/{user_id}/event-invoices

Get a single event invoice.

Example URI

GET https://api.eventyay.com/v1/users/2/event-invoices
URI Parameters
HideShow
user_id
integer (required) Example: 2

ID of the user in the form of an integer

page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 1
sort
string (optional) Example: status
filter
string (optional) Example: []
Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "count": 1
  },
  "data": [
    {
      "relationships": {
        "discount-code": {
          "links": {
            "self": "/v1/event-invoices/1/relationships/discount-code",
            "related": "/v1event-invoices/1/discount-code"
          }
        },
        "event": {
          "links": {
            "self": "/v1/event-invoices/1/relationships/event",
            "related": "/v1/event-invoices/1/event"
          }
        },
        "user": {
          "links": {
            "self": "/v1/event-invoices/1/relationships/user",
            "related": "/v1/event-invoices/1/user"
          }
        }
      },
      "attributes": {
        "status": "pending",
        "city": "city",
        "identifier": "1881f5f8-2936-4796-b51e-b9a97a54ba9a",
        "paypal-token": "1234",
        "invoice-pdf-url": null,
        "transaction-id": "ae43awer",
        "country": "US",
        "brand": "brand",
        "created-at": "2017-08-06T23:45:30.564344+00:00",
        "zipcode": "40004",
        "payment-mode": "mode",
        "stripe-token": "fssfda432",
        "last4": "5445",
        "state": "state",
        "address": "address",
        "exp-month": 10,
        "amount": 500,
        "completed-at": null,
        "exp-year": 2100,
        "paid-via": "stripe"
      },
      "type": "event-invoice",
      "id": "1",
      "links": {
        "self": "/v1/event-invoices/1"
      }
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/events/1/event-invoices"
  }
}

Microlocations

Data related to all the microlocations for the various sessions of the event.

Parameter Description Type Required
name Name of the microlocation string yes
latitude Latitude of the microlocation float -
longitude Longitude of the microlocation float -
floor Floor of the microlocation integer -
room Room of the microlocation string -

Microlocation Collection

Create Microlocation
POST/v1/microlocations{?sort,filter}

Create a new microlocation using an event_id.

Example URI

POST https://api.eventyay.com/v1/microlocations?sort=floor&filter=[]
URI Parameters
HideShow
page[size]
integer (optional) Example: 10
page[number]
integer (optional) Example: 2
sort
string (optional) Example: floor
filter
string (optional) Example: []
Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "relationships": {
      "event": {
        "data": {
          "type": "event",
          "id": "1"
        }
      }
    },
    "attributes": {
      "name": "microlocation-name",
      "latitude": "45.00",
      "longitude": "45.00",
      "floor": "2",
      "room": "room1"
    },
    "type": "microlocation"
  }
}
Response  201
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "event": {
        "links": {
          "self": "/v1/microlocations/1/relationships/event",
          "related": "/v1/microlocations/1/event"
        }
      },
      "sessions": {
        "links": {
          "self": "/v1/microlocations/1/relationships/sessions",
          "related": "/v1/microlocations/1/sessions"
        }
      }
    },
    "attributes": {
      "name": "microlocation-name",
      "latitude": "45.00",
      "longitude": "45.00",
      "floor": "2",
      "room": "room1"
    },
    "type": "microlocation",
    "id": "1",
    "links": {
      "self": "/v1/microlocations/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/microlocations/1"
  }
}

Microlocation Details

Microlocation Details
GET/v1/microlocations/{microlocation_id}

Get a single microlocation.

Example URI

GET https://api.eventyay.com/v1/microlocations/1
URI Parameters
HideShow
microlocation_id
integer (required) Example: 1

ID of the ticket in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "event": {
        "links": {
          "self": "/v1/microlocations/1/relationships/event",
          "related": "/v1/microlocations/1/event"
        }
      },
      "sessions": {
        "links": {
          "self": "/v1/microlocations/1/relationships/sessions",
          "related": "/v1/microlocations/1/sessions"
        }
      }
    },
    "attributes": {
      "name": "microlocation-name",
      "latitude": "45.00",
      "longitude": "45.00",
      "floor": "2",
      "room": "room1"
    },
    "type": "microlocation",
    "id": "2",
    "links": {
      "self": "/v1/microlocations/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/microlocations/1"
  }
}

Update Microlocation
PATCH/v1/microlocations/{microlocation_id}

Update a single microlocation by id.

  • id (integer) - ID of the record to update (required)

Example URI

PATCH https://api.eventyay.com/v1/microlocations/1
URI Parameters
HideShow
microlocation_id
integer (required) Example: 1

ID of the ticket in the form of an integer

Request
HideShow
Headers
Content-Type: application/vnd.api+json
Authorization: JWT <Auth Key>
Body
{
  "data": {
    "attributes": {
      "name": "microlocation-name1",
      "latitude": "46.00",
      "longitude": "46.00",
      "floor": "21",
      "room": "room11"
    },
    "type": "microlocation",
    "id": "1"
  }
}
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "relationships": {
      "event": {
        "links": {
          "self": "/v1/microlocations/1/relationships/event",
          "related": "/v1/microlocations/1/event"
        }
      },
      "sessions": {
        "links": {
          "self": "/v1/microlocations/1/relationships/sessions",
          "related": "/v1/microlocations/1/sessions"
        }
      }
    },
    "attributes": {
      "name": "microlocation-name1",
      "latitude": "46.00",
      "longitude": "46.00",
      "floor": "21",
      "room": "room11"
    },
    "type": "microlocation",
    "id": "1",
    "links": {
      "self": "/v1/microlocations/1"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "self": "/v1/microlocations/1"
  }
}

Delete Microlocation
DELETE/v1/microlocations/{microlocation_id}

Delete a single microlocation.

Example URI

DELETE https://api.eventyay.com/v1/microlocations/1
URI Parameters
HideShow
microlocation_id
integer (required) Example: 1

ID of the ticket in the form of an integer

Request
HideShow
Headers
Accept: application/vnd.api+json
Authorization: JWT <Auth Key>
Response  200
HideShow
Headers
Content-Type: application/vnd.api+json
Body
{
  "meta": {
    "message": "Object successfully deleted"
  },
  "jsonapi": {
    "version": "1.0"
  }
}

Microlocations under an Event

Get List of Microlocations under an Event
GET/v1/events/{event_identifier}/microlocations{?sort,filter}

Get a single microlocation.

Example URI

GET https://a