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

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

listEventRegistrations

Обновлено

GET /api/v1/tools/event-registrations

listEventRegistrations

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

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["events:read"]

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

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

Тело запроса

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

Ответы

ПолеЗначение
200.content.application/json.schemaEventRegistrationList
200.description"listEventRegistrations"
200.headers.X-Bot-Username.description"Active tenant public bot username, when available"
200.headers.X-Bot-Username.schema200.headers.X-Bot-Username.schema
200.headers.X-Client-Slug.description"Active tenant public slug, when available"
200.headers.X-Client-Slug.schema200.headers.X-Client-Slug.schema
200.headers.X-RateLimit-Limit.description"Computed request budget"
200.headers.X-RateLimit-Limit.schema200.headers.X-RateLimit-Limit.schema
200.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
200.headers.X-RateLimit-Remaining.schema200.headers.X-RateLimit-Remaining.schema
200.headers.X-RateLimit-Reset.description"Budget reset Unix timestamp"
200.headers.X-RateLimit-Reset.schema200.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"VALIDATION_ERROR or invalid integer parameter"
401.content.application/problem+json.schemaProblemDetails
401.description"INVALID_API_KEY: header OR bearer tgf_*; no surface JWT alternative."
403.content.application/problem+json.schemaProblemDetails
403.description"INSUFFICIENT_SCOPE, PUBLISHABLE_KEY_NOT_ALLOWED or FORBIDDEN (credential actor does not belong to tenant)"
409.content.application/problem+json.schemaProblemDetails
409.description"CONFLICT: invalid registration cursor"
413.content.application/problem+json.schemaProblemDetails
413.description"PAYLOAD_TOO_LARGE or ITEM_COUNT_EXCEEDED"
429.content.application/problem+json.schemaProblemDetails
429.description"RATE_LIMIT_EXCEEDED or RATE_LIMIT_UNAVAILABLE"
429.headers.Retry-After.description"Seconds supplied by resource guard when available."
429.headers.Retry-After.schema429.headers.Retry-After.schema
500.content.application/problem+json.schemaProblemDetails
500.description"INTERNAL_ERROR"

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

ПолеЗначение
operationId"listEventRegistrations"
tags["events"]
x-idempotency"none"
x-pagination.binding["client_id","event_seq_num"]
x-pagination.cursorPattern"^\\d+$"
x-pagination.limitDefault50
x-pagination.limitMaximum100
x-pagination.limitMinimum1
x-pagination.responseCursorField"nextCursor"