Docs

Start here

List your Studio notifications

GET/v1/studio/notificationson https://api.auray.ai/v1

Your Cinema Studio notifications, newest first: invitations, requests, role changes, comments and replies, reviews, offers of a project, a call starting, a project leaving with its owner or gone.

Your Cinema Studio notifications, newest first: invitations, requests, role changes, comments and replies, reviews, offers of a project, a call starting, a project leaving with its owner or gone. Takes a key holding studio:read (or studio:write, which reads too) — Account offers both unticked — or the desktop's own session key. Spends nothing.

#Authentication

Authorization: Bearer auray_sk_… — a key with the scope the route names.

#Request

#Query parameters

NameTypeRequiredDescription
cursorstringnoThe next_cursor the previous page answered, unchanged, with the same filters. None for the first page. 0 to 120 characters.
limitintegernoHow many on a page. 1 to 100.
unreadbooleanno

#Example request

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

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].objectstringyes—One of "notification".
data[].idstringyes—
data[].kindstringyes—One of "invited", "access_requested", "access_decided", "role_changed", "removed", "comment", "reply", "review_requested", "review_decided", "ownership_offered", "ownership_changed", "owner_leaving", "owner_stayed", "project_deleted", "call_started".
data[].project_idstringyes—May be null.
data[].project_namestringyes—Kept with the notice, so a notice of a deleted project still says which. May be null.
data[].actornull or objectyes—
data[].item_idstringyes—May be null.
data[].comment_idstringyes—May be null.
data[].rolestringyes—One of "owner", "admin", "collaborator", "viewer", null. May be null.
data[].deletes_atstringyes—When a project goes with its owner's account (owner_leaving). May be null.
data[].reviewstringyes—One of "none", "in_progress", "needs_review", "approved", "rejected", null. May be null.
data[].created_atstringyes—
data[].read_atstringyes—May be null.
next_cursorstringyes—Send it as cursor for the next page; null on the last. May be null.
request_idstringno—Mirrored in the X-Request-Id header.

Headers:

HeaderDescription
RateLimit-LimitBurst capacity.
RateLimit-Remaining
RateLimit-ResetSeconds until refill.
X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-ResetUnix seconds. The X- spelling is what client libraries read.
X-Request-Id

#400 Bad Request

#401 Unauthorized

#403 Forbidden

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
401Unauthorized
403Forbidden
429Too Many Requests
500Internal Server Error
503Service 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