> ## Documentation Index > Fetch the complete documentation index at: https://docs.zuddl.com/llms.txt > Use this file to discover all available pages before exploring further. # Get all attendee details > Use this endpoint to retrieve the details of all attendees added to a particular event type in your Zuddl organization. You can use query parameters such as filter, pagination, or sort to customize the response Required API key scopes: `READ` **This API can only be called with an access key that was generated for Backend usage.** ## OpenAPI ````yaml https://api.prod.zuddl.com/api/v3/api-docs/api-product get /v1/events/{eventId}/attendees openapi: 3.1.0 info: title: Zuddl API Documentation description: >- Zuddl RESTful APIs let you interact with the Zuddl platform and take action for your event or webinar. They let you add attendees, get attendee details, get event details, and more. The API response is returned in JSON, which your systems can easily consume. The API parameters allow you to customize the response using filters, sorting, pagination, and other parameters. Parameter values should be percent-encoded (URL-encoded) to ensure correct transmission, especially if they contain special characters such as spaces, semi-colons, or slashes. # Rate limits | Metrics | Value | | --- | --- | | Requests/second | 10 | | Burst or no. of concurrent calls allowed | 100 requests | | Total quota | 10000 requests/day | version: '1.0' servers: - url: https://api.zuddl.com/ security: - api_key: [] tags: - name: Events description: API endpoints for managing events - name: Attendees description: >- The attendee APIs let you add and retrieve attendee in a particular event type. - name: Sessions description: API endpoints for managing event sessions - name: Speakers description: API endpoints for managing event speakers - name: Sponsors description: API endpoints for managing event sponsors - name: Locations description: API endpoints for managing event locations paths: /v1/events/{eventId}/attendees: get: tags: - Attendees summary: Get all attendee details description: >- Use this endpoint to retrieve the details of all attendees added to a particular event type in your Zuddl organization. You can use query parameters such as filter, pagination, or sort to customize the response Required API key scopes: `READ` **This API can only be called with an access key that was generated for Backend usage.** operationId: getAttendees parameters: - name: eventId in: path description: Unique identifier of the event required: true schema: type: string pattern: >- ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$ example: 4fcebf73-3ddb-4fe6-b56d-5dd7dedb7c3d - name: filter in: query description: | Filter query in format: Available filters: - createdAt: operations [gt, lt, lte, between, gte, eq] - profile.country: operations [in, eq] - profile.designation: operations [like, not_like] - profile.industry: operations [in, like, eq] - profile.lastName: operations [like, not_like] - profile.firstName: operations [like, not_like] - profile.company: operations [like, not_like] - status: operations [in, eq] - updatedAt: operations [gt, lt, lte, between, gte, eq] required: false schema: type: string example: profile.firstName:like:Jane,createdAt:gt:2023-01-01T00:00:00Z - name: sort in: query description: | Sort query in format: The following fields are sortable: - createdAt - profile.lastName - profile.firstName - updatedAt required: false schema: type: string example: createdAt:desc,profile.firstName:asc - name: page in: query description: 'Page number (default: 1)' required: false schema: type: number example: '1' - name: size in: query description: 'Page size (default: 10, max: 50)' required: false schema: type: number example: '10' responses: '200': description: List of attendees retrieved successfully content: application/json: schema: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendeePage '400': description: Invalid event ID supplied content: application/json: schema: $ref: >- #/components/schemas/org.events.app._internal._response.v1.ApiErrorResponse '401': description: Unauthorized access to event content: application/json: schema: $ref: >- #/components/schemas/org.events.app._internal._response.v1.ApiErrorResponse '404': description: Event not found content: application/json: schema: $ref: >- #/components/schemas/org.events.app._internal._response.v1.ApiErrorResponse components: schemas: org.events.app.domain.api_product.event.attendee.dtos.EventAttendeePage: properties: pagination: $ref: >- #/components/schemas/org.events.app.domain.api_product.dtos.PageResponse.Pagination data: type: array items: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendee org.events.app._internal._response.v1.ApiErrorResponse: properties: timestamp: type: string format: date-time message: type: string description: type: string errors: type: object additionalProperties: type: string org.events.app.domain.api_product.dtos.PageResponse.Pagination: properties: next: type: string format: uri description: URI of the next page. Also indicates the presence of a next page. example: /{apiEndpoint}?page=3 current: type: string format: uri description: URI of the current page. example: /{apiEndpoint}?page=2 previous: type: string format: uri description: >- URI of the previous page. Also indicates the presence of a previous page. example: /{apiEndpoint}?page=1 org.events.app.domain.api_product.event.attendee.dtos.EventAttendee: properties: kind: type: string url: type: string format: uri id: type: string format: uuid description: Unique Identifier of the event registration for the attendee example: d5e31ba5-2d1e-4918-bb60-dd1514b4b397 eventId: type: string format: uuid description: Unique identifier of the event for the attendee example: d812a64f-8865-4289-9024-9a120792c3d8 profile: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.Profile customFieldsData: type: array description: Custom fields in the registration form items: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.CustomFieldData disclaimers: type: array description: List of disclaimers items: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.Disclaimer socialLinks: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.SocialLinks ticketDetails: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.TicketDetails qrCodeImgUrl: type: string description: URL of the attendee's QR code image example: https://cdn.zuddl.com/qrcodes/atnd_12345abcde.png confirmationCode: type: string description: Confirmation code for registration example: 01U6K9 status: type: string description: Status of the attendee enum: - PENDING - REJECTED - REGISTERED - APPROVED_NOT_REGISTERED - INCOMPLETE - ATTENDED_VIRTUALLY - ATTENDED_IN_PERSON - ATTENDED_BOTH - NO_SHOW example: REGISTERED statusUpdatedAt: type: string format: date-time description: Timestamp when the attendee’s status was updated example: '2025-04-07T09:57:55.71874Z' statusSource: type: string description: Source of the attendee's status enum: - MANUAL_UPDATE - SYSTEM_UPDATE example: MANUAL_UPDATE source: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.RegistrationSource roles: type: array description: Roles of this attendee example: - ATTENDEE - SPEAKER items: type: string description: Roles of this attendee enum: - ATTENDEE - ORGANIZER - SPEAKER - SPONSOR - MODERATOR example: '["ATTENDEE","SPEAKER"]' unsubscribedNotificationDetails: type: array description: List of unsubscribed notification categories example: - unsubscribeReason: unsubscribeReasonExample categoryName: PROMOTIONAL items: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.UnsubscribedNotificationDetail createdAt: type: string format: date-time description: Creation timestamp example: '2025-04-07T09:57:55.826749Z' createdBy: type: string description: User ID of the creator example: a412e3d2-e15e-4fe0-bf35-7fcfb235a4b2 updatedAt: type: string format: date-time description: Update timestamp example: '2025-04-07T09:57:56.045946Z' org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.Profile: description: Profile details of the attendee properties: firstName: type: string description: First name of the attendee example: Jane lastName: type: string description: Last name of the attendee example: Smith email: type: string description: Email address of the attendee example: jane.smith@example.com company: type: string description: Company name of the attendee example: Zuddl designation: type: string description: Title or designation of the attendee example: Senior Software Engineer bio: type: string description: Short biography of the attendee. example: >- Jane is a senior engineer with over 10 years of experience in cloud architecture. headline: type: string description: Professional headline of the attendee example: Cloud Architecture Expert | Tech Speaker industry: type: string description: Industry of the attendee’s company example: Information Technology country: type: string description: Country of the attendee example: United States phoneNumber: type: string description: Phone number of the attendee example: +1-2125551234 profilePictureUrl: type: string description: URL to the attendee’s profile picture example: https://cdn.zuddl.com/attendees/atnd_12345abcde/profile.jpg org.events.app.domain.api_product.event.attendee.dtos.CustomFieldData: description: Custom fields in the registration form properties: fieldSlug: type: string description: Slug of the custom field example: city1 value: type: object description: Value of the custom field example: New York City org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.Disclaimer: description: List of disclaimers properties: id: type: string format: uuid description: Legacy UUID identifier of the disclaimer created on Zuddl example: f6b8cf1f-64e5-4801-935c-f6398bb111cd slug: type: string description: >- Stable field ID of the disclaimer. Nullable for legacy disclaimers or registrations created before disclaimer slugs were stored. example: termsConsent text: type: string description: Disclaimer rich text example:

