Documents
Common Guides
API Reference
- Files
- Folders
- Drives
Search Files
curl --request POST \
--url https://api.stackone.com/unified/documents/files/search \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '{
"query": "test",
"field": "name",
"operation_type": {
"value": "contains",
"source_value": "contains"
},
"params": {
"raw": true,
"fields": "<string>",
"filter": {
"updated_after": "2020-01-01T00:00:00.000Z"
},
"page": "<string>",
"page_size": "<string>",
"next": "<string>",
"updated_after": "2020-01-01T00:00:00.000Z"
},
"passthrough": {
"other_known_names": "John Doe"
}
}'
{
"data": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Information-Technology",
"description": "This is the description associated to the file.",
"size": 1024,
"url": "https://drive.google.com/file/d/nd8932h9d/view",
"file_format": {
"value": "pdf",
"source_value": "abc"
},
"path": "/path/to/file",
"owner_id": "c28xyrc55866bvuv",
"export_formats": [
"application/pdf"
],
"remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"folder_id": "c28xyrc55866bvuv",
"remote_folder_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"drive_id": "c28xyrc55866bvuv",
"remote_drive_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"created_at": "2023-02-23T00:00:00.000Z",
"updated_at": "2024-02-23T00:00:00.000Z"
}
],
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Body
The query to search for
"test"
The specific field to search within. If not provided, the search will be performed across all searchable text fields
"name"
The operation type to use for the query. If not provided, the default operation is contains
.
The additional parameters of the query
Indicates that the raw request result should be returned in addition to the mapped result (default value is false)
The comma separated list of fields to return in the response (if empty, all fields are returned)
Filter parameters that allow greater customisation of the list response
Use a string with a date to only select results updated after that given date
"2020-01-01T00:00:00.000Z"
The page number of the results to fetch
The number of results per page (default value is 25)
The unified cursor
Use a string with a date to only select results updated after that given date
"2020-01-01T00:00:00.000Z"
Value to pass through to the provider
{ "other_known_names": "John Doe" }
Response
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The name associated with this file
"Information-Technology"
The description of the file
"This is the description associated to the file."
The size of this file
1024
The url of the file
"https://drive.google.com/file/d/nd8932h9d/view"
The file format of the file
The file format of the file, expressed as a file extension
unmapped_value
, ez
, aw
, atom
, atomcat
, atomdeleted
, atomsvc
, dwd
, held
, rsat
, bdoc
, xcs
, ccxml
, cdfx
, cdmia
, cdmic
, cdmid
, cdmio
, cdmiq
, cu
, mpd
, davmount
, dbk
, dssc
, xdssc
, es
, ecma
, emma
, emotionml
, epub
, exi
, exp
, fdt
, pfr
, geojson
, gml
, gpx
, gxf
, gz
, hjson
, stk
, ink
, inkml
, ipfix
, its
, jar
, war
, ear
, ser
, class
, js
, mjs
, json
, map
, json5
, jsonml
, jsonld
, lgr
, lostxml
, hqx
, cpt
, mads
, webmanifest
, mrc
, mrcx
, ma
, nb
, mb
, mathml
, mbox
, mscml
, metalink
, meta4
, mets
, maei
, musd
, mods
, m21
, mp21
, mp4s
, m4p
, doc
, dot
, mxf
, nq
, nt
, cjs
, bin
, dms
, lrf
, mar
, so
, dist
, distz
, pkg
, bpk
, dump
, elc
, deploy
, exe
, dll
, deb
, dmg
, iso
, img
, msi
, msp
, msm
, buffer
, oda
, opf
, ogx
, omdoc
, onetoc
, onetoc2
, onetmp
, onepkg
, oxps
, relo
, xer
, pdf
, pgp
, asc
, sig
, prf
, p10
, p7m
, p7c
, p7s
, p8
, ac
, cer
, crl
, pkipath
, pki
, pls
, ai
, eps
, ps
, provx
, pskcxml
, raml
, rdf
, owl
, rif
, rnc
, rl
, rld
, rs
, rapd
, sls
, rusd
, gbr
, mft
, roa
, rsd
, rss
, rtf
, sbml
, scq
, scs
, spq
, spp
, sdp
, senmlx
, sensmlx
, setpay
, setreg
, shf
, siv
, sieve
, smi
, smil
, rq
, srx
, gram
, grxml
, sru
, ssdl
, ssml
, swidtag
, tei
, teicorpus
, tfi
, tsd
, toml
, trig
, ttml
, ubj
, rsheet
, td
, vxml
, wasm
, wgt
, hlp
, wsdl
, wspolicy
, xaml
, xav
, xca
, xdf
, xel
, xns
, xenc
, xhtml
, xht
, xlf
, xml
, xsl
, xsd
, rng
, dtd
, xop
, xpl
, *xsl
, xslt
, xspf
, mxml
, xhvml
, xvml
, xvm
, yang
, yin
, zip
, *3gpp
, adp
, amr
, au
, snd
, mid
, midi
, kar
, rmi
, mxmf
, *mp3
, m4a
, mp4a
, mpga
, mp2
, mp2a
, mp3
, m2a
, m3a
, oga
, ogg
, spx
, opus
, s3m
, sil
, wav
, *wav
, weba
, xm
, ttc
, otf
, ttf
, woff
, woff2
, exr
, apng
, avif
, bmp
, cgm
, drle
, emf
, fits
, g3
, gif
, heic
, heics
, heif
, heifs
, hej2
, hsj2
, ief
, jls
, jp2
, jpg2
, jpeg
, jpg
, jpe
, jph
, jhc
, jpm
, jpx
, jpf
, jxr
, jxra
, jxrs
, jxs
, jxsc
, jxsi
, jxss
, ktx
, ktx2
, png
, sgi
, svg
, svgz
, t38
, tif
, tiff
, tfx
, webp
, wmf
, disposition-notification
, u8msg
, u8dsn
, u8mdn
, u8hdr
, eml
, mime
, 3mf
, gltf
, glb
, igs
, iges
, msh
, mesh
, silo
, mtl
, obj
, stpx
, stpz
, stpxz
, stl
, wrl
, vrml
, *x3db
, x3dbz
, x3db
, *x3dv
, x3dvz
, x3d
, x3dz
, x3dv
, appcache
, manifest
, ics
, ifb
, coffee
, litcoffee
, css
, csv
, html
, htm
, shtml
, jade
, jsx
, less
, markdown
, md
, mml
, mdx
, n3
, txt
, text
, conf
, def
, list
, log
, in
, ini
, rtx
, *rtf
, sgml
, sgm
, shex
, slim
, slm
, spdx
, stylus
, styl
, tsv
, t
, tr
, roff
, man
, me
, ms
, ttl
, uri
, uris
, urls
, vcard
, vtt
, *xml
, yaml
, yml
, 3gp
, 3gpp
, 3g2
, h261
, h263
, h264
, m4s
, jpgv
, *jpm
, jpgm
, mj2
, mjp2
, ts
, mp4
, mp4v
, mpg4
, mpeg
, mpg
, mpe
, m1v
, m2v
, ogv
, qt
, mov
, webm
, cww
, 1km
, plb
, psb
, pvb
, tcap
, pwn
, aso
, imp
, acu
, atc
, acutc
, air
, fcdt
, fxp
, fxpl
, xdp
, xfdf
, ahead
, azf
, azs
, azw
, acc
, ami
, apk
, cii
, fti
, atx
, mpkg
, key
, m3u8
, numbers
, pages
, pkpass
, swi
, iota
, aep
, bmml
, mpm
, bmi
, rep
, cdxml
, mmd
, cdy
, csl
, cla
, rp9
, c4g
, c4d
, c4f
, c4p
, c4u
, c11amc
, c11amz
, csp
, cdbcmsg
, cmc
, clkx
, clkk
, clkp
, clkt
, clkw
, wbs
, pml
, ppd
, car
, pcurl
, dart
, rdz
, dbf
, uvf
, uvvf
, uvd
, uvvd
, uvt
, uvvt
, uvx
, uvvx
, uvz
, uvvz
, fe_launch
, dna
, mlp
, mle
, dpg
, dfac
, kpxx
, ait
, svc
, geo
, mag
, nml
, esf
, msf
, qam
, slt
, ssf
, es3
, et3
, ez2
, ez3
, fdf
, mseed
, seed
, dataless
, gph
, ftc
, fm
, frame
, maker
, book
, fnc
, ltf
, fsc
, oas
, oa2
, oa3
, fg5
, bh2
, ddd
, xdw
, xbd
, fzs
, txd
, ggb
, ggt
, gex
, gre
, gxt
, g2w
, g3w
, gmx
, gdoc
, gslides
, gsheet
, kml
, kmz
, gqf
, gqs
, gac
, ghf
, gim
, grv
, gtm
, tpl
, vcg
, hal
, zmm
, hbci
, les
, hpgl
, hpid
, hps
, jlt
, pcl
, pclxl
, sfd-hdstx
, mpy
, afp
, listafp
, list3820
, irm
, sc
, icc
, icm
, igl
, ivp
, ivu
, igm
, xpw
, xpx
, i2g
, qbo
, qfx
, rcprofile
, irp
, xpr
, fcs
, jam
, rms
, jisp
, joda
, ktz
, ktr
, karbon
, chrt
, kfo
, flw
, kon
, kpr
, kpt
, ksp
, kwd
, kwt
, htke
, kia
, kne
, knp
, skp
, skd
, skt
, skm
, sse
, lasxml
, lbd
, lbe
, apr
, pre
, nsf
, org
, scm
, lwp
, portpkg
, mvt
, mcd
, mc1
, cdkey
, mwf
, mfm
, flo
, igx
, mif
, daf
, dis
, mbk
, mqy
, msl
, plc
, txf
, mpn
, mpc
, xul
, cil
, cab
, xls
, xlm
, xla
, xlc
, xlt
, xlw
, xlam
, xlsb
, xlsm
, xltm
, eot
, chm
, ims
, lrm
, thmx
, msg
, cat
, *stl
, ppt
, pps
, pot
, ppam
, pptm
, sldm
, ppsm
, potm
, mpp
, mpt
, docm
, dotm
, wps
, wks
, wcm
, wdb
, wpl
, xps
, mseq
, mus
, msty
, taglet
, nlu
, ntf
, nitf
, nnd
, nns
, nnw
, *ac
, ngdat
, n-gage
, rpst
, rpss
, edm
, edx
, ext
, odc
, otc
, odb
, odf
, odft
, odg
, otg
, odi
, oti
, odp
, otp
, ods
, ots
, odt
, odm
, ott
, oth
, xo
, dd2
, obgx
, oxt
, osm
, pptx
, sldx
, ppsx
, potx
, xlsx
, xltx
, docx
, dotx
, mgp
, dp
, esa
, pdb
, pqa
, oprc
, paw
, str
, ei6
, efif
, wg
, plf
, pbd
, box
, mgz
, qps
, ptid
, qxd
, qxt
, qwd
, qwt
, qxl
, qxb
, rar
, bed
, mxl
, musicxml
, cryptonote
, cod
, rm
, rmvb
, link66
, st
, see
, sema
, semd
, semf
, ifm
, itp
, iif
, ipk
, twd
, twds
, mmf
, teacher
, fo
, sdkm
, sdkd
, dxp
, sfs
, sdc
, sda
, sdd
, smf
, sdw
, vor
, sgl
, smzip
, sm
, wadl
, sxc
, stc
, sxd
, std
, sxi
, sti
, sxm
, sxw
, sxg
, stw
, sus
, susp
, svd
, sis
, sisx
, xsm
, bdm
, xdm
, ddf
, tao
, pcap
, cap
, dmp
, tmo
, tpt
, mxs
, tra
, ufd
, ufdl
, utz
, umj
, unityweb
, uoml
, vcx
, vsd
, vst
, vss
, vsw
, vis
, vsf
, wbxml
, wmlc
, wmlsc
, wtb
, nbp
, wpd
, wqd
, stf
, xar
, xfdl
, hvd
, hvs
, hvp
, osf
, osfpvg
, saf
, spf
, cmp
, zir
, zirz
, zaz
, 7z
, abw
, ace
, *dmg
, arj
, aab
, x32
, u32
, vox
, aam
, aas
, bcpio
, *bdoc
, torrent
, blb
, blorb
, bz
, bz2
, boz
, cbr
, cba
, cbt
, cbz
, cb7
, vcd
, cfs
, chat
, pgn
, crx
, cco
, nsc
, cpio
, csh
, *deb
, udeb
, dgc
, dir
, dcr
, dxr
, cst
, cct
, cxt
, w3d
, fgd
, swa
, wad
, ncx
, dtb
, res
, dvi
, evy
, eva
, bdf
, gsf
, psf
, pcf
, snf
, pfa
, pfb
, pfm
, afm
, arc
, spl
, gca
, ulx
, gnumeric
, gramps
, gtar
, hdf
, php
, install
, *iso
, *key
, *numbers
, *pages
, jardiff
, jnlp
, kdbx
, latex
, luac
, lzh
, lha
, run
, mie
, prc
, mobi
, application
, lnk
, wmd
, wmz
, xbap
, mdb
, obd
, crd
, clp
, *exe
, *dll
, com
, bat
, *msi
, mvb
, m13
, m14
, *wmf
, *wmz
, *emf
, emz
, mny
, pub
, scd
, trm
, wri
, nc
, cdf
, pac
, nzb
, pl
, pm
, *prc
, *pdb
, p12
, pfx
, p7b
, spc
, p7r
, *rar
, rpm
, ris
, sea
, sh
, shar
, swf
, xap
, sql
, sit
, sitx
, srt
, sv4cpio
, sv4crc
, t3
, gam
, tar
, tcl
, tk
, tex
, tfm
, texinfo
, texi
, *obj
, ustar
, hdd
, ova
, ovf
, vbox
, vbox-extpack
, vdi
, vhd
, vmdk
, src
, webapp
, der
, crt
, pem
, fig
, *xlf
, xpi
, xz
, z1
, z2
, z3
, z4
, z5
, z6
, z7
, z8
, uva
, uvva
, eol
, dra
, dts
, dtshd
, lvp
, pya
, ecelp4800
, ecelp7470
, ecelp9600
, rip
, aac
, aif
, aiff
, aifc
, caf
, flac
, *m4a
, mka
, m3u
, wax
, wma
, ram
, ra
, rmp
, *ra
, cdx
, cif
, cmdf
, cml
, csml
, xyz
, btif
, pti
, psd
, azv
, uvi
, uvvi
, uvg
, uvvg
, djvu
, djv
, *sub
, dwg
, dxf
, fbs
, fpx
, fst
, mmr
, rlc
, ico
, dds
, mdi
, wdp
, npx
, b16
, tap
, vtf
, wbmp
, xif
, pcx
, 3ds
, ras
, cmx
, fh
, fhc
, fh4
, fh5
, fh7
, *ico
, jng
, sid
, *bmp
, *pcx
, pic
, pct
, pnm
, pbm
, pgm
, ppm
, rgb
, tga
, xbm
, xpm
, xwd
, wsc
, dae
, dwf
, gdl
, gtw
, mts
, ogex
, x_b
, x_t
, vds
, usdz
, bsp
, vtu
, dsc
, curl
, dcurl
, mcurl
, scurl
, sub
, fly
, flx
, gv
, 3dml
, spot
, jad
, wml
, wmls
, s
, asm
, c
, cc
, cxx
, cpp
, h
, hh
, dic
, htc
, f
, for
, f77
, f90
, hbs
, java
, lua
, mkd
, nfo
, opml
, *org
, p
, pas
, pde
, sass
, scss
, etx
, sfv
, ymp
, uu
, vcs
, vcf
, uvh
, uvvh
, uvm
, uvvm
, uvp
, uvvp
, uvs
, uvvs
, uvv
, uvvv
, dvb
, fvt
, mxu
, m4u
, pyv
, uvu
, uvvu
, viv
, f4v
, fli
, flv
, m4v
, mkv
, mk3d
, mks
, mng
, asf
, asx
, vob
, wm
, wmv
, wmx
, wvx
, avi
, movie
, smv
, ice
, mht
"pdf"
"abc"
The path where the file is stored
"/path/to/file"
The user ID of owner of this file
"c28xyrc55866bvuv"
List of supported export formats
["application/pdf"]
Provider's unique identifier of the owner of this file
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
The parent folder ID associated with this file
"c28xyrc55866bvuv"
Provider's unique identifier of the parent folder associated with this file
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
The parent drive ID associated with this file
"c28xyrc55866bvuv"
Provider's unique identifier of the parent drive associated with this file
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
The created date of the file
"2023-02-23T00:00:00.000Z"
The last updated date of the file
"2024-02-23T00:00:00.000Z"
Was this page helpful?
curl --request POST \
--url https://api.stackone.com/unified/documents/files/search \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '{
"query": "test",
"field": "name",
"operation_type": {
"value": "contains",
"source_value": "contains"
},
"params": {
"raw": true,
"fields": "<string>",
"filter": {
"updated_after": "2020-01-01T00:00:00.000Z"
},
"page": "<string>",
"page_size": "<string>",
"next": "<string>",
"updated_after": "2020-01-01T00:00:00.000Z"
},
"passthrough": {
"other_known_names": "John Doe"
}
}'
{
"data": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Information-Technology",
"description": "This is the description associated to the file.",
"size": 1024,
"url": "https://drive.google.com/file/d/nd8932h9d/view",
"file_format": {
"value": "pdf",
"source_value": "abc"
},
"path": "/path/to/file",
"owner_id": "c28xyrc55866bvuv",
"export_formats": [
"application/pdf"
],
"remote_owner_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"folder_id": "c28xyrc55866bvuv",
"remote_folder_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"drive_id": "c28xyrc55866bvuv",
"remote_drive_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
"created_at": "2023-02-23T00:00:00.000Z",
"updated_at": "2024-02-23T00:00:00.000Z"
}
],
"raw": [
{
"method": "<string>",
"url": "<string>",
"body": "<string>",
"response": {}
}
]
}