Docs

Start here

List a project's invitations

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

A project's invitations, waiting ones first, for a member who manages members.

A project's invitations, waiting ones first, for a member who manages members. 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

#Path parameters

NameTypeRequiredDescription
projectstringyes

#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.

#Example request

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

#Responses

#200 OK

OK.

FieldTypeRequiredDefaultDescription
objectstringyes—One of "list".
dataobject[]yes—
data[].objectstringyes—One of "invite".
data[].idstringyes—
data[].project_idstringyes—
data[].kindstringyes—One of "email", "link".
data[].emailstringyes—The address it was sent to, while the invitation waits; null for a link, and null once it is accepted, declined, revoked or expired. May be null.
data[].rolestringyes—One of "admin", "collaborator", "viewer".
data[].statestringyes—One of "pending", "accepted", "declined", "revoked", "expired".
data[].usesintegeryes—0 to ….
data[].uses_maxintegeryes—1 to 50. May be null.
data[].invited_byobjectyes—Somebody as a project shows them: their membership's id while they are in it and the public Community profile they chose — never an account or an address.
data[].invited_by.member_idstringyes—May be null.
data[].invited_by.namestringyes—May be null.
data[].invited_by.handlestringyes—May be null.
data[].invited_by.avatar_urlstringyes—A URL. May be null.
data[].invited_by.leftbooleanyes—Gone from the project since; what they wrote stays, with their name.
data[].created_atstringyes—
data[].expires_atstringyes—
data[].urlstringno—A link's address, in the answer that made it and never again: the token rides in its fragment, which no request carries to a server. A URL.
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

#404 Not Found

#429 Too Many Requests

#500 Internal Server Error

#503 Service Unavailable

#Status codes

StatusMeaning
200OK.
400Bad Request
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