Preview an event page - Gratona Docs

GET

admin

events

{eventId}

preview

Preview an event page

curl --request GET \
  --url https://api.gratona.com/v1/admin/events/{eventId}/preview \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gratona.com/v1/admin/events/{eventId}/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/events/{eventId}/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/events/{eventId}/preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/events/{eventId}/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "Annual Gala",
  "slug": "annual-gala",
  "description": "Example",
  "type": "Example",
  "status": "draft",
  "visibility": "public",
  "search_indexing_enabled": false,
  "timezone": "Example",
  "starts_at": "2026-12-20T18:00:00Z",
  "ends_at": "2026-12-20T18:00:00Z",
  "registration_opens_at": "2026-12-20T18:00:00Z",
  "registration_closes_at": "2026-12-20T18:00:00Z",
  "location_name": "Example",
  "location_address": "Example",
  "public_location_mode": "hidden",
  "public_location_summary": "Example",
  "registration_identity_mode": "minimal_rsvp",
  "virtual_url": "<string>",
  "capacity": 1,
  "settings": {
    "show_sponsors": false,
    "allow_donation_addon": false,
    "allow_recurring_gift_ask": false,
    "allow_child_sponsorship_ask": false,
    "cover_fees_enabled": false,
    "processing_percentage": 1,
    "auction_enabled": false,
    "show_sponsor_packages": false
  },
  "id": 42,
  "client_id": 42,
  "cover_image_url": "Example",
  "currency": "USD",
  "location": {
    "mode": "internal",
    "label": "Example",
    "venue": "Example",
    "address": "Example",
    "map_allowed": false
  },
  "published_at": "2026-10-20T12:00:00Z",
  "completed_at": "2026-10-20T12:00:00Z",
  "registered_attendee_count": 42,
  "checked_in_count": 42,
  "readiness": [
    "<string>"
  ],
  "people": [
    {
      "id": 42,
      "role": "host",
      "display_name": "Example",
      "public_visibility": false,
      "sort_order": 42
    }
  ],
  "ticket_types": [
    {
      "id": 1,
      "client_id": 1,
      "event_id": 1,
      "name": "Annual Gala",
      "code": "Example",
      "description": "Example",
      "price": "25.00",
      "fair_market_value": "25.00",
      "quantity_available": 1,
      "quantity_sold": 1,
      "quantity_reserved": 1,
      "admissions_per_unit": 1,
      "registration_group_kind": "Example",
      "group_label_prompt": "Example",
      "attendee_details_timing": "Example",
      "waitlist_enabled": false,
      "min_per_order": 1,
      "max_per_order": 1,
      "attendee_details_required": false,
      "is_active": false,
      "visibility": "public",
      "sale_starts_at": "2026-10-20T12:00:00Z",
      "sale_ends_at": "2026-10-20T12:00:00Z",
      "sort_order": 1,
      "settings": {},
      "created_at": "2026-10-20T12:00:00Z",
      "updated_at": "2026-10-20T12:00:00Z",
      "deleted_at": "2026-10-20T12:00:00Z",
      "remaining_quantity": 42,
      "availability": {
        "state": "available",
        "reason": "Sales have not started."
      }
    }
  ],
  "questions": [
    {
      "id": 1,
      "client_id": 1,
      "event_id": 1,
      "scope": "Example",
      "field_key": "dietary_preferences",
      "field_label": "Dietary preferences",
      "field_type": "Example",
      "help_text": "Example",
      "options": [
        "Example"
      ],
      "applies_to_ticket_type_ids": [
        1
      ],
      "required": false,
      "is_active": false,
      "sort_order": 1,
      "created_at": "2026-10-20T12:00:00Z",
      "updated_at": "2026-10-20T12:00:00Z",
      "deleted_at": "2026-10-20T12:00:00Z"
    }
  ],
  "sponsor_packages": [
    {
      "id": 1,
      "client_id": 1,
      "event_id": 1,
      "name": "Annual Gala",
      "tier": "Example",
      "description": "Example",
      "price": "25.00",
      "fair_market_value": "25.00",
      "included_tickets": 1,
      "included_tables": 1,
      "quantity_available": 1,
      "quantity_sold": 1,
      "quantity_reserved": 1,
      "visibility": "public",
      "deliverables_template": [
        "<string>"
      ],
      "settings": {},
      "is_active": false,
      "sort_order": 1,
      "created_at": "2026-10-20T12:00:00Z",
      "updated_at": "2026-10-20T12:00:00Z",
      "deleted_at": "2026-10-20T12:00:00Z",
      "remaining_quantity": 42,
      "availability": {
        "state": "available",
        "reason": "Sales have not started."
      }
    }
  ],
  "tables": [
    "<string>"
  ],
  "auction_items": [
    {
      "id": 1,
      "client_id": 1,
      "event_id": 1,
      "name": "Annual Gala",
      "description": "Example",
      "fair_market_value": "25.00",
      "starting_bid": "25.00",
      "buy_now_price": "25.00",
      "quantity_available": 1,
      "quantity_sold": 1,
      "status": "draft",
      "visibility": "public",
      "sort_order": 1,
      "settings": {},
      "created_at": "2026-10-20T12:00:00Z",
      "updated_at": "2026-10-20T12:00:00Z",
      "deleted_at": "2026-10-20T12:00:00Z",
      "bid_summary": {
        "active_bid_count": 42,
        "awarded_count": 42,
        "bid_count": 42,
        "purchased_count": 42,
        "high_bid": 0,
        "settled_total": 0,
        "last_bid_at": "Example",
        "leader_at": "Example",
        "leader_signature": "Example",
        "leader_status": "Example",
        "winner": "Example"
      },
      "remaining_quantity": 42,
      "current_bid": 100,
      "minimum_bid": 110,
      "bid_count": 42
    }
  ],
  "availability": {
    "state": "draft",
    "reason": "Registration is open.",
    "boundary_at": "2026-10-20T12:00:00Z"
  },
  "registration_v2_enabled": false,
  "remove_branding": "0",
  "branding_program_id": 42,
  "resolved_app_brand": "gratona",
  "resolved_app_brand_source": "client",
  "organization": {
    "id": 42,
    "name": "Example Foundation"
  },
  "organization_name": "Example Foundation",
  "accepts_registrations": false,
  "preview": {
    "active": true,
    "banner": "Preview — this event is not live. Registration is disabled.",
    "writes_enabled": false
  },
  "conversion_paths": {
    "program_id": 42,
    "recipient_sponsorship_program_id": 42,
    "campaign_program_id": 42,
    "recipient_group_entity_id": 42,
    "designation_entity_id": 42,
    "trip_id": 42
  },
  "form_context": {
    "identity_mode": "minimal_rsvp",
    "program_id": 42,
    "hysform_id": 42,
    "show_standardized_fields": false,
    "signup_fields": [
      {
        "id": 42,
        "field_key": "favorite_program",
        "field_label": "Favorite program",
        "field_type": "hysText",
        "field_data": "Example",
        "required": 1,
        "field_order": 42,
        "donor_type": "Example",
        "conditional_display_rule": {}
      }
    ],
    "visible_standard_field_keys": [
      "email"
    ],
    "required_standard_field_keys": [
      "email"
    ],
    "standard_field_contract": {},
    "minimal_fields": [
      {
        "key": "first_name",
        "label": "First name",
        "required": false
      }
    ]
  },
  "payment_gateways": [
    {
      "key": "stripe",
      "label": "Credit card",
      "gateway": "Stripe",
      "available": false,
      "public_checkout_supported": false,
      "message": "Example",
      "payment_availability": {}
    }
  ],
  "payment_methods": [
    {
      "key": "stripe",
      "kind": "gateway",
      "payment_method": "card",
      "gateway": "stripe",
      "label": "Credit card",
      "available": false,
      "message": "Example",
      "instructions": "Example"
    }
  ],
  "metadata": {
    "title": "Annual Gala | Example Foundation",
    "description": "Join our annual gala.",
    "canonical": "Example",
    "robots": "index,follow",
    "open_graph": {},
    "json_ld": {}
  }
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "message": "Not Found",
  "status": "error"
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

eventId

integer

required

Record ID in the authenticated organization.

Example:

42

Response

Preview an event page completed.

name

string

Name.

Maximum string length: 255

Example:

"Annual Gala"

slug

string | null

Slug.

Maximum string length: 255

Pattern: ^[a-z0-9-]+$

Example:

"annual-gala"

description

string | null

Description.

Example:

"Example"

type

string | null

Type.

Maximum string length: 80

Example:

"Example"

status

enum<string> | null

Status.

Available options:

draft,

published,

registration_open,

registration_closed,

live,

completed,

reconciled,

archived,

null

Example:

"draft"

visibility

enum<string> | null

Visibility.

Available options:

public,

unlisted,

invite_only,

internal,

null

Example:

"public"

search_indexing_enabled

boolean | null

Search indexing enabled.

Example:

false

timezone

string | null

IANA timezone; legacy aliases are accepted except Factory. Omitted values use the organization timezone on creation.

Maximum string length: 64

Example:

"Example"

starts_at

string<date-time> | null

Starts at. Date without offset is interpreted in the event timezone.

Example:

"2026-12-20T18:00:00Z"

ends_at

string<date-time> | null

Ends at. Date without offset is interpreted in the event timezone. Must be at least starts_at.

Example:

"2026-12-20T18:00:00Z"

