Get all attendee details

curl --request GET \
  --url https://api.zuddl.com/v1/events/{eventId}/attendees \
  --header 'Authorization: <api-key>'

{
  "pagination": {
    "next": "/{apiEndpoint}?page=3",
    "current": "/{apiEndpoint}?page=2",
    "previous": "/{apiEndpoint}?page=1"
  },
  "data": [
    {
      "kind": "<string>",
      "url": "<string>",
      "id": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397",
      "eventId": "d812a64f-8865-4289-9024-9a120792c3d8",
      "profile": {
        "firstName": "Jane",
        "lastName": "Smith",
        "email": "[email protected]",
        "company": "Zuddl",
        "designation": "Senior Software Engineer",
        "bio": "Jane is a senior engineer with over 10 years of experience in cloud architecture.",
        "headline": "Cloud Architecture Expert | Tech Speaker",
        "industry": "Information Technology",
        "country": "United States",
        "phoneNumber": "+1-2125551234",
        "profilePictureUrl": "https://cdn.zuddl.com/attendees/atnd_12345abcde/profile.jpg"
      },
      "customFieldsData": [
        {
          "fieldSlug": "city1",
          "value": "New York City"
        }
      ],
      "disclaimers": [
        {
          "text": "<p>I agree to the terms and conditions</p>",
          "consentGiven": true
        }
      ],
      "socialLinks": {
        "linkedin": "https://www.linkedin.com/company/zuddl",
        "twitter": "https://x.com/wearezuddl",
        "instagram": "https://www.instagram.com/wearezuddl",
        "facebook": "https://facebook.com/zuddl",
        "website": "https://www.zuddl.com"
      },
      "ticketDetails": {
        "ticketTypeId": "f6b8cf1f-64e5-4801-935c-f6398bb111cd",
        "ticketName": "VIP Pass",
        "promoCode": "SPRING2025",
        "addOns": [
          {
            "id": "67f6ccf5-4c3d-4fed-bcca-822e3c3cf25a",
            "name": "Advanced Workshop",
            "sessions": [
              {
                "id": "0b838477-24bf-46a7-a9bd-c40bfa2b2c53",
                "name": "Session name"
              }
            ]
          }
        ]
      },
      "qrCodeImgUrl": "https://cdn.zuddl.com/qrcodes/atnd_12345abcde.png",
      "confirmationCode": "01U6K9",
      "status": "REGISTERED",
      "statusUpdatedAt": "2025-04-07T09:57:55.71874Z",
      "statusSource": "MANUAL_UPDATE",
      "source": {
        "type": "ZUDDL_API",
        "referrer": "https://site.zuddl.com/landing-page",
        "utmParams": {
          "id": "123456",
          "source": "newsletter",
          "medium": "email",
          "campaign": "march_promo",
          "term": "newsletter",
          "content": "newsletter"
        },
        "metadata": {
          "key": "value"
        }
      },
      "roles": [
        "ATTENDEE",
        "SPEAKER"
      ],
      "unsubscribedNotificationDetails": [
        {
          "unsubscribeReason": "unsubscribeReasonExample",
          "categoryName": "PROMOTIONAL"
        }
      ],
      "createdAt": "2025-04-07T09:57:55.826749Z",
      "createdBy": "a412e3d2-e15e-4fe0-bf35-7fcfb235a4b2",
      "updatedAt": "2025-04-07T09:57:56.045946Z"
    }
  ]
}

GET

events

{eventId}

attendees

Get all attendee details

curl --request GET \
  --url https://api.zuddl.com/v1/events/{eventId}/attendees \
  --header 'Authorization: <api-key>'

