К содержанию
TelegaFirst

Для AI-агентов: markdown этой страницы — /docs/api-op-listcatalog.mdиндекс документации — /llms.txt

listCatalog

Обновлено

GET /api/v1/catalog

listCatalog

Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

ПолеЗначение
security.0.hubApiKey[]
security.1.hubBearer[]
securitySchemes.hubApiKey.in"header"
securitySchemes.hubApiKey.name"X-Api-Key"
securitySchemes.hubApiKey.type"apiKey"
securitySchemes.hubBearer.scheme"bearer"
securitySchemes.hubBearer.type"http"
x-required-scopes["catalog:read"]

Параметры запроса

ПолеЗначение
0.in"query"
0.name"zone"
0.requiredfalse
0.schema0.schema
1.in"query"
1.name"cursor"
1.requiredfalse
1.schema1.schema
2.in"query"
2.name"limit"
2.requiredfalse
2.schema2.schema

Тело запроса

ПолеЗначение
Тело запросаnull

Ответы

ПолеЗначение
200.content.application/json.schemaCatalogListEnvelope
200.description"List catalog items — every non-deleted item of the tenant, each with its reach pair (`is_active` = switched on, `is_public` = listed in the showcase)"

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Catalog zone, cursor or limit does not match the request schema"
401.content.application/problem+json.schemaProblemDetails
401.description"Missing or invalid authentication"
403.content.application/problem+json.schemaProblemDetails
403.description"Catalog read scope or resource policy refused the request"

Дополнительные условия

ПолеЗначение
operationId"listCatalog"
tags["catalog"]
x-idempotency"none"