registration_opens_at

string<date-time> | null

Registration opens at. Date without offset is interpreted in the event timezone.

Example:

"2026-12-20T18:00:00Z"

registration_closes_at

string<date-time> | null

Registration closes at. Date without offset is interpreted in the event timezone.

Example:

"2026-12-20T18:00:00Z"

location_name

string | null

Location name.

Maximum string length: 255

Example:

"Example"

location_address

string | null

Location address.

Example:

"Example"

public_location_mode

enum<string> | null

Public location mode.

Available options:

hidden,

summary,

venue_only,

full,

null

Example:

"hidden"

public_location_summary

string | null

Public location summary.

Maximum string length: 255

Example:

"Example"

registration_identity_mode

enum<string> | null

Registration identity mode.

Available options:

minimal_rsvp,

organization_donor_form,

custom_event_fields,

null

Example:

"minimal_rsvp"

virtual_url

string | null

Always null in the public page projection.

capacity

integer | null

Capacity.

Required range: x >= 1

Example:

1

settings

object

Show child attributes

integer

Event ID.

Example:

42

client_id

integer

Organization ID.

Example:

42

cover_image_url

string | null

Cover image URL.

Example:

"Example"

currency

string

ISO currency code.

Example:

"USD"

location

object

Show child attributes

published_at

string<date-time> | null

First publication time.

Example:

"2026-10-20T12:00:00Z"

completed_at

string<date-time> | null

Completion time.

Example:

"2026-10-20T12:00:00Z"

registered_attendee_count

integer | null

Registered non-cancelled attendee count, when loaded.

Example:

42

checked_in_count

integer | null

Checked-in count, when loaded.

Example:

42

readiness

string[]

Empty in public projection.

people

object[]

Show child attributes

ticket_types

object[]

Show child attributes

questions

object[]

Setup rows; empty in compact mode.

Show child attributes

tables

string[]

Empty in public projection.

auction_items

object[]

Show child attributes

availability

object

Show child attributes

registration_v2_enabled

boolean

Whether grouped registration features are enabled.

Example:

false

remove_branding

enum<string>

Whether organization attribution is removed.

Available options:

0,

1

Example:

"0"

branding_program_id

integer | null

Branding program context.

Example:

42

resolved_app_brand

string

Resolved app brand.

Example:

"gratona"

resolved_app_brand_source

string

Source of brand resolution.

Example:

"client"

organization

object

Show child attributes

organization_name

string

Organization name.

Example:

"Example Foundation"

accepts_registrations

boolean

True only for an open, non-preview event.

Example:

false

preview

object | null

Show child attributes

conversion_paths

object

Show child attributes

form_context

object

Show child attributes

payment_gateways

object[]

Empty in previews.

Show child attributes

payment_methods

object[]

Empty in previews.

Show child attributes

metadata

object

Show child attributes

Preview an event page

