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": {}
}
'
import requests

url = "https://api-joy.joyfill.io/v1/documents/search"

payload = {
"limit": 25,
"page": 1,
"query": {},
"sort": {}
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({limit: 25, page: 1, query: {}, sort: {}})
};

fetch('https://api-joy.joyfill.io/v1/documents/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-joy.joyfill.io/v1/documents/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'limit' => 25,
'page' => 1,
'query' => [

],
'sort' => [

]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api-joy.joyfill.io/v1/documents/search"

payload := strings.NewReader("{\n \"limit\": 25,\n \"page\": 1,\n \"query\": {},\n \"sort\": {}\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api-joy.joyfill.io/v1/documents/search")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 25,\n \"page\": 1,\n \"query\": {},\n \"sort\": {}\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-joy.joyfill.io/v1/documents/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"limit\": 25,\n \"page\": 1,\n \"query\": {},\n \"sort\": {}\n}"

response = http.request(request)
puts response.read_body
"{\n  \"data\": [Object, Object, ...]\n}"
"{\n  \"message\": \"Not Found\"\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<int32>
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<int32>
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