List attendees

GET/events/{event_id}/attendees

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:read

Path parameters

event_idintegerrequired

Event id

Query parameters

pageinteger

min 1 · default: 1

per_pageinteger

min 1 · max 100 · default: 25

Responses

200Success

itemsAttendee[]required

Show properties

Array of Attendee

idobjectrequired

first_nameobjectrequired

last_nameobjectrequired

emailobjectrequired

job_titleobjectrequired

rsvp_statusobjectrequired

Allowed:unconfirmedconfirmeddeclinedwaitlistedpending_approval

checkin_statusobjectrequired

Allowed:not_checked_inchecked_inchecked_out

qr_codeobjectrequired

created_atobjectrequired

phoneobjectrequired

companyobjectrequired

registration_type_idobjectrequired

event_idobjectrequired

fieldsAttendeeFieldValue[]required

Show properties

Array of AttendeeFieldValue

fieldAttendeeFieldrequired

Show properties

idobjectrequired

labelobjectrequired

requiredobjectrequired

positionobjectrequired

nameobjectrequired

typeobjectrequired

Allowed:accessibility_requirementsaddressbiocheckboxcompany_nameconsentcontact_phonecountrydatedate_of_birthdietary_requirementsdropdownemailexternal_idfacebook_accountfirst_namefull_namegendergithub_accountguestheadlinehome_addressinstagram_accountjob_titlelast_namelinkedin_accountlong_textnationalitynumberspacerparagraphpassport_numberradiosection_dividershipping_addressshort_textsocial_accounttelterm_and_consenttexttext_areatimetwitter_accounturlwork_addressyoutube_accountcaptchafile_uploadimage

optionsstring[]required

Show properties

One of:

string

string

number

number

boolean

boolean

string | number | boolean[]

Array of string | number | boolean

One of:

string

string

number

number

boolean

boolean

object

object

metadataPaginationMetadatarequired

Show properties

pageintegerrequired

per_pageintegerrequired

total_countintegerrequired

total_pagesintegerrequired

401Missing, invalid, expired, or revoked OAuth token

errorstring

404Not found

errorstring

429Rate limit exceeded

errorstring

Request

curl -X GET "http://localhost:3000/api/v2/events/0/attendees" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("http://localhost:3000/api/v2/events/0/attendees", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:3000/api/v2/events/0/attendees",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

{
  "items": [
    {
      "id": {},
      "first_name": {},
      "last_name": {},
      "email": {},
      "job_title": {},
      "rsvp_status": "unconfirmed",
      "checkin_status": "not_checked_in",
      "qr_code": {},
      "created_at": {},
      "phone": {},
      "company": {},
      "registration_type_id": {},
      "event_id": {},
      "fields": [
        {
          "field": {
            "id": {},
            "label": {},
            "required": {},
            "position": {},
            "name": {},
            "type": "accessibility_requirements",
            "options": [
              "string"
            ]
          },
          "value": "string"
        }
      ]
    }
  ],
  "metadata": {
    "page": 0,
    "per_page": 0,
    "total_count": 0,
    "total_pages": 0
  }
}

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}