Invites ~ SHIP

List invites for the caller's org (owner/admin)

Response Body

`application/json`

curl -X GET "https://example.com/invites"

{  "invites": [    {      "id": "string",      "email": "user@example.com",      "role": "string",      "orgId": "string",      "status": "pending",      "invitedByUserId": "string",      "expiresAtSec": 0,      "createdAt": 0    }  ]}

Invite a teammate by email into the caller's org (owner/admin; owner role owner-only)

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*string

Formatemail

role*string

Value in

"owner"
"admin"
"member"

Response Body

`application/json`

curl -X POST "https://example.com/invites" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "role": "string"  }'

{  "id": "string",  "email": "user@example.com",  "role": "string",  "orgId": "string",  "status": "pending",  "invitedByUserId": "string",  "expiresAtSec": 0,  "createdAt": 0}

Revoke a pending invite in the caller's org (owner/admin)

Path Parameters

inviteId*string

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/invites/string"

{  "ok": true}

Invites

200application/json

401application/json

403application/json

200application/json

401application/json

403application/json

429application/json

502application/json

200application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`