/v1/event

Fetch one event using an id.

Either id or external_id param

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Events contain many participants. Each participant can have different states.

The "state" property can be

  • initial
  • accepted (participant accepted booking message)
  • declined (participant declined booking message)
  • reminded (reminders have been sent)
  • confirmed (participant confirmed)
  • not_coming (participant cancelled)
  • not_coming_needs_reschedule
  • not_coming_no_reschedule

Example Result:

{
  id: 123,
  calendar_id: 456,
  start_time: "2016-04-15T12:00:00-07:00",
  end_time: "2016-04-15T13:00:00-07:00",
  title: "Appointment with Fred",
  location: "",
  content: "",
  is_deleted: false,
  participants: [ {
    id: 789,
    name: "Fred Smith",
    phone: "650-555-1212",
    normalized_phone: "+16505551212",
    email: "[email protected]",
    state: "initial", 
  }],
  custom_data: {
    field_1: "custom value"
  }
}

OAuth scope

Calls authenticated with an OAuth 2.0 bearer token must include the events:read scope. A token without it receives a 403 insufficient_scope response. HTTP Basic auth is not scope-gated.

Query Params
int32
required

The Apptoto id for the event

string

Your unique external id for the event. REQUIRED if you do not specify an id

Responses

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json