{
  "pagination": {
    "next": "/{apiEndpoint}?page=3",
    "current": "/{apiEndpoint}?page=2",
    "previous": "/{apiEndpoint}?page=1"
  },
  "data": [
    {
      "kind": "<string>",
      "url": "<string>",
      "id": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397",
      "eventId": "d812a64f-8865-4289-9024-9a120792c3d8",
      "profile": {
        "firstName": "Jane",
        "lastName": "Smith",
        "email": "[email protected]",
        "company": "Zuddl",
        "designation": "Senior Software Engineer",
        "bio": "Jane is a senior engineer with over 10 years of experience in cloud architecture.",
        "headline": "Cloud Architecture Expert | Tech Speaker",
        "industry": "Information Technology",
        "country": "United States",
        "phoneNumber": "+1-2125551234",
        "profilePictureUrl": "https://cdn.zuddl.com/attendees/atnd_12345abcde/profile.jpg"
      },
      "customFieldsData": [
        {
          "fieldSlug": "city1",
          "value": "New York City"
        }
      ],
      "disclaimers": [
        {
          "text": "<p>I agree to the terms and conditions</p>",
          "consentGiven": true
        }
      ],
      "socialLinks": {
        "linkedin": "https://www.linkedin.com/company/zuddl",
        "twitter": "https://x.com/wearezuddl",
        "instagram": "https://www.instagram.com/wearezuddl",
        "facebook": "https://facebook.com/zuddl",
        "website": "https://www.zuddl.com"
      },
      "ticketDetails": {
        "ticketTypeId": "f6b8cf1f-64e5-4801-935c-f6398bb111cd",
        "ticketName": "VIP Pass",
        "promoCode": "SPRING2025",
        "addOns": [
          {
            "id": "67f6ccf5-4c3d-4fed-bcca-822e3c3cf25a",
            "name": "Advanced Workshop",
            "sessions": [
              {
                "id": "0b838477-24bf-46a7-a9bd-c40bfa2b2c53",
                "name": "Session name"
              }
            ]
          }
        ]
      },
      "qrCodeImgUrl": "https://cdn.zuddl.com/qrcodes/atnd_12345abcde.png",
      "confirmationCode": "01U6K9",
      "status": "REGISTERED",
      "statusUpdatedAt": "2025-04-07T09:57:55.71874Z",
      "statusSource": "MANUAL_UPDATE",
      "source": {
        "type": "ZUDDL_API",
        "referrer": "https://site.zuddl.com/landing-page",
        "utmParams": {
          "id": "123456",
          "source": "newsletter",
          "medium": "email",
          "campaign": "march_promo",
          "term": "newsletter",
          "content": "newsletter"
        },
        "metadata": {
          "key": "value"
        }
      },
      "roles": [
        "ATTENDEE",
        "SPEAKER"
      ],
      "unsubscribedNotificationDetails": [
        {
          "unsubscribeReason": "unsubscribeReasonExample",
          "categoryName": "PROMOTIONAL"
        }
      ],
      "createdAt": "2025-04-07T09:57:55.826749Z",
      "createdBy": "a412e3d2-e15e-4fe0-bf35-7fcfb235a4b2",
      "updatedAt": "2025-04-07T09:57:56.045946Z"
    }
  ]
}

Authorizations

Authorization

string

header

required

Provide your API key secret in the Authorization header

Path Parameters

eventId

string

required

Unique identifier of the event

Query Parameters

filter

string

Filter query in format:

Available filters:

createdAt: operations [gt, eq, lt, gte, lte, between]
profile.country: operations [eq, in]
profile.designation: operations [like, notlike]
profile.industry: operations [eq, in, like]
profile.lastName: operations [like, notlike]
profile.company: operations [like, notlike]
profile.firstName: operations [like, notlike]
status: operations [eq, in]
updatedAt: operations [gt, eq, lt, gte, lte, between]

sort

string

Sort query in format:

The following fields are sortable:

createdAt
profile.lastName
profile.firstName
updatedAt

page

number

Page number (default: 1)

size

number

Page size (default: 10, max: 50)

Response

List of attendees retrieved successfully

pagination

object

Show child attributes

pagination.next

string<uri>

URI of the next page. Also indicates the presence of a next page.

Example:

"/{apiEndpoint}?page=3"

pagination.current

string<uri>

URI of the current page.

Example:

"/{apiEndpoint}?page=2"

pagination.previous

string<uri>

URI of the previous page. Also indicates the presence of a previous page.

Example:

"/{apiEndpoint}?page=1"

data

object[]

Show child attributes

