Get event attendees

Get an event attendees

Path Parameters

companyID companyID required

The id of the company

eventID eventID required

The id of the event

Query Parameters

includeDeleted includeDeleted

Whether to include deleted users

Responses

• 200
• 400
• 404

---

List of event attendees

application/json

Schema

Example (from schema)

---

Schema

items object[]
List of event attendees
Array [
id string nullable
Unique ID a user
email string
Email of the user
status string
Possible values: [Invited, On Waitlist, Attending, Declined]
Status of the user
audience boolean
Whether the user is part of the audience
joinedAt date-time nullable
Date the user joined the event
joinedWaitlistAt date-time nullable
Date the user joined the waitlist
declinedAt date-time nullable
Date the user declined the event
checkedIn boolean
Whether the user was checked in
]

{
  "items": [
    {
      "id": "2e8f9915-fda0-450c-95a3-d61f93c66fa9",
      "email": "john.doe@at.cafe",
      "status": "Invited",
      "audience": true,
      "joinedAt": "2021-01-01T00:00:00.000Z",
      "joinedWaitlistAt": "2021-01-01T00:00:00.000Z",
      "declinedAt": "2021-01-01T00:00:00.000Z",
      "checkedIn": true
    }
  ]
}

An error when a parameter is missing

application/json

Schema

Example (from schema)

---

Schema

message string

Error message

{
  "message": "User not found"
}

An error when the event is not found

application/json

Schema

Example (from schema)

---

Schema

message string

Error message

{
  "message": "User not found"
}

Loading...