v4

latestSwagger 2.02026-08-0343714211.7 MB

inbox_registrations

Inbox Registrations

List Inbox Registrations

get/inbox_registrations

Query parameters

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).

folder_behavior_idinteger

ID of the associated Inbox. This is required if the user is not a site admin.

Response

A list of InboxRegistrations objects.

codestring

Registration cookie code

namestring

Registrant name

companystring

Registrant company name

emailstring

Registrant email address

ipstring

Registrant IP Address

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

inbox_idinteger

Id of associated inbox

inbox_recipient_idinteger

Id of associated inbox recipient

inbox_titlestring

Title of associated inbox

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",
    "clickwrap_body": "example",
    "form_field_set_id": 1,
    "form_field_data": {
      "key": "example value"
    },
    "inbox_id": 1,
    "inbox_recipient_id": 1,
    "inbox_title": "example",
    "created_at": "2000-01-01T01:00:00Z"
  }
]