Skip to main content
GET
/
documents
List all documents
curl --request GET \
  --url https://api-joy.joyfill.io/v1/documents
"{\n  \"data\": [Object, Object, ...]\n}"

Headers

Authorization
string

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

Query Parameters

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.

type
enum<string>
default:document
Available options:
document,
template
template
string

Specifies an original source template identifier to filter documents.

group
string

Filter documents by a specific group identifier. Only documents that belong to the specified group will be returned.

stage
enum<string>
default:published
Available options:
all,
published,
draft
properties
string[]

Limit the data returned as a part of the response by specifying the desired properties ( ["name", "stage", "files"] )

Response

200

The response is of type file.