Перейти к содержимому

List Objects

GET
/v1/objects
curl --request GET \
--url 'https://api.cloud.agentums.ru/v1/objects?limit=20&offset=0&uncategorized=false&include_hidden=false&hidden_only=false&trashed=false&notes_only=false' \
--header 'Authorization: Bearer <token>'

Список объектов владельца (новые сверху). Скоуп tenant+owner; опц. фильтры doc_type и collection_id (папка). uncategorized=true — только файлы БЕЗ папки («Все файлы» показывает несортированные, файлы в папках туда не попадают). Скрытые по умолчанию исключены (29-13): include_hidden / hidden_only; при установленном PIN (T29) выдача скрытых требует unlock-токен X-Hidden-Token (hidden_only без него → 403, include_hidden молча деградирует до обычной). Корзина: по умолчанию удалённые исключены; trashed=true — ТОЛЬКО корзина.

limit
Limit
integer
default: 20 >= 1 <= 100
offset
Offset
integer
0
doc_type
Any of:
string
kind
Any of:
string
is_link
Any of:
boolean
collection_id
Any of:
string format: uuid
uncategorized
Uncategorized
boolean
include_hidden
Include Hidden
boolean
hidden_only
Hidden Only
boolean
trashed
Trashed
boolean
notes_only
Notes Only
boolean
x-hidden-token
Any of:
string

Successful Response

Media typeapplication/json
ObjectList
object
items
Items
Array<object>
ObjectListItem
object
categories
Categories
Array<string>
collection_id
Any of:
string format: uuid
collection_name
Any of:
string
created_at
required
Created At
string format: date-time
deleted_at
Any of:
string format: date-time
display_name
Display Name
string
""
doc_type
Doc Type
string
default: other
editor
Any of:
string
filename
required
Filename
string
has_corrections
Has Corrections
boolean
id
required
Id
string format: uuid
image_editable
Image Editable
boolean
is_hidden
Is Hidden
boolean
kind
required
Kind
string
meeting_date
Any of:
string format: date-time
name_source
Name Source
string
default: original
needs_manual
Needs Manual
boolean
pdf_tools
Pdf Tools
boolean
size
Size
integer
0
source_url
Any of:
string
status
required
Status
string
suggested_collection_id
Any of:
string format: uuid
suggested_name
Any of:
string
summary
Summary
string
""
text_fallback
Text Fallback
boolean
text_view
Text View
boolean
title
Title
string
""
version
Version
integer
default: 1
total
Total
integer
0
Example
{
"items": [
{
"display_name": "",
"doc_type": "other",
"has_corrections": false,
"image_editable": false,
"is_hidden": false,
"name_source": "original",
"needs_manual": false,
"pdf_tools": false,
"size": 0,
"summary": "",
"text_fallback": false,
"text_view": false,
"title": "",
"version": 1
}
],
"total": 0
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}