Eventgrid API 2.0

Introduction

Overview

Eventgrid Customer API gives developers all the tools for Creating Order flows to purchase tickets, seats or create registrations with sessions. API is built using proven industry standards like REST, JSON and HTTPS.

Http verbs and Http Authentication is used for all api requests which makes it possible to connect to our api using any popular API clients. Customer API allows developers to easily implement the following use cases:

  • get list of available events
  • get list of products/add-ons available for purchase
  • check availability for tickets, seats, sessions
  • reserve tickets for short duration so no one else can buy them while you are finishing the order
  • place order
  • add customer to wait list

Signup

To access Customer API please send a request for API key to Eventgrid Support: support@eventgrid.com.

The key will limit you to API resources within your business

If you are building an application where you require access to multiple businesses, please mention this in your email as well as short description of your application and it's target audience.

Infrastructure

Security

All communication to and from Eventgrid Customer API is done using HTTPS. The data involved in the communication over SSL is kept private between the API server and client and is encrypted using RSA 2048.

Any non-secure http request results in error message.

Authentication

Many actions in Customer API can be used with API key only.

But some methods like getting list of orders for specific customer require customer login.

For example, to get list of available tickets for event with Id (23) you would call Get Available Ticket Types action with provided apiKey parameter in query.

But if you want to retrieve orders for specific customer you have to authenticate that customer first.

To login the customer use Authenticate action which returns user token.

After you have the token, you can retrieve all customer orders using List Orders action with provided apiKey and userToken parameters in query.

Caching with ETags

There are some API actions get a lot of data back in response. Data that doesn't change very often. Those actions may slow down client application and use up extra bandwidth. To alleviate it we use ETag Http functionality that allows you to check if Resource has changed before getting the latest copy of the resourse. For example for getting event seating chart you use action Get Seating Chart with provided ETag parameter in query.

Seating chart method sends back a big data structure (dependent on size of chart), but this data doesn't change very often. So after making first request it is a good practice to cache the ETag that comes back in response on client side. For next seating chart request, you just need to include ETag in the request.

If ETag matches current version of resource then API returns http code 304 in response which means "Not Modified". But if resource has changed it will return http code 200 and the whole updated resource.

Common Workflows

Order Tickets

This workflow is for buying event tickets.

1. Select Tickets

Get list of available tickets for Event Date/Instance use Get Available Ticket Types action.

2. Reserve Tickets for 30 mins

To reserve tickets need to create a cart using Create Cart action.

pass the ticket type variants and quantity to reserve.

NOTE: It is possible to just submit order directly without reserving tickets, but if it happens several steps later, there is a chance the tickets will not be available any longer

3. Select Products

Product are available for event if Store Feature is enabled and "Allow to Sell Products" is enabled on event.

To retrieve list of products use Get Available Products action.

Products may be only available for certain ticket types, so that needs to be taken into account.

4. Calculate Order Totals

Calculate Totals method is used to get latest totals for Order including taxes and all fees.

In request you include all the items (Tickets and Products) that user has selected as well as quantities.

You may also include PromoCode if customer wants to use one. In Response you get back all the calculated totals for each order item as well as for order as whole.

5. Submit Order and Charge Payment

At this point customer selected all items that he/she wants to buy, entered payment information and ready to submit the order.

For this you use Create And Pay action.

6. Thank You

If create-and-pay is successful, you can use Get Order By Id action to retreive all the information about paid order.

Try API

Try API

You may want to check API. In order to do this, you need to send requests and recieve responses for it. You can do it multiple ways - using desktop app, write your own UI for it and other ways.

The easiest way to do it is to use application designed specially for this. One of such applications - Postman. It has user-friendly interface, supports all HTTP methods and it is easy to install.

Learn more about Postman and how to test API here.

Additionally it is possible to import RAML definition files into Postman, instructions are here. RAML definition of Eventgrid API is available here.

https://api.eventgrid.com

Authentication

Authenticate your account when using the API to get your User token. User token is used in API requests.

With email and password

Authenticate using your email and password.

Request
  • Email string required

  • Password string required

  • EventId integer, optional

  • BusinessId integer, optional

  • ApiKey string required

Response
  • UserToken string, optional

  • BusinessId integer,null, optional

  • ContactId integer,null, optional

  • ExpiresAt string, optional

  • IsSuccess boolean, optional

  • Error object, optional

     child attributes
    • ErrorCode integer, optional

    • ErrorMessage string, optional

  • ArgumentErrors array, optional

     item attributes
    • ArgumentName string, optional

    • InlineErrorMessage string, optional

    • ErrorCode integer, optional

    • ErrorMessage string, optional

POST https://api.eventgrid.com/2.0/customer-api/authenticate
{
    "email": "usersample@email.com",
    "password": "usersample#1!",
    "businessId": 31278,
    "apiKey": "GGHR4pkP"
}
HTTP status code 200
{
    "userToken": "2b782824-d458-4ee2-9ed0-8e30fd27670e",
    "businessId": 31278,
    "contactId": 211784,
    "expiresAt": "2016-04-17T08:46:18.5044569Z",
    "isSuccess": true,
    "error": null,
    "argumentErrors": []
}

Verify

Verify your authentication.

Request
  • UserToken string required

  • ApiKey string required

Response
  • UserToken string, optional

  • BusinessId integer,null, optional

  • ContactId integer,null, optional

  • ExpiresAt string, optional

  • IsSuccess boolean, optional

  • Error object, optional

     child attributes
    • ErrorCode integer, optional

    • ErrorMessage string, optional

  • ArgumentErrors array, optional

     item attributes
    • ArgumentName string, optional

    • InlineErrorMessage string, optional

    • ErrorCode integer, optional

    • ErrorMessage string, optional

POST https://api.eventgrid.com/2.0/customer-api/authenticate/verify
{
    "userToken": "2b782824-d458-4ee2-9ed0-8e30fd27670e",
    "apiKey": "GGHR4pkP"
}
HTTP status code 200
{
    "contactId":211784,
    "businessId":31278,
    "userEmail":"usersample@email.com",
    "userId":30781,
    "isSuccess":true,
    "error":null,
    "argumentErrors":[]
}

Brands

You can retrieve a Brand to see properties like name, logo, description and others.

Retrieve a brand

Retrieves the details of Brand.

URI Parameters
  • id string required

Query Parameters
  • apiKey string required

    API Key

