Docs

Start here

List your support requests

GET/v1/support/ticketson https://api.auray.ai/v1

The requests the signed-in account has filed from the desktop, or that our team has linked to it, newest movement first — at most twenty, each with what was said on it.

The requests the signed-in account has filed from the desktop, or that our team has linked to it, newest movement first — at most twenty, each with what was said on it. Called by the desktop for the person signed in; a key you hold is refused 403 support_session_only, since it is not the person asking. Without the desktop, the help form (POST /support/requests) needs no key at all.

#Authentication

Authorization: Bearer auray_sk_… — The desktop's own session key, signed in — a key you hold is refused 403 support_session_only. Without the desktop, the help form needs no key.

#Example request

curl https://api.auray.ai/v1/support/tickets \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].objectstringyes—One of "support_ticket".
data[].referencestringyes—The request's label, as our mails print it — AU-7K2M9Q. A label, never a credential.
data[].subjectstringyes—
data[].statusstringyes—Where the request stands. solved and closed reopen when you write back. One of "new", "open", "pending", "on_hold", "solved", "closed".
data[].appstringyes—The desktop app it was asked from, or null when it named none. One of "photos", "video", "music", "threed", "studio", "community", "explore", "code", "messages", "finder", "settings", null. May be null.
data[].kindstringyes—problem when something was not working, question for help with how, appeal when the person disputed a decision about the account or its work; null for a request filed another way. One of "problem", "question", "appeal", null. May be null.
data[].opened_atstringyes—
data[].updated_atstringyes—
data[].messagesobject[]yes—What was said on it, oldest first: the person's own words, and every answer of ours once it has been sent — never an answer still waiting to go, and never a note our team keeps.
data[].messages[].seqintegeryes—Its place in the conversation, from 1.
data[].messages[].fromstringyes—you for what the person wrote, support for what we answered. One of "you", "support".
data[].messages[].bodystringyes—
data[].messages[].atstringyes—

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-Request-Id

#401 Unauthorized

missing_authorization, invalid_api_key, key_revoked or key_expired.

The error body: error, message, docs (the entry that explains it) and request_id.

#403 Forbidden

support_session_only — this is the desktop's door.

The error body: error, message, docs (the entry that explains it) and request_id.

#429 Too Many Requests

rate_limited — the key's read bucket.

The error body: error, message, docs (the entry that explains it) and request_id.

#503 Service Unavailable

support_disabled, support_not_configured or support_unavailable.

The error body: error, message, docs (the entry that explains it) and request_id.

#Status codes

StatusMeaning
200OK
401missing_authorization, invalid_api_key, key_revoked or key_expired.
403support_session_only — this is the desktop's door.
429rate_limited — the key's read bucket.
503support_disabled, support_not_configured or support_unavailable.

Every refusal names its code, and every code is explained at Errors.

Start typing to search every page of the documentation.

Up arrow Down arrow to moveEnter to openEscape to close