Docupilot · Schema

Invitation

Invitation schema from Docupilot accounts API

Document GenerationPDF GenerationDocument AutomationTemplate EngineeSignatureWorkflow Automation

Properties

Name	Type	Description
id	integer
email	string
role	string
workspace	object
created_at	string
expires_at	string
is_accepted	boolean
invite_key	string
sender	string
expired	boolean

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Invitation",
  "description": "Invitation schema from Docupilot accounts API",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "readOnly": true
    },
    "email": {
      "type": "string",
      "format": "email",
      "maxLength": 254
    },
    "role": {
      "enum": [
        "admin",
        "manager",
        "member",
        "billing_manager"
      ],
      "type": "string"
    },
    "workspace": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer"
        },
        "name": {
          "type": "string"
        }
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "expires_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "is_accepted": {
      "type": "boolean",
      "readOnly": true,
      "nullable": true
    },
    "invite_key": {
      "type": "string",
      "readOnly": true
    },
    "sender": {
      "type": "string",
      "readOnly": true
    },
    "expired": {
      "type": "boolean",
      "readOnly": true
    }
  },
  "required": [
    "created_at",
    "email",
    "expired",
    "expires_at",
    "id",
    "invite_key",
    "is_accepted",
    "role",
    "sender",
    "workspace"
  ]
}