Workspace

Invite someone to the workspace

POST
/v1/invites

Authorization

bearerAuth
AuthorizationBearer <token>

A personal API key (psk_…) or an OAuth access token (plan_at_…). Scopes: read, write.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v1/invites" \  -H "Content-Type: application/json" \  -d '{    "email": "string"  }'
{  "invite": {    "id": "string",    "email": "string",    "role": "OWNER",    "status": "PENDING",    "createdAt": "2019-08-24T14:15:22Z",    "expiresAt": "2019-08-24T14:15:22Z"  }}