Sample - Box Platform API
GET/invites/{invite_id}

Get user invite status

Retrieves the status and details of a user invite. Use invite_id to identify the invite and fields to request additional attributes beyond the standard response. When fields is supplied, standard fields are omitted unless you explicitly include them.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
invite_idstringrequired
The unique identifier of the user invite to retrieve.
fieldsarray<string>optional
A comma-separated list of response attributes to include; when supplied, standard fields are returned only if explicitly requested.

2 status codes
200Returns an invite object containing its identifier, type, status, enterprise, users involved, and creation and modification timestamps.
idstringrequired
The unique identifier for this invite.
typestringrequired
The value will always be `invite`.
Allowed:invite
invited_toobjectoptional
A representation of a Box enterprise.
actionable_byobjectoptional
A mini representation of a user, as can be returned when nested within other resources.
invited_byobjectoptional
A mini representation of a user, as can be returned when nested within other resources.
statusstringoptional
The status of the invite.
created_atstringoptional
When the invite was created.
modified_atstringoptional
When the invite was modified.
defaultReturned when an unexpected client error occurs.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

invite_id must identify an existing user invite. If you provide fields, pass a comma-separated list of response attributes and explicitly include any standard fields you want returned.