v4

latestSwagger 2.02026-08-0343714211.7 MB

bundle_registrations

Bundle Registrations

List Share Link Registrations

get/bundle_registrations

Query parameters

user_idinteger

User ID. Provide a value of 0 to operate the current session's user.

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are workspace_id, bundle_id or created_at.

bundle_idinteger

ID of the associated Bundle

Response

A list of BundleRegistrations objects.

codestring

Registration cookie code

namestring

Registrant name

companystring

Registrant company name

emailstring

Registrant email address

ipstring

Registrant IP Address

inbox_codestring

InboxRegistration cookie code, if there is an associated InboxRegistration

clickwrap_bodystring

Clickwrap text that was shown to the registrant

form_field_set_idinteger

Id of associated form field set

form_field_dataobject

Data for form field set with form field ids as keys and user data as values

bundle_codestring

Bundle URL code

bundle_idinteger

Id of associated bundle

bundle_recipient_idinteger

Id of associated bundle recipient

workspace_idinteger

Workspace ID. 0 means the default workspace.

created_atstring date-time

Registration creation date/time

Example response

[
  {
    "code": "abc123",
    "name": "account",
    "company": "Action Verb",
    "email": "john.doe@files.com",
    "ip": "10.1.1.1",
    "inbox_code": "abc123",
    "clickwrap_body": "example",
    "form_field_set_id": 1,
    "form_field_data": {
      "key": "example value"
    },
    "bundle_code": "example",
    "bundle_id": 1,
    "bundle_recipient_id": 1,
    "workspace_id": 1,
    "created_at": "2000-01-01T01:00:00Z"
  }
]