Get user invite status

get
https://api.box.com/2.0
/invites/:invite_id

Returns the status of a user invite.

Request

application/json

Path Parameters

stringin pathrequired
213723

The ID of an invite.

Query Parameters

string arrayin queryoptional
id,type,name

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

Response

application/jsonInvite

Returns an invite object

You can now try out some of our APIs live, right here in the documentation.
Log In

Request Example

cURL
curl -X GET https://api.box.com/2.0/invites/213723 \
     -H "Authorization: Bearer <ACCESS_TOKEN>"

Response Example

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