Invite

An invite for a user to an enterprise.

string
11446498

The unique identifier for this invite

string
invite

Value is always invite

A mini representation of a user, used when nested within another resource.

11446498

The unique identifier for this user

user

Value is always user

string / email
ceo@example.com

The primary email address of this user

Aaron Levie50

The display name of this user

string / date-time
2012-12-12T10:53:43-08:00

When the invite was created

object

A mini representation of a user, used when nested within another resource.

11446498

The unique identifier for this user

user

Value is always user

string / email
ceo@example.com

The primary email address of this user

Aaron Levie50

The display name of this user

object

A representation of a Box enterprise

11446498

The unique identifier for this enterprise.

enterprise

Value is always enterprise

Acme Inc.

The name of the enterprise

string / date-time
2012-12-12T10:53:43-08:00

When the invite was modified.

string
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"
}