Invite

An invite for a user to an enterprise.

id string

example"11446498"

The unique identifier for this invite

type string

example"invite"

invite

Value is always invite

actionable_byUser (Mini) object

A mini representation of a user, as can be returned when nested within other resources.

created_at string / date-time

example"2012-12-12T10:53:43-08:00"

When the invite was created

invited_byUser (Mini) object

A mini representation of a user, as can be returned when nested within other resources.

invited_to object

A representation of a Box enterprise

invited_to.id string

example"11446498"

The unique identifier for this enterprise.

invited_to.type string

example"enterprise"

enterprise

Value is always enterprise

invited_to.name string

example"Acme Inc."

The name of the enterprise

modified_at string / date-time

example"2012-12-12T10:53:43-08:00"

When the invite was modified.

status string

example"pending"

The status of the invite

Response Example

{
  "id": "11446498",
  "type": "invite",
  "actionable_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "invited_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "invited_to": {
    "id": "11446498",
    "type": "enterprise",
    "name": "Acme Inc."
  },
  "modified_at": "2012-12-12T10:53:43-08:00",
  "status": "pending"
}