Box Developer Documentation
Log in
Latest version

Get user invite status

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

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Returns the status of a user invite.

Request

bearer [ACCESS_TOKEN]
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.

application/jsonClient error

An unexpected client error.

get
Get user invite status
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versionig strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/invites/213723" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.invites.getInviteById(invitation.id);
Python v10
client.invites.get_invite_by_id(invitation.id)
.NET v10
await client.Invites.GetInviteByIdAsync(inviteId: invitation.Id);
Swift v10
try await client.invites.getInviteById(inviteId: invitation.id)
Java v10
client.getInvites().getInviteById(invitation.getId())

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