Skip to main content
POST
/
documents
/
search
Search all documents
curl --request POST \
  --url https://api-joy.joyfill.io/v1/documents/search \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 25,
  "page": 1,
  "query": {},
  "sort": {}
}'
"{\n  \"data\": [Object, Object, ...]\n}"

Headers

Authorization
string

Supports both API Key and User Access Token authorization. See https://joyfill.mintlify.app/api/authentication

Body

application/json
limit
integer
default:25

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25.

page
integer
default:1

An integer for use with pagination. For instance, if limit is set to 25 and you set page to 2 then results 26-50 will be returned.

query
object

See Joyfill's Search Query Syntax

sort
object

See Joyfill's Search Sort Syntax

Response

200

The response is of type file.