Skip to Content
SeyloDocs
API referenceInvites

Invite someone

POST
/api/v1/invites.create

Creates an invite link for an email, as an admin or as a member with grants on projects and services. The link is returned once; send it yourself, or it is emailed when the panel has an SMTP channel. An admin invite from a browser session needs a sign-in or auth.reauth from the last 15 minutes (FORBIDDEN details.reason "reauth" otherwise); API keys need none.

Needs users.invite, which owners and admins hold. Not available to MCP clients or the assistant.

Authorization

cookieseylo_session<token>

Request Body

application/json
  1. body
email*string
Formatemail
Lengthlength <= 254
role*string|string
grants*array<>

Members only; admins need none.

Itemsitems <= 200
Default[]
expiresInDays*integer
Range1 <= value <= 30
Default7
sendEmail*boolean

Email the link through the default SMTP channel, when one exists.

Defaulttrue

Response Body

Success.

application/json
  1. response
invite*
link*string
emailed*boolean
Example Request
curl -X POST 'https://example.com/api/v1/invites.create' \  -H 'Content-Type: application/json' \  -d '{  "email": "[email protected]",  "role": "admin",  "grants": [],  "expiresInDays": 7,  "sendEmail": true}'
Example Response
{  "invite": {    "id": "string",    "email": "[email protected]",    "role": "admin",    "grants": [      {        "scopeType": "project",        "scopeId": "string",        "scopeName": "string",        "actions": [          "string"        ]      }    ],    "status": "pending",    "invitedBy": {      "id": "string",      "email": "string",      "name": "string"    },    "expiresAt": "2019-08-24T14:15:22Z",    "acceptedAt": "2019-08-24T14:15:22Z",    "createdAt": "2019-08-24T14:15:22Z"  },  "link": "string",  "emailed": true}

Accept an invite POST

Uses up the invite token. Without a session it creates the account (password required) and signs in. With a session whose email matches it adds the invite's grants to that account. Needs no sign-in. Not available to MCP clients or the assistant.

List invites GET

Lists invites, newest first. Pending ones first unless a status is given. Needs `users.view`, which owners and admins hold. Not available to MCP clients or the assistant.