Docs

Start here

List a project's members

GET/v1/studio/projects/{project}/memberson https://api.auray.ai/v1

Who is in a project, as who they are there: the owner, then its other members by role.

Who is in a project, as who they are there: the owner, then its other members by role. 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_… — studio:read, or studio:write, which reads too — Account offers both unticked; the desktop's session key holds both.

#Request

#Path parameters

NameTypeRequiredDescription
projectstringyes

#Example request

curl https://api.auray.ai/v1/studio/projects/3f0c8a52-6a1d-4e8b-9c2d-7e5f4a3b2c1d/members \
  -H "Authorization: Bearer $AURAY_API_KEY"

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].objectstringyes—One of "member".
data[].idstringyes—
data[].rolestringyes—One of "owner", "admin", "collaborator", "viewer".
data[].selfbooleanyes—
data[].namestringyes—May be null.
data[].handlestringyes—May be null.
data[].avatar_urlstringyes—A URL. May be null.
data[].joined_atstringyes—
data[].room_epochintegerno—On the reader's own row only: the epoch the project's Realtime topics are named with now (studio:<project>:<epoch>:<channel>). It moves whenever somebody leaves the project or loses a capability, and a window joins its channels again with the new one. 0 to ….
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

#401 Unauthorized

#403 Forbidden

#404 Not Found

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
401Unauthorized
403Forbidden
404Not Found
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