FIfiles
inbox_recipients
Inbox Recipients

List Inbox Recipients

Changed on

List Inbox Recipients

get/inbox_recipients

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/inbox_recipients
  • Auth
    none declared

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

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

If set, return records where the specified field is equal to the supplied value. Valid fields are has_registrations.

inbox_idinteger required

List recipients for the inbox with this ID.

Response

A list of InboxRecipients objects.

companystring

The recipient's company.

namestring

The recipient's name.

notestring

A note sent to the recipient with the inbox.

recipientstring

The recipient's email address.

sent_atstring date-time

When the Inbox was shared with this recipient.

Example response

[
  {
    "company": "Acme Inc.",
    "name": "John Doe",
    "note": "Some note.",
    "recipient": "john.doe@example.com",
    "sent_at": "2000-01-01T01:00:00Z"
  }
]

Changes

  • 3bb8c8a06041Revision changes
    • warning

      deleted the query request parameter filter_gt

    • warning

      deleted the query request parameter filter_gteq

    • warning

      deleted the query request parameter filter_like

    • warning

      deleted the query request parameter filter_lt

    • warning

      deleted the query request parameter filter_lteq

    • warning

      deleted the query request parameter user_id

    • info

      api tag Inbox Recipients added

  • 334e0cf90234Revision changes
    • info

      endpoint added