/v1/participants

List the participants on an event.

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

Returns every participant on the given event (deleted participants are excluded). Pass include_conversations=true to include the messages sent to each participant.

To fetch a participant's automated reminder messages instead, see /v1/participants/{id}/auto_messages.

Example Result:

{
  participants: [ {
    id: 789,
    event_id: 123,
    display_name: "Fred Smith",
    name: "Fred Smith",
    phone: "650-555-1212",
    normalized_phone: "+16505551212",
    email: "[email protected]",
    state: "initial",
    check_in_state: "",
    link: "https://www.apptoto.com/p/abc123",
    reschedule_link: "https://www.apptoto.com/r/abc123",
    cancel_link: "https://www.apptoto.com/c/abc123",
    contact_id: 456,
    contact_external_id: "EXT-456",
    tags: "#vip"
  }]
}

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 of the event whose participants you want to list.

boolean
Defaults to false

If true, each participant includes a "conversations" array of any messages sent to them.

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!