Contacts

List contact files

Retrieve all files for this contact, including chat files and direct uploads.

get/orgs/contacts/{contact_id}/files

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/contacts/{contact_id}/files
  • Auth: HTTP bearer

Path parameters

contact_idstring required

Contact ID

Query parameters

searchstring

Search files by filename.

Example:document.pdf
mimetypestring

Only files of this MIME type (prefix match, e.g. 'image/').

Example:image/
pagenumber

Page number

takenumber

Number of items to take

nextstring

Next page token (Only used on special endpoints)

progressiveboolean

Skip the total count: pagination-count is exact on the last page, and one more than the items so far while more pages exist (Only used on special endpoints)

Response

idstring required

Unique identifier for the file

file_pathstring required

Path to the file in the storage system

file_filenamestring required

Name of the file

file_sizenumber required

Size of the file in bytes

file_mimetypestring required

MIME type of the file

file_urlstring required

URL to access the file

created_atstring date-time nullable required

Timestamp when the file was created

source'direct' | 'comment' | 'chat' required

Where the file came from in the contact: a direct upload, attached to a comment, or sent in a chat

Example response

[
  {
    "file_filename": "document.pdf",
    "file_size": 1024,
    "file_mimetype": "application/pdf"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.