Connectors

Search remote files

Changed on

Search the provider's files by name, and by content where the provider supports it. Without a scope, searches everything the connection can see; pass the browse_ref fields of a folder or container to search inside it. Each response states whether its folder scope covers the whole subtree. Returns 422 search_not_supported when the provider has no search, and shares the provider request budget with browsing and background runs.

get/connectors/v1/connections/{id}/search

Request

  • Base URL
    https://api.case.dev
  • URL
    https://api.case.dev/connectors/v1/connections/{id}/search
  • Auth
    HTTP bearer

Path parameters

idstring required

Query parameters

querystring required

Search text

sitestring

Site to search in

containerstring

Container to search in, or the container holding parent

parentstring

Folder to search in

cursorstring
page_sizeinteger

Headers

x-case-connector-subjectstring

Trusted server-to-server application-user assertion. Derive it from the authenticated application session, never browser input. Omit only for the legacy organization-scoped namespace.

Response

One page of matching files

cursorstring nullable
scope'account' | 'folder'
scope_refobject nullable
full_textboolean

Whether the provider matches file contents, not only names

folder_scope_recursiveboolean

False when a folder scope covers its direct children only

Changes