Skip to content
Core API
Esc
navigateopen⌘Jpreview

Custom lists

Custom lists: available fields, filters, associations, and API operations.

Path: events/{event_id}/custom-lists
Methods: GET collection/record, POST, PATCH, DELETE.

GET

  • Fields: event-id, name, description, attendance-type, profile-badge, display-name, is-default, position, networking-enabled, lead-scanning-enabled, qr-code-visible, meeting-requests-outgoing, meeting-requests-incoming, max-outgoing-meeting-requests, max-accepted-meetings, show-invited-registrants, created-at, updated-at, show-unjoined-registrants-in-apps, show-registration-link, outgoing-target-list-ids, incoming-target-list-ids, registrant-ids, registrants-count.
  • Filters: attendance_type, name, registrant_id.
  • Associations: none.
GET .../custom-lists?attendance_type=in_person&registrant_id=1201

POST/PATCH writable fields: name, description, attendance_type, profile_badge, display_name, networking_enabled, lead_scanning_enabled, qr_code_visible, meeting_requests_outgoing, meeting_requests_incoming, max_outgoing_meeting_requests, max_accepted_meetings, show_invited_registrants.

Additional inputs: show_invites_in_apps, show_booking_system_join_url, outgoing_target_list_ids (array), incoming_target_list_ids (array), registrant_ids (array).

{
  "name": "VIP guests",
  "attendance_type": "in_person",
  "networking_enabled": true,
  "registrant_ids": [1201, 1202]
}

When supplied on POST or PATCH, registrant_ids fully replaces membership. An empty array removes all members without deleting the registrants. All registrants and target lists must belong to the URL event.

Last updated on August 21, 2026