Business - Events

Fetch all events

Endpoint

GET /api/v1/events

Parameters

Name Description
event_status Status (One of: proposal_date_open, proposal_date_reserved, proposal_awaiting_review, awaiting_signature, confirmed, any_proposal, any_confirmed, any_unsigned, canceled)
past_or_future When (One of: past, future)
event_date_start Event Date (Start)
event_date_end Event Date (End)
booked_date_start Booked Date (Start)
booked_date_end Booked Date (End)
package_id Package ID
text Text Search
sort_by Sort Order (One of Automatic, automatic, Event Date (Ascending), event_date_asc, Event Date (Descending), event_date_desc, Recently Booked, recently_booked_desc, Created (Descending), created_at_desc, Proposal Expiration, proposal_expiration_asc, Relevance, relevance)

Request

Route

GET /api/v1/events

Headers

Accept: application/json
Content-Type: application/json
App-Id: 8c817513-73fb-41b0-b831-10847ebda80e
App-Secret: clxrq9JdCsaWMtTmPMxidR5FWS7GguXXWPc6zJ3Q
Franchise-Id: 230

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: ca70e5e9-d7e6-4791-9583-e40a0e54416a
Content-Length: 3300

Body

{
  "meta": {
    "status": "ok",
    "total_count": 1,
    "per_page": 10
  },
  "data": [
    {
      "id": "43",
      "type": "event",
      "attributes": {
        "id": 43,
        "title": "Sarah and John's Wedding",
        "status": "confirmed",
        "formatted_status": "Confirmed",
        "formatted_status_with_context": "Confirmed",
        "booked_at": "2023-10-27T17:36:55.089-07:00",
        "created_at": "2023-10-27T17:36:55.092-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": "Q63-7DFW-399",
        "utm_source": null,
        "utm_campaign": null,
        "utm_medium": null,
        "utm_term": null,
        "utm_content": null,
        "gclid": null,
        "starts_at": "2023-11-03T17:36:55.020-07:00",
        "ends_at": "2023-11-03T20:36:55.020-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": 285,
        "brand_name": "Ullrich and Sons 93",
        "primary_image": {
          "hero_variant": null
        },
        "booked_at_description": "Booked less than a minute ago",
        "current_user_assigned": false,
        "event_url": "https://subdomain94.cc.localhost/events/43-sarah-and-john-s-wedding?token=Q63-7DFW-399",
        "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": [

          ]
        }
      }
    }
  ]
}