List Lockbox Recipients

Changed on
get/lockbox_recipients

Request

  • Base URL
    https://api.increase.com
  • URL
    https://api.increase.com/lockbox_recipients
  • Auth
    HTTP bearer

Query parameters

cursorstring

Return the page of entries after this one.

limitinteger

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_idstring

Filter Lockbox Recipients to those associated with the provided Account.

lockbox_address_idstring

Filter Lockbox Recipients to those associated with the provided Lockbox Address.

created_at.afterstring date-time

Return results after this ISO 8601 timestamp.

created_at.beforestring date-time

Return results before this ISO 8601 timestamp.

created_at.on_or_afterstring date-time

Return results on or after this ISO 8601 timestamp.

created_at.on_or_beforestring date-time

Return results on or before this ISO 8601 timestamp.

idempotency_keystring

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Response

Lockbox Recipient List

next_cursorstring nullable required

A pointer to a place in the list. Pass this as the cursor parameter to retrieve the next page of results. If there are no more results, the value will be null.

Example response

{
  "data": [
    {
      "account_id": "account_in71c4amph0vgo2qllky",
      "created_at": "2020-01-31T23:59:59Z",
      "description": null,
      "id": "lockbox_3xt21ok13q19advds4t5",
      "idempotency_key": null,
      "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6",
      "mail_stop_code": "VRE6P",
      "recipient_name": "Company Inc.",
      "status": "active",
      "type": "lockbox_recipient"
    }
  ],
  "next_cursor": "v57w5d"
}

Changes

  • df2b1ead4c49Revision changes
    • breaking

      for the query request parameter limit, default value 100 was added

  • 64a92a8cc343Revision changes
    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      added subschema #8 subschema #10 to the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status

    • info

      removed subschema #8 subschema #10 from the /// response property anyOf list for the response status