List all docs
Returns a list of your docs. The docs are returned sorted by creation date, with the most recently created docs appearing first.
Parameters
state
enum
The state of docs to return. The default is active. One of
all, active, archived.Returns
Return a paginated response that contains an array of up to the specified limit of docs.
get
/api/docs
curl https://{workspace}.kitchen.co/api/docs \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-Requested-With: XMLHttpRequest' \
-H 'Authorization: Bearer {API_KEY}'
Response
{
"data": [
{
"archived_at": null,
"body": [
"The doc body"
],
"clients_can_edit": false,
"created_at": "2024-03-12T10:11:23+00:00",
"id": "doc_36e7eeabce00ecd1f5e9387a",
"title": "Qui aperiam reprehenderit quae adipisci et.",
"updated_at": "2024-03-12T10:11:23+00:00",
"visibility": "internal"
}
],
"links": {
"first": "/api/docs?page=1",
"last": "/api/docs?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "/api/docs?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"path": "/api/docs",
"per_page": 20,
"to": 1,
"total": 1
}
}