data.kind

string

data.url

string<uri>

data.id

string<uuid>

Unique Identifier of the event registration for the attendee

Example:

"d5e31ba5-2d1e-4918-bb60-dd1514b4b397"

data.eventId

string<uuid>

Unique identifier of the event for the attendee

Example:

"d812a64f-8865-4289-9024-9a120792c3d8"

data.profile

object

Profile details of the attendee

Show child attributes

data.profile.firstName

string

First name of the attendee

Example:

"Jane"

data.profile.lastName

string

Last name of the attendee

Example:

"Smith"

data.profile.email

string

Email address of the attendee

Example:

"[email protected]"

data.profile.company

string

Company name of the attendee

Example:

"Zuddl"

data.profile.designation

string

Title or designation of the attendee

Example:

"Senior Software Engineer"

data.profile.bio

string

Short biography of the attendee.

Example:

"Jane is a senior engineer with over 10 years of experience in cloud architecture."

data.profile.headline

string

Professional headline of the attendee

Example:

"Cloud Architecture Expert | Tech Speaker"

data.profile.industry

string

Industry of the attendee’s company

Example:

"Information Technology"

data.profile.country

string

Country of the attendee

Example:

"United States"

data.profile.phoneNumber

string

Phone number of the attendee

Example:

"+1-2125551234"

data.profile.profilePictureUrl

string

URL to the attendee’s profile picture

Example:

"https://cdn.zuddl.com/attendees/atnd_12345abcde/profile.jpg"

data.customFieldsData

object[]

Custom fields in the registration form

Show child attributes

data.customFieldsData.fieldSlug

string

Slug of the custom field

Example:

"city1"

data.customFieldsData.value

object

Value of the custom field

Example:

"New York City"

data.disclaimers

object[]

List of disclaimers

Show child attributes

data.disclaimers.text

string

Disclaimer rich text

Example:

"<p>I agree to the terms and conditions</p>"

Whether the attendee has given consent

Social media links of the attendee

Show child attributes

Attendee’s LinkedIn profile URL

Example:

"https://www.linkedin.com/company/zuddl"

Attendee’s Twitter profile URL

Example:

"https://x.com/wearezuddl"

Attendee’s GitHub profile URL

Example:

"https://www.instagram.com/wearezuddl"

Attendee’s Facebook profile URL

Example:

"https://facebook.com/zuddl"

Attendee’s personal website URL

Example:

"https://www.zuddl.com"

data.ticketDetails

object

Ticket and other related details

Show child attributes

data.ticketDetails.ticketTypeId

string

Unique identifier of the ticket type created on Zuddl

Example:

"f6b8cf1f-64e5-4801-935c-f6398bb111cd"

data.ticketDetails.ticketName

string

Ticket name

Example:

"VIP Pass"

Promo code

Example:

"SPRING2025"

data.ticketDetails.addOns

object[]

List of add-ons purchased for the ticket

Show child attributes

data.ticketDetails.addOns.id

string

Unique identifier of an add-on

Example:

"67f6ccf5-4c3d-4fed-bcca-822e3c3cf25a"

data.ticketDetails.addOns.name

string

Name of the add-on

Example:

"Advanced Workshop"

data.ticketDetails.addOns.sessions

object[]

Sessions included with this add-on

Show child attributes

data.ticketDetails.addOns.sessions.id

string

Unique identifier of the session

Example:

"0b838477-24bf-46a7-a9bd-c40bfa2b2c53"

data.ticketDetails.addOns.sessions.name

string

Name of the session

Example:

"Session name"

data.qrCodeImgUrl

string

URL of the attendee's QR code image

Example:

"https://cdn.zuddl.com/qrcodes/atnd_12345abcde.png"

data.confirmationCode

string

Confirmation code for registration

Example:

"01U6K9"

data.status

enum<string>

Status of the attendee

Available options:

PENDING,

REJECTED,

REGISTERED,

APPROVED_NOT_REGISTERED,

INCOMPLETE,

ATTENDED_VIRTUALLY,

ATTENDED_IN_PERSON,

ATTENDED_BOTH,