Response
  • IsModified boolean, optional

  • ETag string, optional

  • Brand object, optional

     child attributes
    • Id integer, optional

    • Name string, optional

    • Description string, optional

    • CfV1Domain string, optional

    • CfV2Domain string, optional

    • AdminDomain string, optional

    • BrandFee object, optional

       child attributes
      • Businesses array, optional

         item attributes
        • Id integer, optional

      • StripeSettings object, optional

         child attributes
        • Id integer, optional

        • ConnectClientId string, optional

        • PublishableApiKey string, optional

        • SecretApiKey string, optional

      • PayPalSettings object, optional

         child attributes
        • Id integer, optional

        • Username string, optional

        • Password string, optional

        • Signature string, optional

      • BraintreeSettings object, optional

         child attributes
        • Id integer, optional

        • PartnerPublicId string, optional

        • PartnerPublicKey string, optional

        • PartnerPrivateKey string, optional

        • ConnectPartnerAccountUrl string, optional

        • CanUseBraintreePaymentProcessor boolean, optional

      • EmailSettings object, optional

         child attributes
        • Id integer, optional

        • FromEmail string, optional

        • FromEmailForBusinessSignup string, optional

        • ToEmailForBusinessSignupNotification string, optional

        • FromEmailForContactOrderConfirmation string, optional

        • FromEmailForContactEventOrganizerEmail string, optional

      • SquareSettings object, optional

         child attributes
        • AccessToken string, minLength: 50, maxLength: 50, optional

        • ApplicationId string, minLength: 50, maxLength: 50, optional

        • ApplicationSecret string, minLength: 50, maxLength: 50, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    GET https://api.eventgrid.com/2.0/customer-api/brands/{id}
    HTTP status code 200
    {  
        "brand":{  
            "id":1,
            "name":"Eventgrid",
            "description":null,
            "copyright":"Eventgrid",
            "logo":"https://az503889.vo.msecnd.net/eventgrid/img/042064cd-7eac-425c-ba57-203b717ba3ae.png",
            "eventCmsFooterLogo":"https://az503889.vo.msecnd.net/eventgrid/img/01f2ee36-70ec-4d0b-83b8-78fde3734797.png",
            "cfV1Domain":"eventgrid.com",
            "cfV2Domain":"register.eventgrid.com",
            "adminDomain":"eventgrid.com",
            "brandFee":null,
            "businesses":null,
            "stripeSettings":null,
            "payPalSettings":null,
            "braintreeSettings":null,
            "emailSettings":null,
            "squareSettings":null
        },
        "eTag":"43baa8ed-011f-4ba0-b273-fffc943cef36",
        "isModified":true,
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Businesses

    You can retrieve Business object to see properties like name, logo and integration options.

    Retrieve a business

    Retrieves the details of a business with given Id.

    URI Parameters
    • id string required

    Query Parameters
    • apiKey string required

      API Key

    • loadOptions string, optional

      Comma-delimited list of load options

      Available options:

      All - load all object fields
      PaymentSettings - load payment settings
      Address - load business address
      ContactForm - load contact form
      MemberForm - load member form
      EventsCounters - load events counters
      Subscription - load available features

    Response
    • IsModified boolean, optional

    • ETag string, optional

    • Business object, optional

       child attributes
      • Id integer, optional

      • BrandId integer, optional

      • Name string, optional

      • Address object, optional

         child attributes
        • Id integer,null, optional

        • Country object, optional

           child attributes
          • Id integer,null, optional

          • Name string, optional

        • State object, optional

           child attributes
          • Id integer,null, optional

          • Name string, optional

          • Code string, optional

        • City string, optional

        • Street string, optional

        • Street2 string, optional

        • Zip string, optional

        • Lat number,null, optional

        • Lon number,null, optional

      • WebSite string, optional

      • Phone string, optional

      • Email string, optional

      • TimeZoneName string, optional

      • PaymentSettings object, optional

          child types
        • BusinessBraintreePaymentSettingsDto

           child attributes
          • ClientToken string, optional

          • PaymentProcessor , optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

          • Currency object, optional

             child attributes
            • IsoCode string, optional

            • CultureInfoName string, optional

            • Id integer,null, optional

            • Name string, optional

          • UseCardFlight boolean, optional

          • CardFlightMerchantAccount object, optional

             child attributes
            • Token string, optional

            • DeveloperApiKey string, optional

          • IsPaymentProcessorSetup boolean, optional

        • BusinessCardSmithPaymentSettingsDto

           child attributes
          • MerchantId string, optional

          • TerminalId string, optional

          • PaymentProcessor , optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

          • Currency object, optional

             child attributes
            • IsoCode string, optional

            • CultureInfoName string, optional

            • Id integer,null, optional

            • Name string, optional

          • UseCardFlight boolean, optional

          • CardFlightMerchantAccount object, optional

             child attributes
            • Token string, optional

            • DeveloperApiKey string, optional

          • IsPaymentProcessorSetup boolean, optional

        • BusinessPaypalPaymentSettingsDto

           child attributes
          • PayPalEmail string, optional

          • PaymentProcessor , optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

          • Currency object, optional

             child attributes
            • IsoCode string, optional

            • CultureInfoName string, optional

            • Id integer,null, optional

            • Name string, optional

          • UseCardFlight boolean, optional

          • CardFlightMerchantAccount object, optional

             child attributes
            • Token string, optional

            • DeveloperApiKey string, optional

          • IsPaymentProcessorSetup boolean, optional

        • BusinessStripeConnectPaymentSettingsDto

           child attributes
          • PublishableApiKey string, optional

          • PaymentProcessor , optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

          • Currency object, optional

             child attributes
            • IsoCode string, optional

            • CultureInfoName string, optional

            • Id integer,null, optional

            • Name string, optional

          • UseCardFlight boolean, optional

          • CardFlightMerchantAccount object, optional

             child attributes
            • Token string, optional

            • DeveloperApiKey string, optional

          • IsPaymentProcessorSetup boolean, optional

        • BusinessSquarePaymentSettingsDto

           child attributes
          • LocationId string, optional

          • UseSquareRegister string, optional

          • ApplicationId string, optional

          • PaymentProcessor , optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

          • Currency object, optional

             child attributes
            • IsoCode string, optional

            • CultureInfoName string, optional

            • Id integer,null, optional

            • Name string, optional

          • UseCardFlight boolean, optional

          • CardFlightMerchantAccount object, optional

             child attributes
            • Token string, optional

            • DeveloperApiKey string, optional

          • IsPaymentProcessorSetup boolean, optional

      • ContactForm object, optional

         child attributes
        • Id integer, optional

        • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

        • FormFields array, optional

           item attributes
          • Id integer, optional

          • FormId integer, optional

          • FieldId integer, optional

          • Field object, optional

              child types
            • FieldDto

               child attributes
              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • DateFieldDto

               child attributes
              • MinDate string, optional

              • MaxDate string, optional

              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • MultiSelectPickListFieldDto

               child attributes
              • Options array, optional

                 item attributes
                • Id integer, optional

                • Text string, optional

              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • PickListFieldDto

               child attributes
              • PickListType one of DropDown, RadioButtons, optional

              • Options array, optional

                 item attributes
                • Id integer, optional

                • Text string, optional

              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • NumberFieldDto

               child attributes
              • MinNumber number, optional

              • MaxNumber number, optional

              • Id integer, optional

              • Label string, optional

              • Description string, optional

              • Pos integer, optional

              • IsRequired boolean, optional

              • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

            • RatingFieldDto

               child attributes
              • MinRating integer, optional

              • MaxRating integer, optional

              • AllowHalf boolean, optional

              • Id integer, optional

              • Label string, optional

              • Description string, optional

              • Pos integer, optional

              • IsRequired boolean, optional

              • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

            • SingleLineTextFieldDto

               child attributes
              • MinLength integer, optional

              • MaxLength integer, optional

              • Width integer, optional

              • Id integer, optional

              • Label string, optional

              • Description string, optional

              • Pos integer, optional

              • IsRequired boolean, optional

              • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

          • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

          • Status one of Required, Optional, Hidden, optional

          • Pos integer, optional

          • IsSection boolean, optional

          • IsEditable boolean, optional

          • IsReadOnly boolean, optional

          • ParentId integer,null, optional

          • IsAdminOnly boolean, optional

          • IsFromContactForm boolean, optional

        • Rules array, optional

           item attributes
          • Id integer, optional

          • Action one of Show, Hide, optional

          • TargetFormFieldId integer, optional

          • LogicalOperator one of Or, And, optional

          • Conditions array, optional

             item attributes
            • Id integer, optional

            • FormFieldId integer, optional

            • Operator one of Is, IsNot, StartsWith, EndsWith, Contains, GreaterThan, LessThan, optional

            • Pos integer, optional

      • NationBuilderSubdomain string, optional

      • NationBuilderAccessToken string, optional

      • Description string, optional

      • LogoUrl string, optional

      • CustomSubdomain string, optional

      • CreatedAt string, optional

      • HeaderBackgroundImage string, optional

      • MembershipSettings object, optional

         child attributes
        • MemberForm object, optional

           child attributes
          • Id integer, optional

          • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

          • FormFields array, optional

             item attributes
            • Id integer, optional

            • FormId integer, optional

            • FieldId integer, optional

            • Field object, optional

                child types
              • FieldDto

                 child attributes
                • Id integer, optional

                • Name string, optional

                • Description string, optional

                • IsSystem boolean, optional

                • IsDynamic boolean, optional

                • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                • TypeName string, optional

              • DateFieldDto

                 child attributes
                • MinDate string, optional

                • MaxDate string, optional

                • Id integer, optional

                • Name string, optional

                • Description string, optional

                • IsSystem boolean, optional

                • IsDynamic boolean, optional

                • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                • TypeName string, optional

              • MultiSelectPickListFieldDto

                 child attributes
                • Options array, optional

                   item attributes
                  • Id integer, optional

                  • Text string, optional

                • Id integer, optional

                • Name string, optional

                • Description string, optional

                • IsSystem boolean, optional

                • IsDynamic boolean, optional

                • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                • TypeName string, optional

              • PickListFieldDto

                 child attributes
                • PickListType one of DropDown, RadioButtons, optional

                • Options array, optional

                   item attributes
                  • Id integer, optional

                  • Text string, optional

                • Id integer, optional

                • Name string, optional

                • Description string, optional

                • IsSystem boolean, optional

                • IsDynamic boolean, optional

                • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                • TypeName string, optional

              • NumberFieldDto

                 child attributes
                • MinNumber number, optional

                • MaxNumber number, optional

                • Id integer, optional

                • Label string, optional

                • Description string, optional

                • Pos integer, optional

                • IsRequired boolean, optional

                • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

              • RatingFieldDto

                 child attributes
                • MinRating integer, optional

                • MaxRating integer, optional

                • AllowHalf boolean, optional

                • Id integer, optional

                • Label string, optional

                • Description string, optional

                • Pos integer, optional

                • IsRequired boolean, optional

                • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

              • SingleLineTextFieldDto

                 child attributes
                • MinLength integer, optional

                • MaxLength integer, optional

                • Width integer, optional

                • Id integer, optional

                • Label string, optional

                • Description string, optional

                • Pos integer, optional

                • IsRequired boolean, optional

                • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

            • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

            • Status one of Required, Optional, Hidden, optional

            • Pos integer, optional

            • IsSection boolean, optional

            • IsEditable boolean, optional

            • IsReadOnly boolean, optional

            • ParentId integer,null, optional

            • IsAdminOnly boolean, optional

            • IsFromContactForm boolean, optional

          • Rules array, optional

             item attributes
            • Id integer, optional

            • Action one of Show, Hide, optional

            • TargetFormFieldId integer, optional

            • LogicalOperator one of Or, And, optional

            • Conditions array, optional

               item attributes
              • Id integer, optional

              • FormFieldId integer, optional

              • Operator one of Is, IsNot, StartsWith, EndsWith, Contains, GreaterThan, LessThan, optional

              • Pos integer, optional

      • EventsCounters object, optional

         child attributes
        • PublishedEventsCount integer, optional

      • GoogleAnalyticsTrackingId string, optional

      • Subscription object, optional

         child attributes
        • Features array, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    GET https://api.eventgrid.com/2.0/customer-api/businesses/{id}
    HTTP status code 200
    {  
        "business":{  
            "id":31278,
            "brandId":1,
            "name":"Eventgrid API Demo",
            "address":null,
            "webSite":null,
            "phone":"(908) 616-3333",
            "email":"api-demo@eventgrid.com",
            "timeZoneName":"Eastern Standard Time",
            "paymentSettings":null,
            "contactForm":null,
            "nationBuilderSubdomain":null,
            "nationBuilderAccessToken":null,
            "logo":null,
            "description":null,
            "logoUrl":null,
            "customSubdomain":null,
            "createdAt":"2016-04-13T10:08:59.29",
            "headerBackgroundImage":null,
            "membershipSettings":{  
                "memberForm":{  
                    "id":16918,
                    "formType":6,
                    "formFields":[  
                        {  
                            "includedMembershipsIds":[],
                            "allMembershipsIncluded":true,
                            "id":95261,
                            "formId":16918,
                            "fieldId":24256,
                            "field":{  
                                "id":24256,
                                "name":"Personal Info",
                                "description":null,
                                "isSystem":false,
                                "isDynamic":false,
                                "systemFieldType":null,
                                "typeName":"SectionFieldDto"
                            },
                            "formType":6,
                            "status":1,
                            "pos":0,
                            "isSection":true,
                            "isEditable":true,
                            "isReadOnly":true,
                            "parentId":null,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedMembershipsIds":[],
                            "allMembershipsIncluded":true,
                            "id":95262,
                            "formId":16918,
                            "fieldId":3,
                            "field":{  
                                "minLength":null,
                                "maxLength":null,
                                "width":null,
                                "id":3,
                                "name":"First Name",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":1,
                                "typeName":"SingleLineTextFieldDto"
                            },
                            "formType":6,
                            "status":1,
                            "pos":1,
                            "isSection":false,
                            "isEditable":false,
                            "isReadOnly":false,
                            "parentId":95261,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedMembershipsIds":[],
                            "allMembershipsIncluded":true,
                            "id":95263,
                            "formId":16918,
                            "fieldId":4,
                            "field":{  
                                "minLength":null,
                                "maxLength":null,
                                "width":null,
                                "id":4,
                                "name":"Last Name",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":2,
                                "typeName":"SingleLineTextFieldDto"
                            },
                            "formType":6,
                            "status":1,
                            "pos":2,
                            "isSection":false,
                            "isEditable":false,
                            "isReadOnly":false,
                            "parentId":95261,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedMembershipsIds":[],
                            "allMembershipsIncluded":true,
                            "id":95264,
                            "formId":16918,
                            "fieldId":5,
                            "field":{  
                                "id":5,
                                "name":"Email",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":3,
                                "typeName":"EmailFieldDto"
                            },
                            "formType":6,
                            "status":1,
                            "pos":3,
                            "isSection":false,
                            "isEditable":false,
                            "isReadOnly":false,
                            "parentId":95261,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedMembershipsIds":[],
                            "allMembershipsIncluded":true,
                            "id":96071,
                            "formId":16918,
                            "fieldId":24417,
                            "field":{  
                                "minDate":null,
                                "maxDate":null,
                                "id":24417,
                                "name":"Your date of birth",
                                "description":null,
                                "isSystem":false,
                                "isDynamic":true,
                                "systemFieldType":null,
                                "typeName":"DateFieldDto"
                            },
                            "formType":6,
                            "status":1,
                            "pos":6,
                            "isSection":false,
                            "isEditable":true,
                            "isReadOnly":false,
                            "parentId":95261,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        }
                    ]
                }
            },
            "eventsCounters":null,
            "subscription":null,
            "googleAnalyticsTrackingId":null
        },
        "eTag":null,
        "isModified":true,
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Retrieve payment settings

    Retrieves the payment settings of a business with given Id. Payment settings contains payment processor, currency and other information.

    URI Parameters
    • id string required

    Query Parameters
    • apiKey string required

      API Key

    Response
    • PaymentSettings object, optional

        child types
      • BusinessBraintreePaymentSettingsDto

         child attributes
        • ClientToken string, optional

        • PaymentProcessor , optional

           child attributes
          • Id integer,null, optional

          • Name string, optional

        • Currency object, optional

           child attributes
          • IsoCode string, optional

          • CultureInfoName string, optional

          • Id integer,null, optional

          • Name string, optional

        • UseCardFlight boolean, optional

        • CardFlightMerchantAccount object, optional

           child attributes
          • Token string, optional

          • DeveloperApiKey string, optional

        • IsPaymentProcessorSetup boolean, optional

      • BusinessCardSmithPaymentSettingsDto

         child attributes
        • MerchantId string, optional

        • TerminalId string, optional

        • PaymentProcessor , optional

           child attributes
          • Id integer,null, optional

          • Name string, optional

        • Currency object, optional

           child attributes
          • IsoCode string, optional

          • CultureInfoName string, optional

          • Id integer,null, optional

          • Name string, optional

        • UseCardFlight boolean, optional

        • CardFlightMerchantAccount object, optional

           child attributes
          • Token string, optional

          • DeveloperApiKey string, optional

        • IsPaymentProcessorSetup boolean, optional

      • BusinessPaypalPaymentSettingsDto

         child attributes
        • PayPalEmail string, optional

        • PaymentProcessor , optional

           child attributes
          • Id integer,null, optional

          • Name string, optional

        • Currency object, optional

           child attributes
          • IsoCode string, optional

          • CultureInfoName string, optional

          • Id integer,null, optional

          • Name string, optional

        • UseCardFlight boolean, optional

        • CardFlightMerchantAccount object, optional

           child attributes
          • Token string, optional

          • DeveloperApiKey string, optional

        • IsPaymentProcessorSetup boolean, optional

      • BusinessStripeConnectPaymentSettingsDto

         child attributes
        • PublishableApiKey string, optional

        • PaymentProcessor , optional

           child attributes
          • Id integer,null, optional

          • Name string, optional

        • Currency object, optional

           child attributes
          • IsoCode string, optional

          • CultureInfoName string, optional

          • Id integer,null, optional

          • Name string, optional

        • UseCardFlight boolean, optional

        • CardFlightMerchantAccount object, optional

           child attributes
          • Token string, optional

          • DeveloperApiKey string, optional

        • IsPaymentProcessorSetup boolean, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    GET https://api.eventgrid.com/2.0/customer-api/businesses/{id}/payment-settings
    HTTP status code 200
    {  
        "paymentSettings":{  
            "publishableApiKey":"pk_buViytjQ2ZrcPOYlWdt4gHjSrHcTa",
            "paymentProcessor":{  
                "id":1,
                "name":"Stripe Managed"
            },
            "currency":{  
                "isoCode":"USD",
                "cultureInfoName":"en-US",
                "id":1,
                "name":"U.S. Dollar"
            },
            "useCardFlight":false,
            "cardFlightMerchantAccount":null,
            "isPaymentProcessorSetup":true
        },
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Retrieve contact form

    Retrieves the contact form of a business with given Id. Contact form is used to create custom fields. For example Date or Percentage. Also fields from contact form can be used in event forms and will be presented during order submission.

    URI Parameters
    • id string required

    Query Parameters
    • apiKey string required

      API Key

    Response
    • Id integer, optional

    • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

    • FormFields array, optional

       item attributes
      • Id integer, optional

      • FormId integer, optional

      • FieldId integer, optional

      • Field object, optional

          child types
        • FieldDto

           child attributes
          • Id integer, optional

          • Name string, optional

          • Description string, optional

          • IsSystem boolean, optional

          • IsDynamic boolean, optional

          • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

          • TypeName string, optional

        • DateFieldDto

           child attributes
          • MinDate string, optional

          • MaxDate string, optional

          • Id integer, optional

          • Name string, optional

          • Description string, optional

          • IsSystem boolean, optional

          • IsDynamic boolean, optional

          • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

          • TypeName string, optional

        • MultiSelectPickListFieldDto

           child attributes
          • Options array, optional

             item attributes
            • Id integer, optional

            • Text string, optional

          • Id integer, optional

          • Name string, optional

          • Description string, optional

          • IsSystem boolean, optional

          • IsDynamic boolean, optional

          • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

          • TypeName string, optional

        • PickListFieldDto

           child attributes
          • PickListType one of DropDown, RadioButtons, optional

          • Options array, optional

             item attributes
            • Id integer, optional

            • Text string, optional

          • Id integer, optional

          • Name string, optional

          • Description string, optional

          • IsSystem boolean, optional

          • IsDynamic boolean, optional

          • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

          • TypeName string, optional

        • NumberFieldDto

           child attributes
          • MinNumber number, optional

          • MaxNumber number, optional

          • Id integer, optional

          • Label string, optional

          • Description string, optional

          • Pos integer, optional

          • IsRequired boolean, optional

          • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

        • RatingFieldDto

           child attributes
          • MinRating integer, optional

          • MaxRating integer, optional

          • AllowHalf boolean, optional

          • Id integer, optional

          • Label string, optional

          • Description string, optional

          • Pos integer, optional

          • IsRequired boolean, optional

          • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

        • SingleLineTextFieldDto

           child attributes
          • MinLength integer, optional

          • MaxLength integer, optional

          • Width integer, optional

          • Id integer, optional

          • Label string, optional

          • Description string, optional

          • Pos integer, optional

          • IsRequired boolean, optional

          • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

      • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

      • Status one of Required, Optional, Hidden, optional

      • Pos integer, optional

      • IsSection boolean, optional

      • IsEditable boolean, optional

      • IsReadOnly boolean, optional

      • ParentId integer,null, optional

      • IsAdminOnly boolean, optional

      • IsFromContactForm boolean, optional

    • Rules array, optional

       item attributes
      • Id integer, optional

      • Action one of Show, Hide, optional

      • TargetFormFieldId integer, optional

      • LogicalOperator one of Or, And, optional

      • Conditions array, optional

         item attributes
        • Id integer, optional

        • FormFieldId integer, optional

        • Operator one of Is, IsNot, StartsWith, EndsWith, Contains, GreaterThan, LessThan, optional

        • Pos integer, optional

    GET https://api.eventgrid.com/2.0/customer-api/businesses/{id}/ContactForm
    HTTP status code 200
    {  
        "id":16917,
        "formType":5,
        "formFields":[  
            {  
                "id":95255,
                "formId":16917,
                "fieldId":24255,
                "field":{  
                    "id":24255,
                    "name":"Personal Info",
                    "description":null,
                    "isSystem":false,
                    "isDynamic":false,
                    "systemFieldType":null,
                    "typeName":"SectionFieldDto"
                },
                "formType":5,
                "status":1,
                "pos":0,
                "isSection":true,
                "isEditable":true,
                "isReadOnly":true,
                "parentId":null,
                "isAdminOnly":false,
                "isFromContactForm":false
            },
            {  
                "id":95256,
                "formId":16917,
                "fieldId":3,
                "field":{  
                    "minLength":null,
                    "maxLength":null,
                    "width":null,
                    "id":3,
                    "name":"First Name",
                    "description":null,
                    "isSystem":true,
                    "isDynamic":false,
                    "systemFieldType":1,
                    "typeName":"SingleLineTextFieldDto"
                },
                "formType":5,
                "status":1,
                "pos":1,
                "isSection":false,
                "isEditable":false,
                "isReadOnly":false,
                "parentId":95255,
                "isAdminOnly":false,
                "isFromContactForm":false
            },
            {  
                "id":95257,
                "formId":16917,
                "fieldId":4,
                "field":{  
                    "minLength":null,
                    "maxLength":null,
                    "width":null,
                    "id":4,
                    "name":"Last Name",
                    "description":null,
                    "isSystem":true,
                    "isDynamic":false,
                    "systemFieldType":2,
                    "typeName":"SingleLineTextFieldDto"
                },
                "formType":5,
                "status":1,
                "pos":2,
                "isSection":false,
                "isEditable":false,
                "isReadOnly":false,
                "parentId":95255,
                "isAdminOnly":false,
                "isFromContactForm":false
            },
            {  
                "id":95258,
                "formId":16917,
                "fieldId":5,
                "field":{  
                    "id":5,
                    "name":"Email",
                    "description":null,
                    "isSystem":true,
                    "isDynamic":false,
                    "systemFieldType":3,
                    "typeName":"EmailFieldDto"
                },
                "formType":5,
                "status":1,
                "pos":3,
                "isSection":false,
                "isEditable":false,
                "isReadOnly":false,
                "parentId":95255,
                "isAdminOnly":false,
                "isFromContactForm":false
            },
            {  
                "id":95259,
                "formId":16917,
                "fieldId":2,
                "field":{  
                    "id":2,
                    "name":"Phone",
                    "description":null,
                    "isSystem":true,
                    "isDynamic":false,
                    "systemFieldType":5,
                    "typeName":"PhoneFieldDto"
                },
                "formType":5,
                "status":2,
                "pos":4,
                "isSection":false,
                "isEditable":true,
                "isReadOnly":false,
                "parentId":95255,
                "isAdminOnly":false,
                "isFromContactForm":false
            },
            {  
                "id":95260,
                "formId":16917,
                "fieldId":1,
                "field":{  
                    "id":1,
                    "name":"Address",
                    "description":null,
                    "isSystem":true,
                    "isDynamic":false,
                    "systemFieldType":4,
                    "typeName":"AddressFieldDto"
                },
                "formType":5,
                "status":2,
                "pos":5,
                "isSection":false,
                "isEditable":true,
                "isReadOnly":false,
                "parentId":95255,
                "isAdminOnly":false,
                "isFromContactForm":false
            }
        ]
    }

    Retrieve Nation Builder information

    You can integrate with Nation Builder in your Business Admin account. Use this method if you want to retrieve Nation Builder Access Token.

    URI Parameters
    • id string required

    Query Parameters
    • apiKey string required

      API Key

    Response
    • Subdomain string, optional

    • AccessToken string, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    GET https://api.eventgrid.com/2.0/customer-api/businesses/{id}/Integration/NationBuilder
    HTTP status code 200
    {  
        "subdomain":"eventgrid",
        "accessToken":"85a158c20d97c3473f17d84ee63c2a43e1dc3394661a6ac5f1eb65bfae3b4443",
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Retrieve a user

    Retrieves user Id and Name.

    URI Parameters
    • id string required

    • email string required

    Query Parameters
    • apiKey string required

      API Key

    Response
    • User object, optional

       child attributes
      • Id integer, optional

      • Email string, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    GET https://api.eventgrid.com/2.0/customer-api/businesses/{id}/users/email/{email}
    HTTP status code 200
    {
      "user":{
          "id":30781,
          "email":"usersample@email.com"
      },
      "isSuccess":true,
      "error":null,
      "argumentErrors":[]
    }
    

    Carts

    Carts is used to create orders. You can put tickets, products, sessions into a cart. It is possible to just submit order directly without reserving tickets, but if it happens several steps later, there is a chance the tickets will not be available any longer.

    Create a cart

    Creates a new cart object.

    Request
    • Cart object required

       child attributes
      • Items array required

          item types
        • ProductCartItemDto

          A Product Cart Item - used in store and for Event Products

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • ProductVariantId integer required

          • Quantity integer required

          • Type integer required

            Expected value is 4 for product cart item

          • TypeName string, optional

        • PromoCodeCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • PromoCodeCode string required

          • Type integer required

            Expected value is 5 for promo code cart item

          • TypeName string, optional

        • SeatCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • EventInstanceId integer required

          • SeatId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 2 for seat cart item

          • TypeName string, optional

        • SessionTicketCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • AttendedSessions array required

          • EventInstanceId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 3 for session ticket cart item

          • TypeName string, optional

        • TicketTypeCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • EventInstanceId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 1 for ticket cart item

          • TypeName string, optional

      • PromoCode object, optional

         child attributes
        • UniqueId string, minLength: 36, maxLength: 36 required

          Unique identifier (GUID) of cart item.

        • PromoCodeCode string required

        • Type integer required

          Expected value is 5 for promo code cart item

        • TypeName string, optional

    • EventInstanceId integer, optional

    • ApiKey string required

    Response
    • Cart object, optional

       child attributes
      • Guid string, minLength: 36, maxLength: 36, optional

        Unique identifier (GUID) of cart.

      • Items array, optional

          item types
        • ProductCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • ProductVariantId integer required

          • Quantity integer required

          • Type integer required

            Expected value is 4 for product cart item

          • TypeName string, optional

        • PromoCodeCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • PromoCodeCode string required

          • Type integer required

            Expected value is 5 for promo code cart item

          • TypeName string, optional

        • SeatCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • EventInstanceId integer required

          • SeatId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 2 for seat cart item

          • TypeName string, optional

        • SessionTicketCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • AttendedSessions array required

          • EventInstanceId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 3 for session ticket cart item

          • TypeName string, optional

        • TicketTypeCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • EventInstanceId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 1 for ticket cart item

          • TypeName string, optional

      • PromoCode object, optional

         child attributes
        • UniqueId string, minLength: 36, maxLength: 36 required

          Unique identifier (GUID) of cart item.

        • PromoCodeCode string required

        • Type integer required

          Expected value is 5 for promo code cart item

        • TypeName string, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    POST https://api.eventgrid.com/2.0/customer-api/carts/
    {
        "Cart": {
    	    "ExpiresAt": null,
    	    "Guid": "ffccda1c-a0bc-41a5-94af-053ce22daf52",
    	    "Items": [
    	        {
    		        "EventInstanceId": 23617,
    		        "TicketTypeId": 21012,
                    "Quantity": 2,
    		        "UniqueId": "a6688601-7afd-4ef0-af22-843fac153dc1",
    		        "Type": 1,
    		        "TypeName": "TicketTypeCartItemDto"
    	        }
    	    ],
    	    "PromoCode": null
        },
        "EventInstanceId": 23617,
        "apiKey": "GGHR4pkP"
    }
    HTTP status code 200
    {  
        "cart":{  
            "expiresAt":"2016-04-15T19:54:36.5399697Z",
            "guid":"88093f88-18e8-4b3b-a236-50ea1450b0d8",
            "items":[  
                {  
                    "quantity":2,
                    "eventInstanceId":null,
                    "ticketTypeId":21012,
                    "uniqueId":"a6688601-7afd-4ef0-af22-843fac153dc1",
                    "type":1,
                    "typeName":"TicketTypeCartItemDto"
                }
            ],
            "promoCode":null
        },
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Retrieve a cart

    Retrieve a cart by its unique identifier.

    URI Parameters
    • cartGuid string required

      Cart Unique Identifier

    Query Parameters
    • EventInstanceId integer, optional

    Response
    • Cart object, optional

       child attributes
      • Guid string, minLength: 36, maxLength: 36, optional

        Unique identifier (GUID) of cart.

      • Items array, optional

          item types
        • ProductCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • ProductVariantId integer required

          • Quantity integer required

          • Type integer required

            Expected value is 4 for product cart item

          • TypeName string, optional

        • PromoCodeCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • PromoCodeCode string required

          • Type integer required

            Expected value is 5 for promo code cart item

          • TypeName string, optional

        • SeatCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • EventInstanceId integer required

          • SeatId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 2 for seat cart item

          • TypeName string, optional

        • SessionTicketCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • AttendedSessions array required

          • EventInstanceId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 3 for session ticket cart item

          • TypeName string, optional

        • TicketTypeCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • EventInstanceId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 1 for ticket cart item

          • TypeName string, optional

      • PromoCode object, optional

         child attributes
        • UniqueId string, minLength: 36, maxLength: 36 required

          Unique identifier (GUID) of cart item.

        • PromoCodeCode string required

        • Type integer required

          Expected value is 5 for promo code cart item

        • TypeName string, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    GET https://api.eventgrid.com/2.0/customer-api/carts/{cartGuid}
    HTTP status code 200
    {  
        "cart":{  
            "expiresAt":"2016-04-18T08:18:31.1926789Z",
            "guid":"0650b9fe-978b-4e8b-872d-162565a1a5f1",
            "items":[  
                {  
                    "quantity":2,
                    "eventInstanceId":null,
                    "ticketTypeId":21012,
                    "uniqueId":"a6688601-7afd-4ef0-af22-843fac153dc1",
                    "type":1,
                    "typeName":"TicketTypeCartItemDto"
                }
            ],
            "promoCode":null
        },
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Delete a cart

    Delete a cart by its unique identifier.

    URI Parameters
    • cartGuid string required

      Cart Unique Identifier

    Query Parameters
    • EventInstanceId integer, optional

    Response
    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    DELETE https://api.eventgrid.com/2.0/customer-api/carts/{cartGuid}
    HTTP status code 200
    {  
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Add a cart item

    Adds a new item into a cart.

    URI Parameters
    • cartGuid string required

      Cart Unique Identifier

    Request
    • CartItem object, optional

        child types
      • ProductCartItemDto

        A Product Cart Item - used in store and for Event Products

         child attributes
        • UniqueId string, minLength: 36, maxLength: 36 required

          Unique identifier (GUID) of cart item.

        • ProductVariantId integer required

        • Quantity integer required

        • Type integer required

          Expected value is 4 for product cart item

        • TypeName string, optional

      • PromoCodeCartItemDto

         child attributes
        • UniqueId string, minLength: 36, maxLength: 36 required

          Unique identifier (GUID) of cart item.

        • PromoCodeCode string required

        • Type integer required

          Expected value is 5 for promo code cart item

        • TypeName string, optional

      • SeatCartItemDto

         child attributes
        • UniqueId string, minLength: 36, maxLength: 36 required

          Unique identifier (GUID) of cart item.

        • EventInstanceId integer required

        • SeatId integer required

        • TicketTypeId integer required

        • Type integer required

          Expected value is 2 for seat cart item

        • TypeName string, optional

      • SessionTicketCartItemDto

         child attributes
        • UniqueId string, minLength: 36, maxLength: 36 required

          Unique identifier (GUID) of cart item.

        • AttendedSessions array required

        • EventInstanceId integer required

        • TicketTypeId integer required

        • Type integer required

          Expected value is 3 for session ticket cart item

        • TypeName string, optional

      • TicketTypeCartItemDto

         child attributes
        • UniqueId string, minLength: 36, maxLength: 36 required

          Unique identifier (GUID) of cart item.

        • EventInstanceId integer required

        • TicketTypeId integer required

        • Type integer required

          Expected value is 1 for ticket cart item

        • TypeName string, optional

    • EventInstanceId integer,null, optional

    • ExpiresAt string, optional

    Response
    • Cart object, optional

       child attributes
      • Guid string, minLength: 36, maxLength: 36, optional

        Unique identifier (GUID) of cart.

      • Items array, optional

          item types
        • ProductCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • ProductVariantId integer required

          • Quantity integer required

          • Type integer required

            Expected value is 4 for product cart item

          • TypeName string, optional

        • PromoCodeCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • PromoCodeCode string required

          • Type integer required

            Expected value is 5 for promo code cart item

          • TypeName string, optional

        • SeatCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • EventInstanceId integer required

          • SeatId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 2 for seat cart item

          • TypeName string, optional

        • SessionTicketCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • AttendedSessions array required

          • EventInstanceId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 3 for session ticket cart item

          • TypeName string, optional

        • TicketTypeCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • EventInstanceId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 1 for ticket cart item

          • TypeName string, optional

      • PromoCode object, optional

         child attributes
        • UniqueId string, minLength: 36, maxLength: 36 required

          Unique identifier (GUID) of cart item.

        • PromoCodeCode string required

        • Type integer required

          Expected value is 5 for promo code cart item

        • TypeName string, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    POST https://api.eventgrid.com/2.0/customer-api/carts/{cartGuid}/items
    {  
        "CartItem":{  
            "EventInstanceId":23617,
            "TicketTypeId":21013,
            "Quantity":2,
            "UniqueId":"E3BD917B-C7DA-4AE7-B563-DF8536F85E77",
            "Type":1,
            "TypeName":"TicketTypeCartItemDto"
        },
        "EventInstanceId":23617,
        "expiesAt":null,
        "apiKey":"GGHR4pkP"
    }
    HTTP status code 200
    {  
        "cart":{  
            "expiresAt":"2016-04-18T08:18:31.1926789Z",
            "guid":"0650b9fe-978b-4e8b-872d-162565a1a5f1",
            "items":[  
                {  
                    "quantity":2,
                    "eventInstanceId":null,
                    "ticketTypeId":21012,
                    "uniqueId":"a6688601-7afd-4ef0-af22-843fac153dc1",
                    "type":1,
                    "typeName":"TicketTypeCartItemDto"
                },
                {  
                    "quantity":2,
                    "eventInstanceId":null,
                    "ticketTypeId":21013,
                    "uniqueId":"e3bd917b-c7da-4ae7-b563-df8536f85e77",
                    "type":1,
                    "typeName":"TicketTypeCartItemDto"
                },
                {  
                    "quantity":2,
                    "eventInstanceId":null,
                    "ticketTypeId":21012,
                    "uniqueId":"a6688601-7afd-4ef0-af22-843fac153dc1",
                    "type":1,
                    "typeName":"TicketTypeCartItemDto"
                },
                {  
                    "quantity":2,
                    "eventInstanceId":null,
                    "ticketTypeId":21013,
                    "uniqueId":"e3bd917b-c7da-4ae7-b563-df8536f85e77",
                    "type":1,
                    "typeName":"TicketTypeCartItemDto"
                }
            ],
            "promoCode":null
        },
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Delete a cart item

    Deletes item with provided unique id from cart.

    URI Parameters
    • cartGuid string required

      Cart Unique Identifier

    Query Parameters
    • uniqueId string, minLength: 36, maxLength: 36 required

      Item unique id

    • cartGuid string, minLength: 36, maxLength: 36 required

      Cart Unique Identifier

    Response
    • Cart object, optional

       child attributes
      • Guid string, minLength: 36, maxLength: 36, optional

        Unique identifier (GUID) of cart.

      • Items array, optional

          item types
        • ProductCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • ProductVariantId integer required

          • Quantity integer required

          • Type integer required

            Expected value is 4 for product cart item

          • TypeName string, optional

        • PromoCodeCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • PromoCodeCode string required

          • Type integer required

            Expected value is 5 for promo code cart item

          • TypeName string, optional

        • SeatCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • EventInstanceId integer required

          • SeatId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 2 for seat cart item

          • TypeName string, optional

        • SessionTicketCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • AttendedSessions array required

          • EventInstanceId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 3 for session ticket cart item

          • TypeName string, optional

        • TicketTypeCartItemDto

           child attributes
          • UniqueId string, minLength: 36, maxLength: 36 required

            Unique identifier (GUID) of cart item.

          • EventInstanceId integer required

          • TicketTypeId integer required

          • Type integer required

            Expected value is 1 for ticket cart item

          • TypeName string, optional

      • PromoCode object, optional

         child attributes
        • UniqueId string, minLength: 36, maxLength: 36 required

          Unique identifier (GUID) of cart item.

        • PromoCodeCode string required

        • Type integer required

          Expected value is 5 for promo code cart item

        • TypeName string, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    DELETE https://api.eventgrid.com/2.0/customer-api/carts/{cartGuid}/items
    HTTP status code 200
    {  
        "cart":{  
            "expiresAt":"2016-04-18T08:18:31.1926789Z",
            "guid":"0650b9fe-978b-4e8b-872d-162565a1a5f1",
            "items":[  
                {  
                    "quantity":2,
                    "eventInstanceId":null,
                    "ticketTypeId":21012,
                    "uniqueId":"a6688601-7afd-4ef0-af22-843fac153dc1",
                    "type":1,
                    "typeName":"TicketTypeCartItemDto"
                },
                {  
                    "quantity":2,
                    "eventInstanceId":null,
                    "ticketTypeId":21012,
                    "uniqueId":"a6688601-7afd-4ef0-af22-843fac153dc1",
                    "type":1,
                    "typeName":"TicketTypeCartItemDto"
                }
            ],
            "promoCode":null
        },
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Contacts

    This is an object representing person. You can retrieve it to see properties like email address, phone, name etc. You need to authenticate in order to use this method.

    Retrieve a contact

    Retrieves the details of the contact.

    URI Parameters
    • businessId string required

    • contactId string required

    Query Parameters
    • apiKey string required

      API Key

    • userToken string, minLength: 36, maxLength: 36 required

      User token obtained by using Authorize method.

    • loadOptions string, optional

      Comma-delimited list of load options

      Available options:

      All - load all response object fields
      ContactFormFields - load contact form fields values

    Response
    • Contact object, optional

       child attributes
      • Id integer, optional

      • FirstName string, optional

      • LastName string, optional

      • Email string, optional

      • Address object, optional

         child attributes
        • StateCode string, optional

        • CountryName string, optional

        • Street string, optional

        • Street2 string, optional

        • City string, optional

        • StateId integer,null, optional

        • StateOther string, optional

        • Zip string, optional

        • CountryId integer, optional

      • Phone string, optional

      • ContactFormDynamicDataSet object, optional

         child attributes
        • FormId integer, optional

        • FormFieldValues array, optional

            item types
          • AddressFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Address object, optional

               child attributes
              • StateCode string, optional

              • CountryName string, optional

              • Street string, optional

              • Street2 string, optional

              • City string, optional

              • StateId integer,null, optional

              • StateOther string, optional

              • Zip string, optional

              • CountryId integer, optional

          • CheckBoxFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Checked boolean, optional

          • DateFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

          • EmailFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

          • ImageUploadFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • UploadId string, optional

            • ImageFileName string, optional

          • MultiLineTextFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

          • MultiSelectPickListFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • SelectedOptionsIds array, optional

          • NumberFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value number, optional

          • PercentageFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value number, optional

          • PhoneFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

          • PickListFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • SelectedOptionId integer, optional

          • RatingFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value number, optional

          • SingleLineTextFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

          • TagsFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Tags array, optional

          • WebSiteFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    GET https://api.eventgrid.com/2.0/customer-api/businesses/{businessId}/contacts/{contactId}
    HTTP status code 200
    {  
        "contact":{  
            "id":211784,
            "firstName":"User",
            "lastName":"Sample",
            "email":"usersample@email.com",
            "address":null,
            "phone":null,
            "contactFormDynamicDataSet":null
        },
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Update a contact

    Updates a contact by setting the values of the parameters passed.

    URI Parameters
    • businessId string required

    • contactId string required

    Request
    • BusinessId integer, optional

    • Contact object, optional

       child attributes
      • Id integer, optional

      • FirstName string, optional

      • LastName string, optional

      • Email string, optional

      • Address object, optional

         child attributes
        • StateCode string, optional

        • CountryName string, optional

        • Street string, optional

        • Street2 string, optional

        • City string, optional

        • StateId integer,null, optional

        • StateOther string, optional

        • Zip string, optional

        • CountryId integer, optional

      • Phone string, optional

      • ContactFormDynamicDataSet object, optional

         child attributes
        • FormId integer, optional

        • FormFieldValues array, optional

            item types
          • AddressFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Address object, optional

               child attributes
              • StateCode string, optional

              • CountryName string, optional

              • Street string, optional

              • Street2 string, optional

              • City string, optional

              • StateId integer,null, optional

              • StateOther string, optional

              • Zip string, optional

              • CountryId integer, optional

          • CheckBoxFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Checked boolean, optional

          • DateFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

          • EmailFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

          • ImageUploadFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • UploadId string, optional

            • ImageFileName string, optional

          • MultiLineTextFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

          • MultiSelectPickListFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • SelectedOptionsIds array, optional

          • NumberFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value number, optional

          • PercentageFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value number, optional

          • PhoneFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

          • PickListFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • SelectedOptionId integer, optional

          • RatingFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value number, optional

          • SingleLineTextFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

          • TagsFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Tags array, optional

          • WebSiteFormFieldValueDto

             child attributes
            • FormFieldId integer, optional

            • FieldName string, optional

            • TypeName string, optional

            • Id integer, optional

            • Value string, optional

    • NewPassword string, optional

    • NewUserName string, optional

    Response
    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    POST https://api.eventgrid.com/2.0/customer-api/businesses/{businessId}/contacts/{contactId}
    {  
        "BusinessId":31278,
        "Contact":{  
            "FirstName":"User",
            "LastName":"Sample",
            "Email":"usersample@email.com",
            "Address":{  
                "StateCode":null,
                "CountryName":"Australia",
                "Street":"Sample Street",
                "Street2":"Apt. 0000",
                "City":"Sydney",
                "StateId":null,
                "StateOther":"New South Wales",
                "Zip":"100000",
                "CountryId":13
            }
        },
        "apiKey":"GGHR4pkP",
        "userToken":"2b782824-d458-4ee2-9ed0-8e30fd27670e"
    }
    HTTP status code 200
    {
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Retrieve membership subscriptions for a contact

    Retrieves the list of membership subscriptions connected to a contact.

    URI Parameters
    • businessId string required

    • contactId string required

    Query Parameters
    • apiKey string required

      API Key

    • userToken string, minLength: 36, maxLength: 36 required

      User token obtained by using Authorize method.

    Response
    • MembershipSubscriptions array, optional

       item attributes
      • Id integer, optional

      • Member object, optional

         child attributes
        • Contact object, optional

           child attributes
          • Id integer, optional

          • FirstName string, optional

          • LastName string, optional

          • Email string, optional

          • Address object, optional

             child attributes
            • StateCode string, optional

            • CountryName string, optional

            • Street string, optional

            • Street2 string, optional

            • City string, optional

            • StateId integer,null, optional

            • StateOther string, optional

            • Zip string, optional

            • CountryId integer, optional

          • Phone string, optional

          • ContactFormDynamicDataSet object, optional

             child attributes
            • FormId integer, optional

            • FormFieldValues array, optional

                item types
              • AddressFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Address object, optional

                   child attributes
                  • StateCode string, optional

                  • CountryName string, optional

                  • Street string, optional

                  • Street2 string, optional

                  • City string, optional

                  • StateId integer,null, optional

                  • StateOther string, optional

                  • Zip string, optional

                  • CountryId integer, optional

              • CheckBoxFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Checked boolean, optional

              • DateFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Value string, optional

              • EmailFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Value string, optional

              • ImageUploadFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • UploadId string, optional

                • ImageFileName string, optional

              • MultiLineTextFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Value string, optional

              • MultiSelectPickListFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • SelectedOptionsIds array, optional

              • NumberFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Value number, optional

              • PercentageFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Value number, optional

              • PhoneFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Value string, optional

              • PickListFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • SelectedOptionId integer, optional

              • RatingFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Value number, optional

              • SingleLineTextFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Value string, optional

              • TagsFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Tags array, optional

              • WebSiteFormFieldValueDto

                 child attributes
                • FormFieldId integer, optional

                • FieldName string, optional

                • TypeName string, optional

                • Id integer, optional

                • Value string, optional

        • MemberFormDynamicDataSet object, optional

           child attributes
          • FormId integer, optional

          • FormFieldValues array, optional

              item types
            • AddressFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Address object, optional

                 child attributes
                • StateCode string, optional

                • CountryName string, optional

                • Street string, optional

                • Street2 string, optional

                • City string, optional

                • StateId integer,null, optional

                • StateOther string, optional

                • Zip string, optional

                • CountryId integer, optional

            • CheckBoxFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Checked boolean, optional

            • DateFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Value string, optional

            • EmailFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Value string, optional

            • ImageUploadFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • UploadId string, optional

              • ImageFileName string, optional

            • MultiLineTextFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Value string, optional

            • MultiSelectPickListFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • SelectedOptionsIds array, optional

            • NumberFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Value number, optional

            • PercentageFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Value number, optional

            • PhoneFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Value string, optional

            • PickListFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • SelectedOptionId integer, optional

            • RatingFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Value number, optional

            • SingleLineTextFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Value string, optional

            • TagsFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Tags array, optional

            • WebSiteFormFieldValueDto

               child attributes
              • FormFieldId integer, optional

              • FieldName string, optional

              • TypeName string, optional

              • Id integer, optional

              • Value string, optional

      • Membership object, optional

         child attributes
        • Id integer, optional

        • Name string, optional

        • Description string, optional

        • Price number, optional

        • IsActive boolean, optional

        • Frequency one of Day, Week, Month, Year, OneTime, optional

        • ApplyExpirationRule boolean, optional

        • ExpirationRule object, optional

           child attributes
          • TimePeriod one of Day, Week, Month, Year, OneTime, optional

          • TimeAmount integer, optional

        • Benefits array, optional

           item attributes
          • Id integer, optional

          • Name string, optional

          • TotalQuantity integer, optional

          • IsGroup boolean, optional

          • IsPercent boolean, optional

          • DiscountAmount number, optional

          • AppliedTo array, optional

             item attributes
            • EventId integer, optional

            • EventName string, optional

            • EventInstanceId integer, optional

            • TicketTypeId integer, optional

            • TicketTypeName string, optional

          • QuantityRanges array, optional

             item attributes
            • Id integer, optional

            • StartQuantity integer, optional

            • EndQuantity integer, optional

            • IsPercentDiscount boolean, optional

            • DiscountAmount number, optional

          • LimitPerOrder integer, optional

        • EventgridFeePayer one of Promoter, Customer, optional

        • EventgridFeeAmount number, optional

        • CreditCardFeePayer one of Promoter, Customer, optional

        • CreditCardFeeAmount number, optional

        • ApplyServiceFee boolean, optional

        • ServiceFee object, optional

           child attributes
          • IsPercent boolean, optional

          • Rate number, optional

          • MinValue number, optional

          • MaxValue number, optional

        • ServiceFeeAmount number, optional

        • AllowBenefits boolean, optional

        • MembersCount integer, optional

      • MembershipSubscriptionPaymentPlan object, optional

         child attributes
        • NameOnCard string, optional

        • CardType string, optional

        • Last4Digits string, optional

        • ExpiresMonth integer, optional

        • ExpiresYear integer, optional

      • Payments array, optional

         item attributes
        • Id integer, optional

        • MembershipId integer, optional

        • MembershipSubscriptionId integer, optional

        • OrderId integer, optional

        • SubmittedAt string, optional

        • DiscountAmount number, optional

        • TotalAmount number, optional

        • Status one of Success, Failure, optional

      • IsActive boolean, optional

      • SubscribedAt string, optional

      • ExpiresAt string, optional

      • NextPaymentAt string, optional

      • Status one of Created, Active, LastPaymentFailed, Cancelled, Expired, Frozen, optional

      • AvailableBenefits array, optional

         item attributes
        • MembershipBenefitId integer, optional

        • AvailableCount integer, optional

      • CancellationReason string, optional

      • CancelledAt string, optional

      • FreezeReason string, optional

      • FrozenAt string, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    GET https://api.eventgrid.com/2.0/customer-api/businesses/{businessId}/contacts/{contactId}/membership-subscriptions
    HTTP status code 200
    {  
        "membershipSubscriptions":[  
            {  
                "id":1100,
                "member":{  
                    "contact":{  
                        "id":218752,
                        "firstName":"Contact",
                        "lastName":"Sample",
                        "email":"contactsample@email.com",
                        "address":null,
                        "phone":null,
                        "contactFormDynamicDataSet":null
                    },
                    "memberFormDynamicDataSet":null
                },
                "membership":{  
                    "id":1239,
                    "name":"Common Membership",
                    "description":null,
                    "price":10.00,
                    "isActive":true,
                    "frequency":2,
                    "applyExpirationRule":false,
                    "expirationRule":{  
                        "timePeriod":2,
                        "timeAmount":1
                    },
                    "benefits":[],
                    "eventgridFeePayer":0,
                    "eventgridFeeAmount":0.0,
                    "creditCardFeePayer":0,
                    "creditCardFeeAmount":0.0,
                    "applyServiceFee":false,
                    "serviceFee":null,
                    "serviceFeeAmount":0.0,
                    "allowBenefits":false,
                    "membersCount":1
                },
                "membershipSubscriptionPaymentPlan":{  
                    "nameOnCard":"Contact Sample",
                    "cardType":"Visa",
                    "last4Digits":"4242",
                    "expiresMonth":2,
                    "expiresYear":2022
                },
                "payments":[  
                    {  
                        "id":1012,
                        "membershipId":1239,
                        "membershipSubscriptionId":1100,
                        "orderId":149586,
                        "submittedAt":"2016-04-15T11:56:43.383",
                        "discountAmount":0.0,
                        "totalAmount":10.00,
                        "status":1
                    }
                ],
                "isActive":false,
                "subscribedAt":"2016-04-15T11:56:43.383",
                "expiresAt":null,
                "nextPaymentAt":"2016-05-15T04:00:00",
                "status":1,
                "availableBenefits":null,
                "cancellationReason":null,
                "cancelledAt":null,
                "freezeReason":null,
                "frozenAt":null
            }
        ],
        "isSuccess":true,
        "error":null,
        "argumentErrors":[]
    }

    Events

    Events are created in your Business Admin account and used to make orders.

    List events

    Returns a list of your events. Result can be filtered by Venue Id, Business Id, StartAt Date, sorted by Id and Name an limited by page size and index.

    Query Parameters
    • sortBy string, default: Id, optional

      Sort field

      Available options:

      Id,Name,Distance,FirstEventInstanceStartsAt

    • sortDirection enum , default: Ascending,, optional

      Sort direction

      Available options:

      Ascending,Descending

    • apiKey string required

      API Key

    • PageSize integer, default: 10, minimum: 1, maximum: 100 required

    • PageIndex integer, default: 1, minimum: 1, maximum: 10000 required

    • startsAtFrom string, optional

      A cursor for use in pagination. Search for events that have Event Instances with startDateTime after startsAtFrom.

    • startsAtTo string, optional

      A cursor for use in pagination. Search for events that have Event Instances with startDateTime before startsAtTo.

    • endsAtFrom string, optional

      A cursor for use in pagination. Search for events that have Event Instances with endDateTime after endsAtFrom.

    • endsAtTo string, optional

      A cursor for use in pagination. Search for events that have Event Instances with endDateTime before endsAtTo.

    • venueId integer, optional

    • businessId integer, optional

    • zipCode string, optional

    • zipCodeRadius integer, optional

    • countryId integer, optional

    • state string, optional

    • city string, optional

    • name string, optional

      Event title

    • skipNonPublishedEvents boolean, default: true, optional

      Hide draft events. True by default

    • loadOptions string, optional

      Comma-delimited list of load options

      Available options:

      All - load all object fields
      Instances - load event instances
      TicketTypes - load ticket types
      TicketTypeSeats - load seats and ticket types assigned to them
      Organizer - load organizer
      InstanceStats - load event instance with seats
      CancellationPolicy - load cancellation policy
      Speakers - load speakers
      Schedule - load schedule
      ScheduleSpeakers - load schedule with speakers
      Base - load tags, venue, business subscription, business payment settings
      OrderForms - load order forms and its fields
      Products - load products assigned to event
      UserAcceptsInfo - load info that user should accept
      OrderFormsForAdmin - load order form that only visible for admin and its fileds

    Response
    • TotalPages integer, optional

    • TotalItems integer, optional

    • Items array, optional

       item attributes
      • Id integer, optional

      • Title string, optional

      • Description string, optional

      • CancellationPolicy string, optional

      • TimeZoneCode string, optional

      • TimeZoneName string, optional

      • Type one of Tickets, Registrations, RSVP, Fundraiser, optional

      • Venue object, optional

         child attributes
        • Id integer,null, optional

        • Name string, optional

        • Address object, optional

           child attributes
          • Id integer,null, optional

          • Country object, optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

          • State object, optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

            • Code string, optional

          • City string, optional

          • Street string, optional

          • Street2 string, optional

          • Zip string, optional

          • Lat number,null, optional

          • Lon number,null, optional

        • HasReservedSeatings boolean, optional

        • HasParking boolean, optional

        • Category string, optional

        • WebSite string, optional

        • NumParkingSpots integer,null, optional

        • Description string, optional

        • Images array, optional

           item attributes
          • Url string, optional

      • Instances array, optional

         item attributes
        • Id integer,null, optional

        • StartDateTime string, optional

        • EndDateTime string, optional

        • Event object, optional

        • Status one of Active, Cancelled, optional

      • Organizer object, optional

         child attributes
        • Name string, optional

        • WebSite string, optional

        • Phone string, optional

        • Email string, optional

        • Description string, optional

        • Address object, optional

           child attributes
          • Id integer,null, optional

          • Country object, optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

          • State object, optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

            • Code string, optional

          • City string, optional

          • Street string, optional

          • Street2 string, optional

          • Zip string, optional

          • Lat number,null, optional

          • Lon number,null, optional

      • TicketTypes array, optional

         item attributes
        • Pos integer, optional

        • MinTicketsPerOrder integer, optional

        • MaxTicketsPerOrder integer, optional

        • Type one of Paid, Free, Donation, RSVP, optional

        • SeatIds array, optional

        • SeatColor string, optional

        • PriceType one of Single, Multiple, optional

        • Hidden boolean, optional

        • HasWaitList boolean, optional

        • FormFields array, optional

            item types
          • FormFieldDto2

             child attributes
            • Id integer, optional

            • Label string, optional

            • Description string, optional

            • Pos integer, optional

            • IsRequired boolean, optional

            • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

          • DateFormFieldDto2

             child attributes
            • MinDate string, optional

            • MaxDate string, optional

            • Id integer, optional

            • Label string, optional

            • Description string, optional

            • Pos integer, optional

            • IsRequired boolean, optional

            • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

          • PickListFormFieldDto2

             child attributes
            • Options array, optional

               item attributes
              • Id integer, optional

              • Text string, optional

            • AllowMultiple boolean, optional

            • Id integer, optional

            • Label string, optional

            • Description string, optional

            • Pos integer, optional

            • IsRequired boolean, optional

            • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

          • RadioGroupFormFieldDto2

             child attributes
            • Options array, optional

               item attributes
              • Id integer, optional

              • Text string, optional

            • Id integer, optional

            • Label string, optional

            • Description string, optional

            • Pos integer, optional

            • IsRequired boolean, optional

            • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

          • RatingFormFieldDto2

             child attributes
            • MinRating integer, optional

            • MaxRating integer, optional

            • AllowHalf boolean, optional

            • Id integer, optional

            • Label string, optional

            • Description string, optional

            • Pos integer, optional

            • IsRequired boolean, optional

            • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

        • EventInstanceTicketTypes array, optional

           item attributes
          • Id integer, optional

          • EventInstanceId integer, optional

          • SaleStartAt string, optional

          • SaleEndAt string, optional

        • CanAssignSeats boolean, optional

        • Id integer,null, optional

        • Name string, optional

        • Description string, optional

        • Variants array, optional

           item attributes
          • Id integer,null, optional

          • Name string, optional

          • Price number,null, optional

        • DoNotCollectGuestInfo boolean, optional

        • IsAddon boolean, optional

      • Sessions array, optional

         item attributes
        • Id integer, optional

        • IsRequired boolean, optional

        • StartsAt string, optional

        • EndsAt string, optional

        • Type one of Single, Multi, optional

        • Items array, optional

           item attributes
          • Name string, optional

          • Description string, optional

          • Quantity integer,null, optional

          • Price number,null, optional

          • Location object, optional

             child attributes
            • VenueId integer, optional

            • Name string, optional

          • Speakers array, optional

             item attributes
            • Id integer, optional

            • Name string, optional

            • Title string, optional

            • Description string, optional

            • Photo string, optional

          • Id integer, optional

          • Track string, optional

          • TicketTypeIds array, optional

          • AllTicketTypes boolean, optional

      • Speakers array, optional

         item attributes
        • Id integer, optional

        • Name string, optional

        • Title string, optional

        • Description string, optional

        • Photo string, optional

      • Business object, optional

         child attributes
        • Id integer, optional

        • BrandId integer, optional

        • Name string, optional

        • Address object, optional

           child attributes
          • Id integer,null, optional

          • Country object, optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

          • State object, optional

             child attributes
            • Id integer,null, optional

            • Name string, optional

            • Code string, optional

          • City string, optional

          • Street string, optional

          • Street2 string, optional

          • Zip string, optional

          • Lat number,null, optional

          • Lon number,null, optional

        • WebSite string, optional

        • Phone string, optional

        • Email string, optional

        • TimeZoneName string, optional

        • PaymentSettings object, optional

            child types
          • BusinessBraintreePaymentSettingsDto

             child attributes
            • ClientToken string, optional

            • PaymentProcessor , optional

               child attributes
              • Id integer,null, optional

              • Name string, optional

            • Currency object, optional

               child attributes
              • IsoCode string, optional

              • CultureInfoName string, optional

              • Id integer,null, optional

              • Name string, optional

            • UseCardFlight boolean, optional

            • CardFlightMerchantAccount object, optional

               child attributes
              • Token string, optional

              • DeveloperApiKey string, optional

            • IsPaymentProcessorSetup boolean, optional

          • BusinessCardSmithPaymentSettingsDto

             child attributes
            • MerchantId string, optional

            • TerminalId string, optional

            • PaymentProcessor , optional

               child attributes
              • Id integer,null, optional

              • Name string, optional

            • Currency object, optional

               child attributes
              • IsoCode string, optional

              • CultureInfoName string, optional

              • Id integer,null, optional

              • Name string, optional

            • UseCardFlight boolean, optional

            • CardFlightMerchantAccount object, optional

               child attributes
              • Token string, optional

              • DeveloperApiKey string, optional

            • IsPaymentProcessorSetup boolean, optional

          • BusinessPaypalPaymentSettingsDto

             child attributes
            • PayPalEmail string, optional

            • PaymentProcessor , optional

               child attributes
              • Id integer,null, optional

              • Name string, optional

            • Currency object, optional

               child attributes
              • IsoCode string, optional

              • CultureInfoName string, optional

              • Id integer,null, optional

              • Name string, optional

            • UseCardFlight boolean, optional

            • CardFlightMerchantAccount object, optional

               child attributes
              • Token string, optional

              • DeveloperApiKey string, optional

            • IsPaymentProcessorSetup boolean, optional

          • BusinessStripeConnectPaymentSettingsDto

             child attributes
            • PublishableApiKey string, optional

            • PaymentProcessor , optional

               child attributes
              • Id integer,null, optional

              • Name string, optional

            • Currency object, optional

               child attributes
              • IsoCode string, optional

              • CultureInfoName string, optional

              • Id integer,null, optional

              • Name string, optional

            • UseCardFlight boolean, optional

            • CardFlightMerchantAccount object, optional

               child attributes
              • Token string, optional

              • DeveloperApiKey string, optional

            • IsPaymentProcessorSetup boolean, optional

          • BusinessSquarePaymentSettingsDto

             child attributes
            • LocationId string, optional

            • UseSquareRegister string, optional

            • ApplicationId string, optional

            • PaymentProcessor , optional

               child attributes
              • Id integer,null, optional

              • Name string, optional

            • Currency object, optional

               child attributes
              • IsoCode string, optional

              • CultureInfoName string, optional

              • Id integer,null, optional

              • Name string, optional

            • UseCardFlight boolean, optional

            • CardFlightMerchantAccount object, optional

               child attributes
              • Token string, optional

              • DeveloperApiKey string, optional

            • IsPaymentProcessorSetup boolean, optional

        • ContactForm object, optional

           child attributes
          • Id integer, optional

          • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

          • FormFields array, optional

             item attributes
            • Id integer, optional

            • FormId integer, optional

            • FieldId integer, optional

            • Field object, optional

                child types
              • FieldDto

                 child attributes
                • Id integer, optional

                • Name string, optional

                • Description string, optional

                • IsSystem boolean, optional

                • IsDynamic boolean, optional

                • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                • TypeName string, optional

              • DateFieldDto

                 child attributes
                • MinDate string, optional

                • MaxDate string, optional

                • Id integer, optional

                • Name string, optional

                • Description string, optional

                • IsSystem boolean, optional

                • IsDynamic boolean, optional

                • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                • TypeName string, optional

              • MultiSelectPickListFieldDto

                 child attributes
                • Options array, optional

                   item attributes
                  • Id integer, optional

                  • Text string, optional

                • Id integer, optional

                • Name string, optional

                • Description string, optional

                • IsSystem boolean, optional

                • IsDynamic boolean, optional

                • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                • TypeName string, optional

              • PickListFieldDto

                 child attributes
                • PickListType one of DropDown, RadioButtons, optional

                • Options array, optional

                   item attributes
                  • Id integer, optional

                  • Text string, optional

                • Id integer, optional

                • Name string, optional

                • Description string, optional

                • IsSystem boolean, optional

                • IsDynamic boolean, optional

                • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                • TypeName string, optional

              • NumberFieldDto

                 child attributes
                • MinNumber number, optional

                • MaxNumber number, optional

                • Id integer, optional

                • Label string, optional

                • Description string, optional

                • Pos integer, optional

                • IsRequired boolean, optional

                • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

              • RatingFieldDto

                 child attributes
                • MinRating integer, optional

                • MaxRating integer, optional

                • AllowHalf boolean, optional

                • Id integer, optional

                • Label string, optional

                • Description string, optional

                • Pos integer, optional

                • IsRequired boolean, optional

                • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

              • SingleLineTextFieldDto

                 child attributes
                • MinLength integer, optional

                • MaxLength integer, optional

                • Width integer, optional

                • Id integer, optional

                • Label string, optional

                • Description string, optional

                • Pos integer, optional

                • IsRequired boolean, optional

                • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

            • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

            • Status one of Required, Optional, Hidden, optional

            • Pos integer, optional

            • IsSection boolean, optional

            • IsEditable boolean, optional

            • IsReadOnly boolean, optional

            • ParentId integer,null, optional

            • IsAdminOnly boolean, optional

            • IsFromContactForm boolean, optional

          • Rules array, optional

             item attributes
            • Id integer, optional

            • Action one of Show, Hide, optional

            • TargetFormFieldId integer, optional

            • LogicalOperator one of Or, And, optional

            • Conditions array, optional

               item attributes
              • Id integer, optional

              • FormFieldId integer, optional

              • Operator one of Is, IsNot, StartsWith, EndsWith, Contains, GreaterThan, LessThan, optional

              • Pos integer, optional

        • NationBuilderSubdomain string, optional

        • NationBuilderAccessToken string, optional

        • Description string, optional

        • LogoUrl string, optional

        • CustomSubdomain string, optional

        • CreatedAt string, optional

        • HeaderBackgroundImage string, optional

        • MembershipSettings object, optional

           child attributes
          • MemberForm object, optional

             child attributes
            • Id integer, optional

            • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

            • FormFields array, optional

               item attributes
              • Id integer, optional

              • FormId integer, optional

              • FieldId integer, optional

              • Field object, optional

                  child types
                • FieldDto

                   child attributes
                  • Id integer, optional

                  • Name string, optional

                  • Description string, optional

                  • IsSystem boolean, optional

                  • IsDynamic boolean, optional

                  • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                  • TypeName string, optional

                • DateFieldDto

                   child attributes
                  • MinDate string, optional

                  • MaxDate string, optional

                  • Id integer, optional

                  • Name string, optional

                  • Description string, optional

                  • IsSystem boolean, optional

                  • IsDynamic boolean, optional

                  • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                  • TypeName string, optional

                • MultiSelectPickListFieldDto

                   child attributes
                  • Options array, optional

                     item attributes
                    • Id integer, optional

                    • Text string, optional

                  • Id integer, optional

                  • Name string, optional

                  • Description string, optional

                  • IsSystem boolean, optional

                  • IsDynamic boolean, optional

                  • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                  • TypeName string, optional

                • PickListFieldDto

                   child attributes
                  • PickListType one of DropDown, RadioButtons, optional

                  • Options array, optional

                     item attributes
                    • Id integer, optional

                    • Text string, optional

                  • Id integer, optional

                  • Name string, optional

                  • Description string, optional

                  • IsSystem boolean, optional

                  • IsDynamic boolean, optional

                  • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

                  • TypeName string, optional

                • NumberFieldDto

                   child attributes
                  • MinNumber number, optional

                  • MaxNumber number, optional

                  • Id integer, optional

                  • Label string, optional

                  • Description string, optional

                  • Pos integer, optional

                  • IsRequired boolean, optional

                  • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

                • RatingFieldDto

                   child attributes
                  • MinRating integer, optional

                  • MaxRating integer, optional

                  • AllowHalf boolean, optional

                  • Id integer, optional

                  • Label string, optional

                  • Description string, optional

                  • Pos integer, optional

                  • IsRequired boolean, optional

                  • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

                • SingleLineTextFieldDto

                   child attributes
                  • MinLength integer, optional

                  • MaxLength integer, optional

                  • Width integer, optional

                  • Id integer, optional

                  • Label string, optional

                  • Description string, optional

                  • Pos integer, optional

                  • IsRequired boolean, optional

                  • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

              • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

              • Status one of Required, Optional, Hidden, optional

              • Pos integer, optional

              • IsSection boolean, optional

              • IsEditable boolean, optional

              • IsReadOnly boolean, optional

              • ParentId integer,null, optional

              • IsAdminOnly boolean, optional

              • IsFromContactForm boolean, optional

            • Rules array, optional

               item attributes
              • Id integer, optional

              • Action one of Show, Hide, optional

              • TargetFormFieldId integer, optional

              • LogicalOperator one of Or, And, optional

              • Conditions array, optional

                 item attributes
                • Id integer, optional

                • FormFieldId integer, optional

                • Operator one of Is, IsNot, StartsWith, EndsWith, Contains, GreaterThan, LessThan, optional

                • Pos integer, optional

        • EventsCounters object, optional

           child attributes
          • PublishedEventsCount integer, optional

        • GoogleAnalyticsTrackingId string, optional

        • Subscription object, optional

           child attributes
          • Features array, optional

      • DisplayCountryListOnCF boolean, optional

      • LimitTicketsTotalQuantity boolean, optional

      • TicketsTotalQuantity integer,null, optional

      • CustomFeesLabel string, optional

      • LastUpdatedAt string, optional

      • HasSchedule boolean, optional

      • CollectGuestInfo boolean, optional

      • Stats object, optional

         child attributes
        • InstanceStats array, optional

           item attributes
          • EventInstanceId integer, optional

          • TicketsSold integer, optional

          • CheckedInCount integer, optional

          • TotalTicketsCount integer, optional

        • TotalTicketsForAllInstances integer, optional

        • Revenue number, optional

      • TicketForm object, optional

         child attributes
        • Id integer, optional

        • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

        • FormFields array, optional

           item attributes
          • Id integer, optional

          • FormId integer, optional

          • FieldId integer, optional

          • Field object, optional

              child types
            • FieldDto

               child attributes
              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • DateFieldDto

               child attributes
              • MinDate string, optional

              • MaxDate string, optional

              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • MultiSelectPickListFieldDto

               child attributes
              • Options array, optional

                 item attributes
                • Id integer, optional

                • Text string, optional

              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • PickListFieldDto

               child attributes
              • PickListType one of DropDown, RadioButtons, optional

              • Options array, optional

                 item attributes
                • Id integer, optional

                • Text string, optional

              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • NumberFieldDto

               child attributes
              • MinNumber number, optional

              • MaxNumber number, optional

              • Id integer, optional

              • Label string, optional

              • Description string, optional

              • Pos integer, optional

              • IsRequired boolean, optional

              • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

            • RatingFieldDto

               child attributes
              • MinRating integer, optional

              • MaxRating integer, optional

              • AllowHalf boolean, optional

              • Id integer, optional

              • Label string, optional

              • Description string, optional

              • Pos integer, optional

              • IsRequired boolean, optional

              • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

            • SingleLineTextFieldDto

               child attributes
              • MinLength integer, optional

              • MaxLength integer, optional

              • Width integer, optional

              • Id integer, optional

              • Label string, optional

              • Description string, optional

              • Pos integer, optional

              • IsRequired boolean, optional

              • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

          • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

          • Status one of Required, Optional, Hidden, optional

          • Pos integer, optional

          • IsSection boolean, optional

          • IsEditable boolean, optional

          • IsReadOnly boolean, optional

          • ParentId integer,null, optional

          • IsAdminOnly boolean, optional

          • IsFromContactForm boolean, optional

        • Rules array, optional

           item attributes
          • Id integer, optional

          • Action one of Show, Hide, optional

          • TargetFormFieldId integer, optional

          • LogicalOperator one of Or, And, optional

          • Conditions array, optional

             item attributes
            • Id integer, optional

            • FormFieldId integer, optional

            • Operator one of Is, IsNot, StartsWith, EndsWith, Contains, GreaterThan, LessThan, optional

            • Pos integer, optional

      • BuyerForm object, optional

         child attributes
        • Id integer, optional

        • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

        • FormFields array, optional

           item attributes
          • Id integer, optional

          • FormId integer, optional

          • FieldId integer, optional

          • Field object, optional

              child types
            • FieldDto

               child attributes
              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • DateFieldDto

               child attributes
              • MinDate string, optional

              • MaxDate string, optional

              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • MultiSelectPickListFieldDto

               child attributes
              • Options array, optional

                 item attributes
                • Id integer, optional

                • Text string, optional

              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • PickListFieldDto

               child attributes
              • PickListType one of DropDown, RadioButtons, optional

              • Options array, optional

                 item attributes
                • Id integer, optional

                • Text string, optional

              • Id integer, optional

              • Name string, optional

              • Description string, optional

              • IsSystem boolean, optional

              • IsDynamic boolean, optional

              • SystemFieldType one of FirstName, LastName, Email, Address, Phone, optional

              • TypeName string, optional

            • NumberFieldDto

               child attributes
              • MinNumber number, optional

              • MaxNumber number, optional

              • Id integer, optional

              • Label string, optional

              • Description string, optional

              • Pos integer, optional

              • IsRequired boolean, optional

              • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

            • RatingFieldDto

               child attributes
              • MinRating integer, optional

              • MaxRating integer, optional

              • AllowHalf boolean, optional

              • Id integer, optional

              • Label string, optional

              • Description string, optional

              • Pos integer, optional

              • IsRequired boolean, optional

              • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

            • SingleLineTextFieldDto

               child attributes
              • MinLength integer, optional

              • MaxLength integer, optional

              • Width integer, optional

              • Id integer, optional

              • Label string, optional

              • Description string, optional

              • Pos integer, optional

              • IsRequired boolean, optional

              • FieldType one of Address, SingleLineText, MultiLineText, CheckBox, Date, Email, PickList, RadioGroup, Rating, Number, Percentage, Phone, Website, ImageUpload, Tags, optional

          • FormType one of Buyer, Ticket, StoreCheckout, ContactForm, MemberForm, optional

          • Status one of Required, Optional, Hidden, optional

          • Pos integer, optional

          • IsSection boolean, optional

          • IsEditable boolean, optional

          • IsReadOnly boolean, optional

          • ParentId integer,null, optional

          • IsAdminOnly boolean, optional

          • IsFromContactForm boolean, optional

        • Rules array, optional

           item attributes
          • Id integer, optional

          • Action one of Show, Hide, optional

          • TargetFormFieldId integer, optional

          • LogicalOperator one of Or, And, optional

          • Conditions array, optional

             item attributes
            • Id integer, optional

            • FormFieldId integer, optional

            • Operator one of Is, IsNot, StartsWith, EndsWith, Contains, GreaterThan, LessThan, optional

            • Pos integer, optional

      • Status one of Draft, Published, UnPublished, optional

      • AllowRegisterForSessions boolean, optional

      • ForceDifferentAttendee boolean, optional

      • ProductItems array, optional

          item types
        • EventProductDto

           child attributes
          • Product object, optional

             child attributes
            • Id integer, optional

            • Name string, optional

            • Description string, optional

            • IsActive boolean, optional

            • TaxAmount number, optional

            • Variants array, optional

               item attributes
              • Id integer, optional

              • QuantityInStock integer, optional

              • SalePrice number, optional

              • Weight number, optional

              • Status one of NotAvailable, InStock, optional

              • Photo string, optional

          • Id integer, optional

          • Event object, optional

          • Pos integer, optional

          • IncludedTicketTypeIds array, optional

          • AllTicketTypesIncluded boolean, optional

        • EventProductTextDto

           child attributes
          • Title string, optional

          • Description string, optional

          • Id integer, optional

          • Event object, optional

          • Pos integer, optional

          • IncludedTicketTypeIds array, optional

          • AllTicketTypesIncluded boolean, optional

      • UserAcceptsInfo object, optional

         child attributes
        • HasCustomWaiver boolean, optional

        • WaiverHtml string, optional

        • ShowCancellationPolicy boolean, optional

        • CancellationPolicy string, optional

        • ShowBusinessTermsOfService boolean, optional

        • BusinessTermsOfService string, optional

      • SellProductsOnOrderPage boolean, optional

      • ProductsPageName string, optional

      • SchedulePageInfo object, optional

         child attributes
        • Title string, optional

        • Description string, optional

      • AllowPayByCheckOrWire boolean, optional

      • AddOneAttendeeAtTime boolean, optional

      • WireInstructionsHtml string, optional

      • IsAllDay boolean, optional

      • DoNotDefaultBuyerToFirstAttendee boolean, optional

      • HidePricingInformation boolean, optional

      • IsPrivate boolean, optional

      • CustomSubdomain string, optional

      • CustomDomain string, optional

      • Images array, optional

         item attributes
        • Url string, optional

      • HideCountdownTimer boolean, optional

      • BillingId string, optional

      • Tags array, optional

    • IsSuccess boolean, optional

    • Error object, optional

       child attributes
      • ErrorCode integer, optional

      • ErrorMessage string, optional

    • ArgumentErrors array, optional

       item attributes
      • ArgumentName string, optional

      • InlineErrorMessage string, optional

      • ErrorCode integer, optional

      • ErrorMessage string, optional

    GET https://api.eventgrid.com/2.0/customer-api/events/
    HTTP status code 200
    {  
        "totalPages":1,
        "totalItems":1,
        "items":[  
            {  
                "id":20484,
                "title":"VR Conference",
                "description":"",
                "logo":null,
                "cancellationPolicy":"",
                "timeZoneCode":"EDT",
                "timeZoneName":"Eastern Standard Time",
                "type":1,
                "venue":{  
                    "id":19979,
                    "name":"Expo Center",
                    "address":{  
                        "id":355086,
                        "country":{  
                            "id":1,
                            "name":"United States"
                        },
                        "state":{  
                            "id":47,
                            "name":"Vermont",
                            "code":"VT"
                        },
                        "city":"Dunellen",
                        "street":"200 Dunellen Av",
                        "street2":null,
                        "zip":"88017",
                        "lat":null,
                        "lon":null
                    },
                    "hasReservedSeatings":false,
                    "hasParking":false,
                    "category":null,
                    "webSite":null,
                    "numParkingSpots":null,
                    "description":null,
                    "images":[  
    
                    ],
                    "facebookLink":null,
                    "twitterLink":null,
                    "googlePluskLink":null,
                    "linkedInLink":null
                },
                "instances":[  
                    {  
                        "id":23619,
                        "startDateTime":"2020-06-15T14:00:00",
                        "endDateTime":"2020-06-18T00:00:00",
                        "event":null,
                        "status":0
                    }
                ],
                "organizer":{  
                    "name":"Eventgrid API Demo",
                    "webSite":null,
                    "phone":"(908) 616-3333",
                    "email":"api-demo@eventgrid.com",
                    "description":null,
                    "address":null,
                    "logo":null
                },
                "ticketTypes":[  
                    {  
                        "pos":0,
                        "minTicketsPerOrder":0,
                        "maxTicketsPerOrder":5,
                        "type":0,
                        "seatIds":[],
                        "seatColor":null,
                        "priceType":0,
                        "hidden":false,
                        "hasWaitList":false,
                        "formFields":[],
                        "eventInstanceTicketTypes":[  
                            {  
                                "id":12219,
                                "eventInstanceId":23619,
                                "saleStartAt":null,
                                "saleEndAt":null
                            }
                        ],
                        "canAssignSeats":false,
                        "id":21015,
                        "name":"One Day Pass",
                        "description":"Attend one of the three days of the conference.",
                        "variants":[  
                            {  
                                "id":24937,
                                "name":null,
                                "price":100.00
                            }
                        ],
                        "doNotCollectGuestInfo":false,
                        "isAddon":false
                    },
                    {  
                        "pos":1,
                        "minTicketsPerOrder":0,
                        "maxTicketsPerOrder":10,
                        "type":0,
                        "seatIds":[],
                        "seatColor":null,
                        "priceType":0,
                        "hidden":false,
                        "hasWaitList":false,
                        "formFields":[],
                        "eventInstanceTicketTypes":[  
                            {  
                                "id":12220,
                                "eventInstanceId":23619,
                                "saleStartAt":null,
                                "saleEndAt":null
                            }
                        ],
                        "canAssignSeats":false,
                        "id":21016,
                        "name":"Two Days Pass",
                        "description":"Attend any two days of the conference.",
                        "variants":[  
                            {  
                                "id":24938,
                                "name":null,
                                "price":180.00
                            }
                        ],
                        "doNotCollectGuestInfo":false,
                        "isAddon":false
                    },
                    {  
                        "pos":2,
                        "minTicketsPerOrder":0,
                        "maxTicketsPerOrder":10,
                        "type":0,
                        "seatIds":[],
                        "seatColor":null,
                        "priceType":0,
                        "hidden":false,
                        "hasWaitList":false,
                        "formFields":[],
                        "eventInstanceTicketTypes":[  
                            {  
                                "id":12221,
                                "eventInstanceId":23619,
                                "saleStartAt":null,
                                "saleEndAt":null
                            }
                        ],
                        "canAssignSeats":false,
                        "id":21017,
                        "name":"Ultimate Pass",
                        "description":"All three conference days are included.",
                        "variants":[  
                            {  
                                "id":24939,
                                "name":null,
                                "price":250.00
                            }
                        ],
                        "doNotCollectGuestInfo":false,
                        "isAddon":false
                    }
                ],
                "sessions":[  
                    {  
                        "id":4411,
                        "isRequired":true,
                        "startsAt":"2020-06-15T14:00:00",
                        "endsAt":"2020-06-15T16:00:00",
                        "type":0,
                        "items":[  
                            {  
                                "name":"Conference Opening",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":null,
                                "speakers":[],
                                "id":5536,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4412,
                        "isRequired":true,
                        "startsAt":"2020-06-15T16:00:00",
                        "endsAt":"2020-06-15T18:00:00",
                        "type":0,
                        "items":[  
                            {  
                                "name":"Lunch",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":null,
                                "speakers":[],
                                "id":5537,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4413,
                        "isRequired":true,
                        "startsAt":"2020-06-15T18:00:00",
                        "endsAt":"2020-06-15T20:00:00",
                        "type":1,
                        "items":[  
                            {  
                                "name":"Sony VR (Conf room 1)",
                                "description":null,
                                "quantity":null,
                                "price":30.00,
                                "location":null,
                                "speakers":[],
                                "id":5538,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            },
                            {  
                                "name":"HTC Vive",
                                "description":null,
                                "quantity":null,
                                "price":60.00,
                                "location":null,
                                "speakers":[],
                                "id":5539,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            },
                            {  
                                "name":"Oculus Rift",
                                "description":null,
                                "quantity":null,
                                "price":50.00,
                                "location":null,
                                "speakers":[],
                                "id":5540,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4414,
                        "isRequired":true,
                        "startsAt":"2020-06-15T20:00:00",
                        "endsAt":"2020-06-15T22:00:00",
                        "type":0,
                        "items":[  
                            {  
                                "name":"Check out the Boothes",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":null,
                                "speakers":[],
                                "id":5541,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4415,
                        "isRequired":false,
                        "startsAt":"2020-06-16T14:00:00",
                        "endsAt":"2020-06-16T16:00:00",
                        "type":0,
                        "items":[  
                            {  
                                "name":"How will VR change the future?",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":null,
                                "speakers":[],
                                "id":5542,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4416,
                        "isRequired":true,
                        "startsAt":"2020-06-16T16:00:00",
                        "endsAt":"2020-06-16T18:00:00",
                        "type":0,
                        "items":[  
                            {  
                                "name":"Virtual Lunch",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":null,
                                "speakers":[],
                                "id":5543,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4417,
                        "isRequired":false,
                        "startsAt":"2020-06-16T18:00:00",
                        "endsAt":"2020-06-16T20:00:00",
                        "type":1,
                        "items":[  
                            {  
                                "name":"Movies in VR",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":null,
                                "speakers":[],
                                "id":5544,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            },
                            {  
                                "name":"Video Games in VR",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":null,
                                "speakers":[],
                                "id":5545,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4418,
                        "isRequired":false,
                        "startsAt":"2020-06-16T20:00:00",
                        "endsAt":"2020-06-16T22:00:00",
                        "type":0,
                        "items":[  
                            {  
                                "name":"Boothes and Demos",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":{  
                                    "venueId":19979,
                                    "name":"Big Hall"
                                },
                                "speakers":[],
                                "id":5546,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4419,
                        "isRequired":false,
                        "startsAt":"2020-06-17T14:00:00",
                        "endsAt":"2020-06-17T16:00:00",
                        "type":0,
                        "items":[  
                            {  
                                "name":"Relationships and VR",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":null,
                                "speakers":[],
                                "id":5547,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4420,
                        "isRequired":true,
                        "startsAt":"2020-06-17T16:00:00",
                        "endsAt":"2020-06-17T18:00:00",
                        "type":0,
                        "items":[  
                            {  
                                "name":"Virtual Lunch",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":null,
                                "speakers":[],
                                "id":5548,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4421,
                        "isRequired":false,
                        "startsAt":"2020-06-17T18:00:00",
                        "endsAt":"2020-06-17T20:00:00",
                        "type":0,
                        "items":[  
                            {  
                                "name":"Boothes and Demos",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":{  
                                    "venueId":19979,
                                    "name":"Big Hall"
                                },
                                "speakers":[ ],
                                "id":5549,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    },
                    {  
                        "id":4422,
                        "isRequired":true,
                        "startsAt":"2020-06-17T20:00:00",
                        "endsAt":"2020-06-17T22:00:00",
                        "type":0,
                        "items":[  
                            {  
                                "name":"Closing Ceremony",
                                "description":null,
                                "quantity":null,
                                "price":0.00,
                                "location":null,
                                "speakers":[],
                                "id":5550,
                                "track":null,
                                "ticketTypeIds":[],
                                "allTicketTypes":true
                            }
                        ]
                    }
                ],
                "speakers":[],
                "business":{  
                    "id":31278,
                    "brandId":1,
                    "name":"Eventgrid API Demo",
                    "address":null,
                    "webSite":null,
                    "phone":"(908) 616-3333",
                    "email":"api-demo@eventgrid.com",
                    "timeZoneName":"Eastern Standard Time",
                    "paymentSettings":null,
                    "contactForm":null,
                    "nationBuilderSubdomain":null,
                    "nationBuilderAccessToken":null,
                    "logo":null,
                    "description":null,
                    "logoUrl":null,
                    "customSubdomain":null,
                    "createdAt":"2016-04-13T10:08:59.29",
                    "headerBackgroundImage":null,
                    "membershipSettings":{  
                        "memberForm":null
                    },
                    "eventsCounters":null,
                    "subscription":null,
                    "googleAnalyticsTrackingId":null
                },
                "displayCountryListOnCF":false,
                "limitTicketsTotalQuantity":false,
                "ticketsTotalQuantity":null,
                "customFeesLabel":null,
                "lastUpdatedAt":"2016-04-13T16:17:56.727",
                "hasSchedule":true,
                "collectGuestInfo":true,
                "stats":{  
                    "instanceStats":[  
                        {  
                            "eventInstanceId":23619,
                            "ticketsSold":0,
                            "checkedInCount":0,
                            "totalTicketsCount":8000
                        }
                    ],
                    "totalTicketsForAllInstances":8000,
                    "revenue":0.00
                },
                "ticketForm":{  
                    "id":16948,
                    "formType":2,
                    "formFields":[  
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95447,
                            "formId":16948,
                            "fieldId":24286,
                            "field":{  
                                "id":24286,
                                "name":"Personal Info",
                                "description":null,
                                "isSystem":false,
                                "isDynamic":false,
                                "systemFieldType":null,
                                "typeName":"SectionFieldDto"
                            },
                            "formType":2,
                            "status":1,
                            "pos":0,
                            "isSection":true,
                            "isEditable":true,
                            "isReadOnly":true,
                            "parentId":null,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95448,
                            "formId":16948,
                            "fieldId":3,
                            "field":{  
                                "minLength":null,
                                "maxLength":null,
                                "width":null,
                                "id":3,
                                "name":"First Name",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":1,
                                "typeName":"SingleLineTextFieldDto"
                            },
                            "formType":2,
                            "status":1,
                            "pos":1,
                            "isSection":false,
                            "isEditable":false,
                            "isReadOnly":false,
                            "parentId":95447,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95449,
                            "formId":16948,
                            "fieldId":4,
                            "field":{  
                                "minLength":null,
                                "maxLength":null,
                                "width":null,
                                "id":4,
                                "name":"Last Name",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":2,
                                "typeName":"SingleLineTextFieldDto"
                            },
                            "formType":2,
                            "status":1,
                            "pos":2,
                            "isSection":false,
                            "isEditable":false,
                            "isReadOnly":false,
                            "parentId":95447,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95450,
                            "formId":16948,
                            "fieldId":5,
                            "field":{  
                                "id":5,
                                "name":"Email",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":3,
                                "typeName":"EmailFieldDto"
                            },
                            "formType":2,
                            "status":1,
                            "pos":3,
                            "isSection":false,
                            "isEditable":false,
                            "isReadOnly":false,
                            "parentId":95447,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95451,
                            "formId":16948,
                            "fieldId":2,
                            "field":{  
                                "id":2,
                                "name":"Phone",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":5,
                                "typeName":"PhoneFieldDto"
                            },
                            "formType":2,
                            "status":3,
                            "pos":4,
                            "isSection":false,
                            "isEditable":true,
                            "isReadOnly":false,
                            "parentId":95447,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95452,
                            "formId":16948,
                            "fieldId":1,
                            "field":{  
                                "id":1,
                                "name":"Address",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":4,
                                "typeName":"AddressFieldDto"
                            },
                            "formType":2,
                            "status":3,
                            "pos":5,
                            "isSection":false,
                            "isEditable":true,
                            "isReadOnly":false,
                            "parentId":95447,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        }
                    ]
                },
                "buyerForm":{  
                    "id":16947,
                    "formType":1,
                    "formFields":[  
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95441,
                            "formId":16947,
                            "fieldId":24285,
                            "field":{  
                                "id":24285,
                                "name":"Billing Info",
                                "description":null,
                                "isSystem":false,
                                "isDynamic":false,
                                "systemFieldType":null,
                                "typeName":"SectionFieldDto"
                            },
                            "formType":1,
                            "status":1,
                            "pos":0,
                            "isSection":true,
                            "isEditable":true,
                            "isReadOnly":true,
                            "parentId":null,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95442,
                            "formId":16947,
                            "fieldId":3,
                            "field":{  
                                "minLength":null,
                                "maxLength":null,
                                "width":null,
                                "id":3,
                                "name":"First Name",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":1,
                                "typeName":"SingleLineTextFieldDto"
                            },
                            "formType":1,
                            "status":1,
                            "pos":1,
                            "isSection":false,
                            "isEditable":false,
                            "isReadOnly":false,
                            "parentId":95441,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95443,
                            "formId":16947,
                            "fieldId":4,
                            "field":{  
                                "minLength":null,
                                "maxLength":null,
                                "width":null,
                                "id":4,
                                "name":"Last Name",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":2,
                                "typeName":"SingleLineTextFieldDto"
                            },
                            "formType":1,
                            "status":1,
                            "pos":2,
                            "isSection":false,
                            "isEditable":false,
                            "isReadOnly":false,
                            "parentId":95441,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95444,
                            "formId":16947,
                            "fieldId":5,
                            "field":{  
                                "id":5,
                                "name":"Email",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":3,
                                "typeName":"EmailFieldDto"
                            },
                            "formType":1,
                            "status":1,
                            "pos":3,
                            "isSection":false,
                            "isEditable":false,
                            "isReadOnly":false,
                            "parentId":95441,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95445,
                            "formId":16947,
                            "fieldId":2,
                            "field":{  
                                "id":2,
                                "name":"Phone",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":5,
                                "typeName":"PhoneFieldDto"
                            },
                            "formType":1,
                            "status":3,
                            "pos":4,
                            "isSection":false,
                            "isEditable":true,
                            "isReadOnly":false,
                            "parentId":95441,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        },
                        {  
                            "includedTicketTypeIds":[],
                            "allTicketTypesIncluded":true,
                            "id":95446,
                            "formId":16947,
                            "fieldId":1,
                            "field":{  
                                "id":1,
                                "name":"Address",
                                "description":null,
                                "isSystem":true,
                                "isDynamic":false,
                                "systemFieldType":4,
                                "typeName":"AddressFieldDto"
                            },
                            "formType":1,
                            "status":3,
                            "pos":5,
                            "isSection":false,
                            "isEditable":true,
                            "isReadOnly":false,
                            "parentId":95441,
                            "isAdminOnly":false,
                            "isFromContactForm":false
                        }
                    ]
                },
                "status":1,
                "allowRegisterForSessions":true,
                "forceDifferentAttendee":false,
                "productItems":[  
                    {  
                        "product":{  
                            "id":78,
                            "name":"VR T-Shirt",
                            "description":"3D T-Shirt with hologram. Comes only in XXL.",
                            "isActive":true,
                            "taxAmount":0.00,
                            "variants":[  
                                {  
                                    "id":24944,
                                    "quantityInStock":2000,
                                    "salePrice":5.00,
                                    "weight":0.0,
                                    "status":1,
                                    "photo":"24944"
                                }
                            ],
                            "category":{  
                                "id":1057,
                                "name":"T-Shirts"
                            },
                            "photos":[  
                                {  
                                    "id":62,
                                    "fileUrl":"https://az663283.vo.msecnd.net/eventgrid/img/45b95da2-ff53-4e3e-a0bf-261c8e8ff83a.jpg"
                                }
                            ]
                        },
                        "id":44,
                        "event":{  
                            "id":20484,
                            "title":"VR Conference",
                            "description":"",
                            "logo":null,
                            "cancellationPolicy":null,
                            "timeZoneCode":"EDT",
                            "timeZoneName":"Eastern Standard Time",
                            "type":1,
                            "venue":{  
                                "id":19979,
                                "name":"Expo Center",
                                "address":{  
                                    "id":355086,
                                    "country":{  
                                        "id":1,
                                        "name":"United States"
                                    },
                                    "state":{  
                                        "id":47,
                                        "name":"Vermont",
                                        "code":"VT"
                                    },
                                    "city":"Dunellen",
                                    "street":"200 Dunellen Av",
                                    "street2":null,
                                    "zip":"88017",
                                    "lat":null,
                                    "lon":null
                                },
                                "hasReservedSeatings":false,
                                "hasParking":false,
                                "category":null,
                                "webSite":null,
                                "numParkingSpots":null,
                                "description":null,
                                "images":[],
                                "facebookLink":null,
                                "twitterLink":null,
                                "googlePluskLink":null,
                                "linkedInLink":null
                            },
                            "instances":null,
                            "organizer":null,
                            "ticketTypes":null,
                            "sessions":null,
                            "speakers":null,
                            "business":{  
                                "id":31278,
                                "brandId":1,
                                "name":"Eventgrid API Demo",
                                "address":null,
                                "webSite":null,
                                "phone":"(908) 616-3333",
                                "email":"api-demo@eventgrid.com",
                                "timeZoneName":"Eastern Standard Time",
                                "paymentSettings":null,
                                "contactForm":null,
                                "nationBuilderSubdomain":null,
                                "nationBuilderAccessToken":null,
                                "logo":null,
                                "description":null,
                                "logoUrl":null,
                                "customSubdomain":null,
                                "createdAt":"2016-04-13T10:08:59.29",
                                "headerBackgroundImage":null,
                                "membershipSettings":{  
                                    "memberForm":null
                                },
                                "eventsCounters":null,
                                "allowMyProfile":false
                            },
                            "displayCountryListOnCF":false,
                            "limitTicketsTotalQuantity":false,
                            "ticketsTotalQuantity":null,
                            "customFeesLabel":null,
                            "lastUpdatedAt":"2016-04-13T16:17:56.727",
                            "hasSchedule":true,
                            "collectGuestInfo":true,
                            "stats":null,
                            "ticketForm":null,
                            "buyerForm":null,
                            "status":1,
                            "allowRegisterForSessions":true,
                            "forceDifferentAttendee":false,
                            "productItems":null,
                            "userAcceptsInfo":null,
                            "sellProductsOnOrderPage":true,
                            "productsPageName":"VR T-Shirts",