View deleted files

GET /api/v1/file/bin

Query parameters

  • include string

    Comma separated list of relationships to include in the response. Valid relationships are [documentable, folder, account, tags].

  • filter[uuid] string

    Filter by a comma separated list of UUIDs.

  • filter[name] string

    File name to filter by.

  • filter[date_from] string

    File uploaded_at date to filter from a specific date, can be used with date_to for a range.

  • filter[date_to] string

    File uploaded_at date to filter to a specific date, can be used with date_from for a range.

  • filter[extension] string

    File extension to filter by.

  • filter[uploaded_by_uuid] string

    Filter by a comma separated list of account UUIDs of who uploaded the file.

  • filter[size] string

    The size of the file to filter by. Can take two values to filter in a range or one value to get files lesser than or equal to value. Unit of file size is in kilobytes.

  • filter[last_modified_from] string

    File last_modified date to filter to from a specific date, can be used with last_modified_to for a range.

  • filter[last_modified_to] string

    File last_modified date to filter to a specific date, can be used with last_modified_from for a range.

  • filter[original_created_from] string

    File original_created_at date to filter from a specific date, can be used with original_created_to for a range.

  • filter[original_created_to] string

    File original_created_at date to filter to a specific date, can be used with original_created_from for a range.

  • sort string

    Field to sort by. Valid fields are [uploaded_at, created_at, updated_at, name]. Negative sign to denote DESC. Defaults to 'name'.

  • per_page integer

    Number of results to return with pagination (Default 15. Max 500).

Responses

  • 401 application/json
    Hide response attribute Show response attribute object
    • message string
GET /api/v1/file/bin
curl \
 --request GET 'https://api.plannrcrm.com/api/v1/file/bin' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (401)
{
  "message": "Unauthenticated."
}