Box Developer Documentation
Log in

Invite

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

An invite for a user to an enterprise.

string
11446498

The unique identifier for this invite

string
invite

invite

Value is always invite

User (Mini) object

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

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

When the invite was created

User (Mini) object

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

object

A representation of a Box enterprise

string
11446498

The unique identifier for this enterprise.

string
enterprise

enterprise

Value is always enterprise

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