API reference

API reference · Organizations

Preview or accept a one time crew invite link

POST/api/account/invite-linksSigned in session

The code travels in the body, never in a URL. Accept joins the signed in account once; the link is spent by the join.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
coderequiredstring
actionrequiredstringOne of "preview", "accept".

Example

{
  "code": "string",
  "action": "preview"
}

Answer 200

What the link offers, or the crew joined.

Fields of the 200 answer
FieldTypeWhat it is
orgIdinteger
orgNamestring
rolestring
expiresAtinteger
memberboolean

Errors

  • 401OpenAI shaped error.
  • 404OpenAI shaped error.
  • 409OpenAI shaped error.
  • 429OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter