Bundle Registrations

A BundleRegistration is a registration record when a user fills out the form to access the bundle.

List Share Link Registrations

SDK Method

files_sdk.bundle_registration.list()

Return Object

ListObj[BundleRegistration]

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
user_id
int64		User ID. Provide a value of 0 to operate the current session's user.
bundle_id
int64		ID of the associated Bundle

Additional Arguments

Example Request

import files_sdk

try:
  bundle_registrations = files_sdk.bundle_registration.list({
    "user_id": 1
  })
  for bundle_registration in bundle_registrations.auto_paging_iter():
    # Operate on bundle_registration
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The BundleRegistration Object

Some of the methods above return a BundleRegistration object. The attributes of this object are listed below.

AttributeDescription
code
string		Registration cookie code
name
string		Registrant name
company
string		Registrant company name
email
string		Registrant email address
ip
string		Registrant IP Address
inbox_code
string		InboxRegistration cookie code, if there is an associated InboxRegistration
clickwrap_body
string		Clickwrap text that was shown to the registrant
form_field_set_id
int64		Id of associated form field set
form_field_data
object		Data for form field set with form field ids as keys and user data as values
bundle_code
string		Bundle URL code
bundle_id
int64		Id of associated bundle
bundle_recipient_id
int64		Id of associated bundle recipient
workspace_id
int64		Workspace ID. 0 means the default workspace.
created_at
date-time		Registration creation date/time