Box Developer Documentation

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Invite

This resource is used by endpoints 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

The value will always be invite.

Value is always invite

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.

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

object

A representation of a Box enterprise.

11446498

The unique identifier for this enterprise.

enterprise

The value will always be 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"
}