Box · Schema

Invite

An invite for a user to an enterprise.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name Type Description
id string The unique identifier for this invite
type string `invite`
invited_to object A representation of a Box enterprise
actionable_by object
invited_by object
status string The status of the invite
created_at string When the invite was created
modified_at string When the invite was modified.
View JSON Schema on GitHub

JSON Schema

box-invite-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Invite",
  "title": "Invite",
  "type": "object",
  "x-box-resource-id": "invite",
  "x-box-tag": "invites",
  "description": "An invite for a user to an enterprise.",
  "required": [
    "id",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this invite",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`invite`",
      "example": "invite",
      "enum": [
        "invite"
      ]
    },
    "invited_to": {
      "title": "Enterprise",
      "type": "object",
      "description": "A representation of a Box enterprise",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for this enterprise.",
          "example": "11446498"
        },
        "type": {
          "type": "string",
          "description": "`enterprise`",
          "example": "enterprise",
          "enum": [
            "enterprise"
          ]
        },
        "name": {
          "description": "The name of the enterprise",
          "example": "Acme Inc.",
          "type": "string"
        }
      }
    },
    "actionable_by": {
      "$ref": "#/components/schemas/User--Mini"
    },
    "invited_by": {
      "$ref": "#/components/schemas/User--Mini"
    },
    "status": {
      "description": "The status of the invite",
      "type": "string",
      "example": "pending"
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the invite was created",
      "example": "2012-12-12T10:53:43-08:00"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time",
      "description": "When the invite was modified.",
      "example": "2012-12-12T10:53:43-08:00"
    }
  }
}