MechaMental
Api reference

Platform Invites

List Platform Invites

GET
/v1/admin/platform-invites/

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X GET "https://loading/v1/admin/platform-invites/"
{
  "total": 0,
  "has_more": false,
  "next_cursor": "string",
  "invites": [
    {
      "invite_id": "string",
      "email": "string",
      "invited_by": "string",
      "token": "string",
      "status": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "expires_at": "2019-08-24T14:15:22Z",
      "accepted_at": "2019-08-24T14:15:22Z"
    }
  ]
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Create Platform Invite

POST
/v1/admin/platform-invites/

Header Parameters

authorization?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email*Email

Response Body

application/json

application/json

curl -X POST "https://loading/v1/admin/platform-invites/" \  -H "Content-Type: application/json" \  -d '{    "email": "string"  }'
{
  "invite_id": "string",
  "email": "string",
  "invited_by": "string",
  "token": "string",
  "status": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "expires_at": "2019-08-24T14:15:22Z",
  "accepted_at": "2019-08-24T14:15:22Z"
}
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Revoke Platform Invite

DELETE
/v1/admin/platform-invites/{invite_id}

Path Parameters

invite_id*Invite Id

Header Parameters

authorization?string|null

Response Body

application/json

application/json

curl -X DELETE "https://loading/v1/admin/platform-invites/string"
null
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}