Business - Events

Fetch event by ID

Endpoint

GET /api/v1/events/:event_id

Request

Route

GET /api/v1/events/44

Headers

Accept: application/json
Content-Type: application/json
App-Id: b9a749be-5418-4e46-a25f-fe6685829a8a
App-Secret: HpROg2g17jsbpYnIKwsg4uZuUpvc785kNvrYROJx
Franchise-Id: 232

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 956ffd63-6bf3-4760-92a8-1304c129266f
Content-Length: 3281

Body

{
  "meta": {
    "status": "ok"
  },
  "data": {
    "id": "44",
    "type": "event",
    "attributes": {
      "id": 44,
      "title": "Sarah and John's Wedding",
      "status": "confirmed",
      "formatted_status": "Confirmed",
      "formatted_status_with_context": "Confirmed",
      "booked_at": "2023-10-27T17:36:57.100-07:00",
      "created_at": "2023-10-27T17:36:57.103-07:00",
      "created_via": null,
      "venue_name": "The Mission Inn",
      "venue_address": "123 Some St",
      "venue_city": "Riverside",
      "venue_state": "CA",
      "venue_zip": "92506",
      "venue_map_url": "https://www.google.com/maps/search/123+Some+St%2C+Riverside%2C+CA%2C+92506",
      "venue_google_place_id": null,
      "public_notes": null,
      "private_notes": "",
      "coupon_code": null,
      "photo_album_url": null,
      "photo_album_instructions": null,
      "video_url": null,
      "video_album_instructions": null,
      "completed": false,
      "canceled": false,
      "postponed": false,
      "invoice_number": "20231027-01",
      "billable_distance": null,
      "total_distance": null,
      "distance_unit": null,
      "latitude": null,
      "longitude": null,
      "tax_rate": "0.0",
      "source": null,
      "estimated_number_guests": null,
      "indoor_outdoor": null,
      "lead_event_type": null,
      "contact_preference": null,
      "po_number": null,
      "stair_setup": null,
      "token": "R9P-AF9F-7X6",
      "utm_source": null,
      "utm_campaign": null,
      "utm_medium": null,
      "utm_term": null,
      "utm_content": null,
      "gclid": null,
      "starts_at": "2023-11-03T17:36:57.029-07:00",
      "ends_at": "2023-11-03T20:36:57.029-07:00",
      "length_in_minutes": "",
      "length_in_hours": "",
      "starting_balance": null,
      "starting_balance_cents": null,
      "starting_balance_currency": null,
      "starting_balance_formatted": null,
      "deposit_amount_due": null,
      "deposit_amount_due_cents": null,
      "deposit_amount_due_currency": null,
      "deposit_amount_due_formatted": null,
      "custom_deposit_amount": null,
      "custom_deposit_amount_cents": null,
      "custom_deposit_amount_currency": null,
      "custom_deposit_amount_formatted": null,
      "balance_amount_due": null,
      "balance_amount_due_cents": null,
      "balance_amount_due_currency": null,
      "balance_amount_due_formatted": null,
      "starts_at_date": "11-03-2023",
      "starts_at_date_iso8601": "2023-11-03",
      "starts_at_time": "5:36 PM",
      "invoice_date": "10-27-2023",
      "invoice_date_iso8601": "2023-10-27",
      "proposal_valid_through": null,
      "package_name": "",
      "package_group_name": "",
      "service_name": "",
      "package_description_html": "",
      "add_on_names": "",
      "backdrop_names": "",
      "design_statuses": null,
      "due_at": "2023-11-03T00:00:00.000-07:00",
      "customer_ids": "",
      "customer_names": "",
      "customer_emails": "",
      "customer_phones": "",
      "customer_and_contact_ids": "",
      "customer_and_contact_names": "",
      "customer_and_contact_emails": "",
      "customer_and_contact_phones": "",
      "additional_contact_ids": "",
      "additional_contact_names": "",
      "additional_contact_emails": "",
      "additional_contact_phones": "",
      "assigned_staff_ids": "",
      "assigned_staff_names": "",
      "assigned_staff_abbreviations": "",
      "assigned_staff_emails": "",
      "change_summary": null,
      "brand_id": 288,
      "brand_name": "Kling, Emmerich and Wilkinson 96",
      "primary_image": {
        "hero_variant": null
      },
      "booked_at_description": "Booked less than a minute ago",
      "current_user_assigned": false,
      "event_url": "https://subdomain97.cc.localhost/events/44-sarah-and-john-s-wedding?token=R9P-AF9F-7X6",
      "proposal_url": null,
      "referred_by_user_id": null,
      "referred_by_user_name": null,
      "referred_by_user_email": null
    },
    "relationships": {
      "event_bookings": {
        "data": [

        ]
      },
      "event_users": {
        "data": [

        ]
      },
      "event_staff_members": {
        "data": [

        ]
      },
      "event_staff_requests": {
        "data": [

        ]
      },
      "contacts": {
        "data": [

        ]
      },
      "notes": {
        "data": [

        ]
      }
    }
  }
}