NO_SHOW

Example:

"REGISTERED"

data.statusUpdatedAt

string<date-time>

Timestamp when the attendee’s status was updated

Example:

"2025-04-07T09:57:55.71874Z"

data.statusSource

enum<string>

Source of the attendee's status

Available options:

MANUAL_UPDATE,

SYSTEM_UPDATE

Example:

"MANUAL_UPDATE"

data.source

object

Registration source details

Show child attributes

data.source.type

enum<string>

Type of registration source

Available options:

ATTENDEE_SIDE,

ORGANIZER_SIDE,

INTEGRATION,

LEAD_CAPTURE,

ZUDDL_API,

UNKNOWN

Example:

"ZUDDL_API"

data.source.referrer

string

Referrer information

Example:

"https://site.zuddl.com/landing-page"

data.source.utmParams

object

UTM parameters

Show child attributes

data.source.utmParams.id

string

UTM id

Example:

"123456"

data.source.utmParams.source

string

UTM source

Example:

"newsletter"

data.source.utmParams.medium

string

UTM medium

Example:

"email"

data.source.utmParams.campaign

string

UTM campaign

Example:

"march_promo"

data.source.utmParams.term

string

UTM term

Example:

"newsletter"

data.source.utmParams.content

string

UTM content

Example:

"newsletter"

data.source.metadata

object

Metadata associated with the registration source

Show child attributes

data.source.metadata.ipAddress

string

IP address of the device used for registration

Example:

"192.168.1.100"

data.source.metadata.deviceType

enum<string>

Type of device used for registration

Available options:

IOS,

ANDROID,

WEB,

DESKTOP,

MOBILE,

TABLET,

UNKNOWN

Example:

"DeviceType::MOBILE"

data.source.metadata.ipCity

string

City of the IP address

Example:

"New York"

data.source.metadata.ipCountry

string

Country of the IP address

Example:

"USA"

data.source.metadata.ipCountryIsoCode

string

ISO code of the country of the IP address

Example:

"US"

data.source.metadata.ipState

string

State or region of the IP address

Example:

"NY"

data.source.metadata.ipStateIsoCode

string

ISO code of the state or region of the IP address

Example:

"NY"

data.source.metadata.userAgent

string

User-agent string used by the user for registration

Example:

"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3"

data.source.metadata.latitude

string

Latitude of the IP address

Example:

"40.7128"

data.source.metadata.longitude

string

Longitude of the IP address

Example:

"-74.006"

data.source.metadata.osType

enum<string>

Operating system type used by the device for registration

Available options:

ANDROID,

IOS,

UNKNOWN

Example:

"OsType::IOS"

data.source.metadata.platformType

enum<string>

Platform type used by the device for registration

Available options:

WEB,

APP

Example:

"PlatformType::WEB"

Example:

{ "key": "value" }

data.roles

enum<string>[]

Roles of this attendee

Available options:

ATTENDEE,

ORGANIZER,

SPEAKER,

SPONSOR,

MODERATOR

Example:

["ATTENDEE", "SPEAKER"]

data.unsubscribedNotificationDetails

object[]

List of unsubscribed notification categories

Show child attributes

data.unsubscribedNotificationDetails.unsubscribeReason

string

Reason for unsubscribing from a notification category

Example:

"unsubscribeReasonExample"

data.unsubscribedNotificationDetails.categoryName

string

Category name of the notification that was unsubscribed from

Example:

"PROMOTIONAL"

Example:

[
  {
    "unsubscribeReason": "unsubscribeReasonExample",
    "categoryName": "PROMOTIONAL"
  }
]

data.createdAt

string<date-time>

Creation timestamp

Example:

"2025-04-07T09:57:55.826749Z"

data.createdBy

string

User ID of the creator

Example:

"a412e3d2-e15e-4fe0-bf35-7fcfb235a4b2"

data.updatedAt

string<date-time>

Update timestamp

Example:

"2025-04-07T09:57:56.045946Z"

Create a new location

Add an attendee

⌘I

API Reference

APIs

Get all attendee details

Authorizations

Path Parameters

Query Parameters

Response