I agree to the terms and conditions

consentGiven: type: boolean description: Whether the attendee has given consent org.events.app.domain.api_product.event.attendee.dtos.SocialLinks: description: Social media links of the attendee properties: linkedin: type: string description: Attendee’s LinkedIn profile URL example: https://www.linkedin.com/company/zuddl twitter: type: string description: Attendee’s Twitter profile URL example: https://x.com/wearezuddl instagram: type: string description: Attendee’s GitHub profile URL example: https://www.instagram.com/wearezuddl facebook: type: string description: Attendee’s Facebook profile URL example: https://facebook.com/zuddl website: type: string description: Attendee’s personal website URL example: https://www.zuddl.com org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.TicketDetails: description: Ticket and other related details properties: ticketTypeId: type: string description: Unique identifier of the ticket type created on Zuddl example: f6b8cf1f-64e5-4801-935c-f6398bb111cd ticketName: type: string description: Ticket name example: VIP Pass promoCode: type: string description: Promo code example: SPRING2025 addOns: type: array description: List of add-ons purchased for the ticket items: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.TicketDetails.AddOn org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.RegistrationSource: description: Registration source details properties: type: type: string description: Type of registration source enum: - ATTENDEE_SIDE - ORGANIZER_SIDE - INTEGRATION - LEAD_CAPTURE - ZUDDL_API - UNKNOWN example: ZUDDL_API referrer: type: string description: Referrer information example: https://site.zuddl.com/landing-page utmParams: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.RegistrationSource.UTMParams metadata: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.RegistrationSource.SourceMetadata org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.UnsubscribedNotificationDetail: description: List of unsubscribed notification categories example: - unsubscribeReason: unsubscribeReasonExample categoryName: PROMOTIONAL properties: unsubscribeReason: type: string description: Reason for unsubscribing from a notification category example: unsubscribeReasonExample categoryName: type: string description: Category name of the notification that was unsubscribed from example: PROMOTIONAL org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.TicketDetails.AddOn: description: List of add-ons purchased for the ticket properties: id: type: string description: Unique identifier of an add-on example: 67f6ccf5-4c3d-4fed-bcca-822e3c3cf25a name: type: string description: Name of the add-on example: Advanced Workshop sessions: type: array description: Sessions included with this add-on items: $ref: >- #/components/schemas/org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.TicketDetails.AddOn.Session org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.RegistrationSource.UTMParams: description: UTM parameters properties: id: type: string description: UTM id example: '123456' source: type: string description: UTM source example: newsletter medium: type: string description: UTM medium example: email campaign: type: string description: UTM campaign example: march_promo term: type: string description: UTM term example: newsletter content: type: string description: UTM content example: newsletter org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.RegistrationSource.SourceMetadata: description: Metadata associated with the registration source example: key: value properties: ipAddress: type: string description: IP address of the device used for registration example: 192.168.1.100 deviceType: type: string description: Type of device used for registration enum: - IOS - ANDROID - WEB - DESKTOP - MOBILE - TABLET - UNKNOWN example: DeviceType::MOBILE ipCity: type: string description: City of the IP address example: New York ipCountry: type: string description: Country of the IP address example: USA ipCountryIsoCode: type: string description: ISO code of the country of the IP address example: US ipState: type: string description: State or region of the IP address example: NY ipStateIsoCode: type: string description: ISO code of the state or region of the IP address example: NY userAgent: type: string description: 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 latitude: type: string description: Latitude of the IP address example: '40.7128' longitude: type: string description: Longitude of the IP address example: '-74.006' osType: type: string description: Operating system type used by the device for registration enum: - ANDROID - IOS - UNKNOWN example: OsType::IOS platformType: type: string description: Platform type used by the device for registration enum: - WEB - APP example: PlatformType::WEB org.events.app.domain.api_product.event.attendee.dtos.EventAttendee.TicketDetails.AddOn.Session: description: Sessions included with this add-on properties: id: type: string description: Unique identifier of the session example: 0b838477-24bf-46a7-a9bd-c40bfa2b2c53 name: type: string description: Name of the session example: Session name securitySchemes: api_key: type: apiKey description: Provide your API key secret in the `Authorization` header name: Authorization in: header ````