Skip to content
Console
On this page

List support inboxes

Lists scoped support_inboxes; no cross-tenant or internal-message projection.

This method is not served on the public API. api.sylphx.com does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Lists scoped support_inboxes; no cross-tenant or internal-message projection.

Not available yet. This method answers 501 with the problem code UNIMPLEMENTED.

  • Path GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_inboxes
  • Scope notify:support:read
  • Effect read — nothing is written.
  • Collection support_inboxes
  • Query page_size, page_token, filter, order_by
  • Pagination the answer carries support_inboxes and, when there is more, next_page_token

Request

FieldTypeWhat it is
parentstringAuthenticated parent scope. Required.
page_sizeint32Maximum rows; default 50, at most 200.
page_tokenstringOpaque continuation bound to the same scope and filter.
filterstringAIP-160 filter; cannot widen caller visibility.
order_bystringStable ordering, with resource identity as the final tie-breaker.

Response

FieldTypeWhat it is
support_inboxesSupportInbox[]Visible records only.
next_page_tokenstringContinuation; empty only after the final page.

SupportInbox

FieldTypeWhat it is
namestringThe canonical resource name.
uidstringImmutable platform identity; never substitutes for a source case ID. Output only.
metaResourceMetaLabels, annotations, display name, timestamps and strong ETag.
localesstring[]Supported BCP 47 locales; the language is still decided per message. Required.
channelsSupportChannel[]Verified links to existing transport resources, not transport credentials.
policystringTenant-policy API resource; rule tables and remedy budgets remain there. Required.
intake_bounddurationMaximum allowed delay from a received event to committed case intake. Required.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

SupportChannel

FieldTypeWhat it is
idstringStable channel-link identity within the inbox. Required.
uidstringImmutable source identity of this configuration record.
display_namestringHuman-readable channel label.
transportstringPublic transport resource or authenticated ingress endpoint. Required.
allowed_originsstring[]Exact canonical origins; an empty list never means wildcard browser access.
anonymous_allowedboolWhether platform-issued anonymous sessions may enter this browser channel.
enabledboolWhether new intake is admitted; disabling never drops accepted events.
labelsmap<string, string>Source metadata, not an authorization mechanism.
annotationsmap<string, string>Unindexed source annotations.
versionint64Configuration revision, independent of case and delivery versions.
create_timetimestampOriginal creation time.
update_timetimestampLast configuration change.
kindstringChannel class: browser, email, social or product; credentials stay external.

Errors

  • UNAUTHENTICATED — No valid key or token was presented.
  • PERMISSION_DENIED — The key lacks the method's permission.
  • INVALID_FIELD — A field failed validation.
  • RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
  • ETAG_MISMATCH — The etag sent does not match the Resource's current etag.
  • INVALID_STATE — The Resource is in a state that forbids the call.
  • UNAVAILABLE — The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.
  • UNIMPLEMENTED — The path or method is not served (yet) at this version.

Every error arrives in the body Errors describes.

Examples

curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/support_inboxes" \
  -H "Authorization: Bearer $SYLPHX_API_KEY"