File Search

Search for file attachments

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

See the search filtering documentation for details about the query syntax. The searchable attributes and the operators each one accepts are listed in the request body below.

File-specific notes

  • size is in bytes and must be sent as a JSON number, e.g. { "size": { "greater_than": 1000000 } }.
  • extension and name are text, e.g. { "extension": { "any": ["pdf", "docx"] } }.
  • email_messages finds files linked to an email: { "email_messages": { "any": { "email_message": { "equal": "/v1/emails/4005" } } } }.

Files can't be searched by the records they are linked to, such as contacts or projects. To find a contact's files, list or search files and check each file's contacts.

Query Params
int32
≤ 250
Defaults to 50

Maximum number of results per page (max 250). Defaults to 50, or 10 when full-records is true.

boolean

Return every attribute of each result instead of the short list form.

int32

Return results whose ID is greater than or equal to this value. Use the next URL from the previous page rather than building this yourself.

Body Params
name
object

File name, e.g. {"ends_with": ".pdf"}

title
object

Title

extension
object

Extension, e.g. {"equal": "pdf"}

note
object

Description

size
object

Size in bytes, e.g. {"greater_than": 1000000}

email_messages
object

Records linked to emails. The operand is a search filter on emails, for example {"any": {"email_message": {"equal": "/v1/emails/1000"}}}.

owner
object

Owner reference, e.g. /v1/users/1000

create_date
object

When the file was added

modify_date
object

When the file was last updated

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json