curl --request GET \
  --url https://api.gratona.com/v1/admin/events/{eventId}/preview \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gratona.com/v1/admin/events/{eventId}/preview', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/events/{eventId}/preview",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/events/{eventId}/preview"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/events/{eventId}/preview")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "name": "Annual Gala",
  "slug": "annual-gala",
  "description": "Example",
  "type": "Example",
  "status": "draft",
  "visibility": "public",
  "search_indexing_enabled": false,
  "timezone": "Example",
  "starts_at": "2026-12-20T18:00:00Z",
  "ends_at": "2026-12-20T18:00:00Z",
  "registration_opens_at": "2026-12-20T18:00:00Z",
  "registration_closes_at": "2026-12-20T18:00:00Z",
  "location_name": "Example",
  "location_address": "Example",
  "public_location_mode": "hidden",
  "public_location_summary": "Example",
  "registration_identity_mode": "minimal_rsvp",
  "virtual_url": "<string>",
  "capacity": 1,
  "settings": {
    "show_sponsors": false,
    "allow_donation_addon": false,
    "allow_recurring_gift_ask": false,
    "allow_child_sponsorship_ask": false,
    "cover_fees_enabled": false,
    "processing_percentage": 1,
    "auction_enabled": false,
    "show_sponsor_packages": false
  },
  "id": 42,
  "client_id": 42,
  "cover_image_url": "Example",
  "currency": "USD",
  "location": {
    "mode": "internal",
    "label": "Example",
    "venue": "Example",
    "address": "Example",
    "map_allowed": false
  },
  "published_at": "2026-10-20T12:00:00Z",
  "completed_at": "2026-10-20T12:00:00Z",
  "registered_attendee_count": 42,
  "checked_in_count": 42,
  "readiness": [
    "<string>"
  ],
  "people": [
    {
      "id": 42,
      "role": "host",
      "display_name": "Example",
      "public_visibility": false,
      "sort_order": 42
    }
  ],
  "ticket_types": [
    {
      "id": 1,
      "client_id": 1,
      "event_id": 1,
      "name": "Annual Gala",
      "code": "Example",
      "description": "Example",
      "price": "25.00",
      "fair_market_value": "25.00",
      "quantity_available": 1,
      "quantity_sold": 1,
      "quantity_reserved": 1,
      "admissions_per_unit": 1,
      "registration_group_kind": "Example",
      "group_label_prompt": "Example",
      "attendee_details_timing": "Example",
      "waitlist_enabled": false,
      "min_per_order": 1,
      "max_per_order": 1,
      "attendee_details_required": false,
      "is_active": false,
      "visibility": "public",
      "sale_starts_at": "2026-10-20T12:00:00Z",
      "sale_ends_at": "2026-10-20T12:00:00Z",
      "sort_order": 1,
      "settings": {},
      "created_at": "2026-10-20T12:00:00Z",
      "updated_at": "2026-10-20T12:00:00Z",
      "deleted_at": "2026-10-20T12:00:00Z",
      "remaining_quantity": 42,
      "availability": {
        "state": "available",
        "reason": "Sales have not started."
      }
    }
  ],
  "questions": [
    {
      "id": 1,
      "client_id": 1,
      "event_id": 1,
      "scope": "Example",
      "field_key": "dietary_preferences",
      "field_label": "Dietary preferences",
      "field_type": "Example",
      "help_text": "Example",
      "options": [
        "Example"
      ],
      "applies_to_ticket_type_ids": [
        1
      ],
      "required": false,
      "is_active": false,
      "sort_order": 1,
      "created_at": "2026-10-20T12:00:00Z",
      "updated_at": "2026-10-20T12:00:00Z",
      "deleted_at": "2026-10-20T12:00:00Z"
    }
  ],
  "sponsor_packages": [
    {
      "id": 1,
      "client_id": 1,
      "event_id": 1,
      "name": "Annual Gala",
      "tier": "Example",
      "description": "Example",
      "price": "25.00",
      "fair_market_value": "25.00",
      "included_tickets": 1,
      "included_tables": 1,
      "quantity_available": 1,
      "quantity_sold": 1,
      "quantity_reserved": 1,
      "visibility": "public",
      "deliverables_template": [
        "<string>"
      ],
      "settings": {},
      "is_active": false,
      "sort_order": 1,
      "created_at": "2026-10-20T12:00:00Z",
      "updated_at": "2026-10-20T12:00:00Z",
      "deleted_at": "2026-10-20T12:00:00Z",
      "remaining_quantity": 42,
      "availability": {
        "state": "available",
        "reason": "Sales have not started."
      }
    }
  ],
  "tables": [
    "<string>"
  ],
  "auction_items": [
    {
      "id": 1,
      "client_id": 1,
      "event_id": 1,
      "name": "Annual Gala",
      "description": "Example",
      "fair_market_value": "25.00",
      "starting_bid": "25.00",
      "buy_now_price": "25.00",
      "quantity_available": 1,
      "quantity_sold": 1,
      "status": "draft",
      "visibility": "public",
      "sort_order": 1,
      "settings": {},
      "created_at": "2026-10-20T12:00:00Z",
      "updated_at": "2026-10-20T12:00:00Z",
      "deleted_at": "2026-10-20T12:00:00Z",
      "bid_summary": {
        "active_bid_count": 42,
        "awarded_count": 42,
        "bid_count": 42,
        "purchased_count": 42,
        "high_bid": 0,
        "settled_total": 0,
        "last_bid_at": "Example",
        "leader_at": "Example",
        "leader_signature": "Example",
        "leader_status": "Example",
        "winner": "Example"
      },
      "remaining_quantity": 42,
      "current_bid": 100,
      "minimum_bid": 110,
      "bid_count": 42
    }
  ],
  "availability": {
    "state": "draft",
    "reason": "Registration is open.",
    "boundary_at": "2026-10-20T12:00:00Z"
  },
  "registration_v2_enabled": false,
  "remove_branding": "0",
  "branding_program_id": 42,
  "resolved_app_brand": "gratona",
  "resolved_app_brand_source": "client",
  "organization": {
    "id": 42,
    "name": "Example Foundation"
  },
  "organization_name": "Example Foundation",
  "accepts_registrations": false,
  "preview": {
    "active": true,
    "banner": "Preview — this event is not live. Registration is disabled.",
    "writes_enabled": false
  },
  "conversion_paths": {
    "program_id": 42,
    "recipient_sponsorship_program_id": 42,
    "campaign_program_id": 42,
    "recipient_group_entity_id": 42,
    "designation_entity_id": 42,
    "trip_id": 42
  },
  "form_context": {
    "identity_mode": "minimal_rsvp",
    "program_id": 42,
    "hysform_id": 42,
    "show_standardized_fields": false,
    "signup_fields": [
      {
        "id": 42,
        "field_key": "favorite_program",
        "field_label": "Favorite program",
        "field_type": "hysText",
        "field_data": "Example",
        "required": 1,
        "field_order": 42,
        "donor_type": "Example",
        "conditional_display_rule": {}
      }
    ],
    "visible_standard_field_keys": [
      "email"
    ],
    "required_standard_field_keys": [
      "email"
    ],
    "standard_field_contract": {},
    "minimal_fields": [
      {
        "key": "first_name",
        "label": "First name",
        "required": false
      }
    ]
  },
  "payment_gateways": [
    {
      "key": "stripe",
      "label": "Credit card",
      "gateway": "Stripe",
      "available": false,
      "public_checkout_supported": false,
      "message": "Example",
      "payment_availability": {}
    }
  ],
  "payment_methods": [
    {
      "key": "stripe",
      "kind": "gateway",
      "payment_method": "card",
      "gateway": "stripe",
      "label": "Credit card",
      "available": false,
      "message": "Example",
      "instructions": "Example"
    }
  ],
  "metadata": {
    "title": "Annual Gala | Example Foundation",
    "description": "Join our annual gala.",
    "canonical": "Example",
    "robots": "index,follow",
    "open_graph": {},
    "json_ld": {}
  }
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "message": "Something went wrong. Please try again.",
  "status": "error",
  "error": "invalid_request",
  "code": "DONOR_NOT_FOUND"
}

{
  "message": "Not Found",
  "status": "error"
}