KosmoKrator

data

Box Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Box KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.box.*. Use lua_read_doc("integrations.box") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Box workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.box.authorize_user({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("box"))' --json
kosmo integrations:lua --eval 'print(docs.read("box.authorize_user"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local box = app.integrations.box
local result = box.authorize_user({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.box, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.box.default.* or app.integrations.box.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Box, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Box Integration

Box provides cloud content management APIs. This package exposes generated tools from the official Box OpenAPI document at https://raw.githubusercontent.com/box/box-openapi/main/openapi.json.

Configuration

FieldTypeRequiredDescription
access_tokensecretYesBox OAuth2 access token or developer token sent as a Bearer token.
urlurlNoBox API base URL. Default is https://api.box.com/2.0.
upload_urlurlNoBox upload API base URL. Default is https://upload.box.com/api/2.0.

Usage Pattern

Tool names are generated from official Box operation IDs:

  • box_get_files_id
  • box_get_folders_id_items
  • box_post_files_content
  • box_get_search
  • box_get_users_me

Path and query parameters are exposed as snake_case tool arguments. JSON and multipart request payloads are passed through body with Box’s official field names.

box_get_folders_id_items({
  folder_id = "0",
  limit = 100,
  fields = "id,type,name,size,modified_at"
})
box_get_files_id({
  file_id = "12345",
  fields = "id,type,name,size,shared_link"
})
box_get_search({
  query = "quarterly report",
  type = "file",
  limit = 25
})

Multipart upload operations use the upload_url host. Provide multipart fields in body; local file paths are streamed when the value points to an existing file.

box_post_files_content({
  body = {
    attributes = '{"name":"notes.txt","parent":{"id":"0"}}',
    file = "/tmp/notes.txt"
  }
})

Additional documented query parameters can be passed exactly as named through query.

box_get_events({
  query = {
    stream_type = "admin_logs",
    limit = 100
  }
})

Return Shape

JSON responses are returned as parsed Box response objects. Non-JSON responses, such as file downloads, are returned as:

{
  body = "...",
  content_type = "application/octet-stream"
}

204 No Content responses return an empty object. Errors are normalized into tool errors that include the Box HTTP status and message when available.

Notes

  • This package covers the official Box Platform API operations from the OpenAPI spec: files, folders, users, groups, collaborations, metadata, tasks, comments, retention policies, legal holds, sign requests, webhooks, events, collections, and file requests.
  • OAuth token issuance endpoints are present in the OpenAPI metadata, but this integration is configured for host-stored access tokens.
  • Use fake file IDs, folder IDs, user IDs, URLs, and tokens in tests and examples.
Raw agent markdown 
# Box Integration

Box provides cloud content management APIs. This package exposes generated tools from the official Box OpenAPI document at `https://raw.githubusercontent.com/box/box-openapi/main/openapi.json`.

## Configuration

| Field | Type | Required | Description |
|-------|------|----------|-------------|
| `access_token` | secret | Yes | Box OAuth2 access token or developer token sent as a Bearer token. |
| `url` | url | No | Box API base URL. Default is `https://api.box.com/2.0`. |
| `upload_url` | url | No | Box upload API base URL. Default is `https://upload.box.com/api/2.0`. |

## Usage Pattern

Tool names are generated from official Box operation IDs:

- `box_get_files_id`
- `box_get_folders_id_items`
- `box_post_files_content`
- `box_get_search`
- `box_get_users_me`

Path and query parameters are exposed as snake_case tool arguments. JSON and multipart request payloads are passed through `body` with Box's official field names.

```lua
box_get_folders_id_items({
  folder_id = "0",
  limit = 100,
  fields = "id,type,name,size,modified_at"
})
```

```lua
box_get_files_id({
  file_id = "12345",
  fields = "id,type,name,size,shared_link"
})
```

```lua
box_get_search({
  query = "quarterly report",
  type = "file",
  limit = 25
})
```

Multipart upload operations use the `upload_url` host. Provide multipart fields in `body`; local file paths are streamed when the value points to an existing file.

```lua
box_post_files_content({
  body = {
    attributes = '{"name":"notes.txt","parent":{"id":"0"}}',
    file = "/tmp/notes.txt"
  }
})
```

Additional documented query parameters can be passed exactly as named through `query`.

```lua
box_get_events({
  query = {
    stream_type = "admin_logs",
    limit = 100
  }
})
```

## Return Shape

JSON responses are returned as parsed Box response objects. Non-JSON responses, such as file downloads, are returned as:

```lua
{
  body = "...",
  content_type = "application/octet-stream"
}
```

`204 No Content` responses return an empty object. Errors are normalized into tool errors that include the Box HTTP status and message when available.

## Notes

- This package covers the official Box Platform API operations from the OpenAPI spec: files, folders, users, groups, collaborations, metadata, tasks, comments, retention policies, legal holds, sign requests, webhooks, events, collections, and file requests.
- OAuth token issuance endpoints are present in the OpenAPI metadata, but this integration is configured for host-stored access tokens.
- Use fake file IDs, folder IDs, user IDs, URLs, and tokens in tests and examples.
Metadata-derived Lua example 
local result = app.integrations.box.authorize_user({})
print(result)

Functions

authorize_user Read

Execute official Box API operation `get_authorize`. Endpoint: GET /authorize.

Lua path
app.integrations.box.authorize_user
Full name
box.box_get_authorize
ParameterTypeRequiredDescription
No parameters.
request_access_token Write

Execute official Box API operation `post_oauth2_token`. Endpoint: POST /oauth2/token.

Lua path
app.integrations.box.request_access_token
Full name
box.box_post_oauth2_token
ParameterTypeRequiredDescription
No parameters.
refresh_access_token Write

Execute official Box API operation `post_oauth2_token#refresh`. Endpoint: POST /oauth2/token#refresh.

Lua path
app.integrations.box.refresh_access_token
Full name
box.box_post_oauth2_token_refresh
ParameterTypeRequiredDescription
No parameters.
revoke_access_token Write

Execute official Box API operation `post_oauth2_revoke`. Endpoint: POST /oauth2/revoke.

Lua path
app.integrations.box.revoke_access_token
Full name
box.box_post_oauth2_revoke
ParameterTypeRequiredDescription
No parameters.
get_file_information Read

Execute official Box API operation `get_files_id`. Endpoint: GET /files/{file_id}.

Lua path
app.integrations.box.get_file_information
Full name
box.box_get_files_id
ParameterTypeRequiredDescription
No parameters.
restore_file Write

Execute official Box API operation `post_files_id`. Endpoint: POST /files/{file_id}.

Lua path
app.integrations.box.restore_file
Full name
box.box_post_files_id
ParameterTypeRequiredDescription
No parameters.
update_file Write

Execute official Box API operation `put_files_id`. Endpoint: PUT /files/{file_id}.

Lua path
app.integrations.box.update_file
Full name
box.box_put_files_id
ParameterTypeRequiredDescription
No parameters.
delete_file Write

Execute official Box API operation `delete_files_id`. Endpoint: DELETE /files/{file_id}.

Lua path
app.integrations.box.delete_file
Full name
box.box_delete_files_id
ParameterTypeRequiredDescription
No parameters.
list_file_app_item_associations Read

Execute official Box API operation `get_files_id_app_item_associations`. Endpoint: GET /files/{file_id}/app_item_associations.

Lua path
app.integrations.box.list_file_app_item_associations
Full name
box.box_get_files_id_app_item_associations
ParameterTypeRequiredDescription
No parameters.
download_file Read

Execute official Box API operation `get_files_id_content`. Endpoint: GET /files/{file_id}/content.

Lua path
app.integrations.box.download_file
Full name
box.box_get_files_id_content
ParameterTypeRequiredDescription
No parameters.
upload_file_version Write

Execute official Box API operation `post_files_id_content`. Endpoint: POST /files/{file_id}/content.

Lua path
app.integrations.box.upload_file_version
Full name
box.box_post_files_id_content
ParameterTypeRequiredDescription
No parameters.
upload_file Write

Execute official Box API operation `post_files_content`. Endpoint: POST /files/content.

Lua path
app.integrations.box.upload_file
Full name
box.box_post_files_content
ParameterTypeRequiredDescription
No parameters.
create_upload_session Write

Execute official Box API operation `post_files_upload_sessions`. Endpoint: POST /files/upload_sessions.

Lua path
app.integrations.box.create_upload_session
Full name
box.box_post_files_upload_sessions
ParameterTypeRequiredDescription
No parameters.
create_upload_session_existing_file Write

Execute official Box API operation `post_files_id_upload_sessions`. Endpoint: POST /files/{file_id}/upload_sessions.

Lua path
app.integrations.box.create_upload_session_existing_file
Full name
box.box_post_files_id_upload_sessions
ParameterTypeRequiredDescription
No parameters.
get_upload_session Read

Execute official Box API operation `get_files_upload_sessions_id`. Endpoint: GET /files/upload_sessions/{upload_session_id}.

Lua path
app.integrations.box.get_upload_session
Full name
box.box_get_files_upload_sessions_id
ParameterTypeRequiredDescription
No parameters.
upload_part_file Write

Execute official Box API operation `put_files_upload_sessions_id`. Endpoint: PUT /files/upload_sessions/{upload_session_id}.

Lua path
app.integrations.box.upload_part_file
Full name
box.box_put_files_upload_sessions_id
ParameterTypeRequiredDescription
No parameters.
remove_upload_session Write

Execute official Box API operation `delete_files_upload_sessions_id`. Endpoint: DELETE /files/upload_sessions/{upload_session_id}.

Lua path
app.integrations.box.remove_upload_session
Full name
box.box_delete_files_upload_sessions_id
ParameterTypeRequiredDescription
No parameters.
list_parts Read

Execute official Box API operation `get_files_upload_sessions_id_parts`. Endpoint: GET /files/upload_sessions/{upload_session_id}/parts.

Lua path
app.integrations.box.list_parts
Full name
box.box_get_files_upload_sessions_id_parts
ParameterTypeRequiredDescription
No parameters.
commit_upload_session Write

Execute official Box API operation `post_files_upload_sessions_id_commit`. Endpoint: POST /files/upload_sessions/{upload_session_id}/commit.

Lua path
app.integrations.box.commit_upload_session
Full name
box.box_post_files_upload_sessions_id_commit
ParameterTypeRequiredDescription
No parameters.
copy_file Write

Execute official Box API operation `post_files_id_copy`. Endpoint: POST /files/{file_id}/copy.

Lua path
app.integrations.box.copy_file
Full name
box.box_post_files_id_copy
ParameterTypeRequiredDescription
No parameters.
get_file_thumbnail Read

Execute official Box API operation `get_files_id_thumbnail_id`. Endpoint: GET /files/{file_id}/thumbnail.{extension}.

Lua path
app.integrations.box.get_file_thumbnail
Full name
box.box_get_files_id_thumbnail_id
ParameterTypeRequiredDescription
No parameters.
list_file_collaborations Read

Execute official Box API operation `get_files_id_collaborations`. Endpoint: GET /files/{file_id}/collaborations.

Lua path
app.integrations.box.list_file_collaborations
Full name
box.box_get_files_id_collaborations
ParameterTypeRequiredDescription
No parameters.
list_file_comments Read

Execute official Box API operation `get_files_id_comments`. Endpoint: GET /files/{file_id}/comments.

Lua path
app.integrations.box.list_file_comments
Full name
box.box_get_files_id_comments
ParameterTypeRequiredDescription
No parameters.
list_tasks_file Read

Execute official Box API operation `get_files_id_tasks`. Endpoint: GET /files/{file_id}/tasks.

Lua path
app.integrations.box.list_tasks_file
Full name
box.box_get_files_id_tasks
ParameterTypeRequiredDescription
No parameters.
get_trashed_file Read

Execute official Box API operation `get_files_id_trash`. Endpoint: GET /files/{file_id}/trash.

Lua path
app.integrations.box.get_trashed_file
Full name
box.box_get_files_id_trash
ParameterTypeRequiredDescription
No parameters.
permanently_remove_file Write

Execute official Box API operation `delete_files_id_trash`. Endpoint: DELETE /files/{file_id}/trash.

Lua path
app.integrations.box.permanently_remove_file
Full name
box.box_delete_files_id_trash
ParameterTypeRequiredDescription
No parameters.
list_all_file_versions Read

Execute official Box API operation `get_files_id_versions`. Endpoint: GET /files/{file_id}/versions.

Lua path
app.integrations.box.list_all_file_versions
Full name
box.box_get_files_id_versions
ParameterTypeRequiredDescription
No parameters.
get_file_version Read

Execute official Box API operation `get_files_id_versions_id`. Endpoint: GET /files/{file_id}/versions/{file_version_id}.

Lua path
app.integrations.box.get_file_version
Full name
box.box_get_files_id_versions_id
ParameterTypeRequiredDescription
No parameters.
remove_file_version Write

Execute official Box API operation `delete_files_id_versions_id`. Endpoint: DELETE /files/{file_id}/versions/{file_version_id}.

Lua path
app.integrations.box.remove_file_version
Full name
box.box_delete_files_id_versions_id
ParameterTypeRequiredDescription
No parameters.
restore_file_version Write

Execute official Box API operation `put_files_id_versions_id`. Endpoint: PUT /files/{file_id}/versions/{file_version_id}.

Lua path
app.integrations.box.restore_file_version
Full name
box.box_put_files_id_versions_id
ParameterTypeRequiredDescription
No parameters.
promote_file_version Write

Execute official Box API operation `post_files_id_versions_current`. Endpoint: POST /files/{file_id}/versions/current.

Lua path
app.integrations.box.promote_file_version
Full name
box.box_post_files_id_versions_current
ParameterTypeRequiredDescription
No parameters.
list_metadata_instances_file Read

Execute official Box API operation `get_files_id_metadata`. Endpoint: GET /files/{file_id}/metadata.

Lua path
app.integrations.box.list_metadata_instances_file
Full name
box.box_get_files_id_metadata
ParameterTypeRequiredDescription
No parameters.
get_classification_file Read

Execute official Box API operation `get_files_id_metadata_enterprise_securityClassification-6VMVochwUWo`. Endpoint: GET /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo.

Lua path
app.integrations.box.get_classification_file
Full name
box.box_get_files_id_metadata_enterprise_security_classification_6_vmvochw_uwo
ParameterTypeRequiredDescription
No parameters.
add_classification_file Write

Execute official Box API operation `post_files_id_metadata_enterprise_securityClassification-6VMVochwUWo`. Endpoint: POST /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo.

Lua path
app.integrations.box.add_classification_file
Full name
box.box_post_files_id_metadata_enterprise_security_classification_6_vmvochw_uwo
ParameterTypeRequiredDescription
No parameters.
update_classification_file Write

Execute official Box API operation `put_files_id_metadata_enterprise_securityClassification-6VMVochwUWo`. Endpoint: PUT /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo.

Lua path
app.integrations.box.update_classification_file
Full name
box.box_put_files_id_metadata_enterprise_security_classification_6_vmvochw_uwo
ParameterTypeRequiredDescription
No parameters.
remove_classification_from_file Write

Execute official Box API operation `delete_files_id_metadata_enterprise_securityClassification-6VMVochwUWo`. Endpoint: DELETE /files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo.

Lua path
app.integrations.box.remove_classification_from_file
Full name
box.box_delete_files_id_metadata_enterprise_security_classification_6_vmvochw_uwo
ParameterTypeRequiredDescription
No parameters.
get_metadata_instance_file Read

Execute official Box API operation `get_files_id_metadata_id_id`. Endpoint: GET /files/{file_id}/metadata/{scope}/{template_key}.

Lua path
app.integrations.box.get_metadata_instance_file
Full name
box.box_get_files_id_metadata_id_id
ParameterTypeRequiredDescription
No parameters.
create_metadata_instance_file Write

Execute official Box API operation `post_files_id_metadata_id_id`. Endpoint: POST /files/{file_id}/metadata/{scope}/{template_key}.

Lua path
app.integrations.box.create_metadata_instance_file
Full name
box.box_post_files_id_metadata_id_id
ParameterTypeRequiredDescription
No parameters.
update_metadata_instance_file Write

Execute official Box API operation `put_files_id_metadata_id_id`. Endpoint: PUT /files/{file_id}/metadata/{scope}/{template_key}.

Lua path
app.integrations.box.update_metadata_instance_file
Full name
box.box_put_files_id_metadata_id_id
ParameterTypeRequiredDescription
No parameters.
remove_metadata_instance_from_file Write

Execute official Box API operation `delete_files_id_metadata_id_id`. Endpoint: DELETE /files/{file_id}/metadata/{scope}/{template_key}.

Lua path
app.integrations.box.remove_metadata_instance_from_file
Full name
box.box_delete_files_id_metadata_id_id
ParameterTypeRequiredDescription
No parameters.
list_skill_cards_file Read

Execute official Box API operation `get_files_id_metadata_global_boxSkillsCards`. Endpoint: GET /files/{file_id}/metadata/global/boxSkillsCards.

Lua path
app.integrations.box.list_skill_cards_file
Full name
box.box_get_files_id_metadata_global_box_skills_cards
ParameterTypeRequiredDescription
No parameters.
create_skill_cards_file Write

Execute official Box API operation `post_files_id_metadata_global_boxSkillsCards`. Endpoint: POST /files/{file_id}/metadata/global/boxSkillsCards.

Lua path
app.integrations.box.create_skill_cards_file
Full name
box.box_post_files_id_metadata_global_box_skills_cards
ParameterTypeRequiredDescription
No parameters.
update_skill_cards_file Write

Execute official Box API operation `put_files_id_metadata_global_boxSkillsCards`. Endpoint: PUT /files/{file_id}/metadata/global/boxSkillsCards.

Lua path
app.integrations.box.update_skill_cards_file
Full name
box.box_put_files_id_metadata_global_box_skills_cards
ParameterTypeRequiredDescription
No parameters.
remove_skill_cards_from_file Write

Execute official Box API operation `delete_files_id_metadata_global_boxSkillsCards`. Endpoint: DELETE /files/{file_id}/metadata/global/boxSkillsCards.

Lua path
app.integrations.box.remove_skill_cards_from_file
Full name
box.box_delete_files_id_metadata_global_box_skills_cards
ParameterTypeRequiredDescription
No parameters.
get_watermark_file Read

Execute official Box API operation `get_files_id_watermark`. Endpoint: GET /files/{file_id}/watermark.

Lua path
app.integrations.box.get_watermark_file
Full name
box.box_get_files_id_watermark
ParameterTypeRequiredDescription
No parameters.
apply_watermark_file Write

Execute official Box API operation `put_files_id_watermark`. Endpoint: PUT /files/{file_id}/watermark.

Lua path
app.integrations.box.apply_watermark_file
Full name
box.box_put_files_id_watermark
ParameterTypeRequiredDescription
No parameters.
remove_watermark_from_file Write

Execute official Box API operation `delete_files_id_watermark`. Endpoint: DELETE /files/{file_id}/watermark.

Lua path
app.integrations.box.remove_watermark_from_file
Full name
box.box_delete_files_id_watermark
ParameterTypeRequiredDescription
No parameters.
get_file_request Read

Execute official Box API operation `get_file_requests_id`. Endpoint: GET /file_requests/{file_request_id}.

Lua path
app.integrations.box.get_file_request
Full name
box.box_get_file_requests_id
ParameterTypeRequiredDescription
No parameters.
update_file_request Write

Execute official Box API operation `put_file_requests_id`. Endpoint: PUT /file_requests/{file_request_id}.

Lua path
app.integrations.box.update_file_request
Full name
box.box_put_file_requests_id
ParameterTypeRequiredDescription
No parameters.
delete_file_request Write

Execute official Box API operation `delete_file_requests_id`. Endpoint: DELETE /file_requests/{file_request_id}.

Lua path
app.integrations.box.delete_file_request
Full name
box.box_delete_file_requests_id
ParameterTypeRequiredDescription
No parameters.
copy_file_request Write

Execute official Box API operation `post_file_requests_id_copy`. Endpoint: POST /file_requests/{file_request_id}/copy.

Lua path
app.integrations.box.copy_file_request
Full name
box.box_post_file_requests_id_copy
ParameterTypeRequiredDescription
No parameters.
get_folder_information Read

Execute official Box API operation `get_folders_id`. Endpoint: GET /folders/{folder_id}.

Lua path
app.integrations.box.get_folder_information
Full name
box.box_get_folders_id
ParameterTypeRequiredDescription
No parameters.
restore_folder Write

Execute official Box API operation `post_folders_id`. Endpoint: POST /folders/{folder_id}.

Lua path
app.integrations.box.restore_folder
Full name
box.box_post_folders_id
ParameterTypeRequiredDescription
No parameters.
update_folder Write

Execute official Box API operation `put_folders_id`. Endpoint: PUT /folders/{folder_id}.

Lua path
app.integrations.box.update_folder
Full name
box.box_put_folders_id
ParameterTypeRequiredDescription
No parameters.
delete_folder Write

Execute official Box API operation `delete_folders_id`. Endpoint: DELETE /folders/{folder_id}.

Lua path
app.integrations.box.delete_folder
Full name
box.box_delete_folders_id
ParameterTypeRequiredDescription
No parameters.
list_folder_app_item_associations Read

Execute official Box API operation `get_folders_id_app_item_associations`. Endpoint: GET /folders/{folder_id}/app_item_associations.

Lua path
app.integrations.box.list_folder_app_item_associations
Full name
box.box_get_folders_id_app_item_associations
ParameterTypeRequiredDescription
No parameters.
list_items_folder Read

Execute official Box API operation `get_folders_id_items`. Endpoint: GET /folders/{folder_id}/items.

Lua path
app.integrations.box.list_items_folder
Full name
box.box_get_folders_id_items
ParameterTypeRequiredDescription
No parameters.
create_folder Write

Execute official Box API operation `post_folders`. Endpoint: POST /folders.

Lua path
app.integrations.box.create_folder
Full name
box.box_post_folders
ParameterTypeRequiredDescription
No parameters.
copy_folder Write

Execute official Box API operation `post_folders_id_copy`. Endpoint: POST /folders/{folder_id}/copy.

Lua path
app.integrations.box.copy_folder
Full name
box.box_post_folders_id_copy
ParameterTypeRequiredDescription
No parameters.
list_folder_collaborations Read

Execute official Box API operation `get_folders_id_collaborations`. Endpoint: GET /folders/{folder_id}/collaborations.

Lua path
app.integrations.box.list_folder_collaborations
Full name
box.box_get_folders_id_collaborations
ParameterTypeRequiredDescription
No parameters.
get_trashed_folder Read

Execute official Box API operation `get_folders_id_trash`. Endpoint: GET /folders/{folder_id}/trash.

Lua path
app.integrations.box.get_trashed_folder
Full name
box.box_get_folders_id_trash
ParameterTypeRequiredDescription
No parameters.
permanently_remove_folder Write

Execute official Box API operation `delete_folders_id_trash`. Endpoint: DELETE /folders/{folder_id}/trash.

Lua path
app.integrations.box.permanently_remove_folder
Full name
box.box_delete_folders_id_trash
ParameterTypeRequiredDescription
No parameters.
list_metadata_instances_folder Read

Execute official Box API operation `get_folders_id_metadata`. Endpoint: GET /folders/{folder_id}/metadata.

Lua path
app.integrations.box.list_metadata_instances_folder
Full name
box.box_get_folders_id_metadata
ParameterTypeRequiredDescription
No parameters.
get_classification_folder Read

Execute official Box API operation `get_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo`. Endpoint: GET /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo.

Lua path
app.integrations.box.get_classification_folder
Full name
box.box_get_folders_id_metadata_enterprise_security_classification_6_vmvochw_uwo
ParameterTypeRequiredDescription
No parameters.
add_classification_folder Write

Execute official Box API operation `post_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo`. Endpoint: POST /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo.

Lua path
app.integrations.box.add_classification_folder
Full name
box.box_post_folders_id_metadata_enterprise_security_classification_6_vmvochw_uwo
ParameterTypeRequiredDescription
No parameters.
update_classification_folder Write

Execute official Box API operation `put_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo`. Endpoint: PUT /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo.

Lua path
app.integrations.box.update_classification_folder
Full name
box.box_put_folders_id_metadata_enterprise_security_classification_6_vmvochw_uwo
ParameterTypeRequiredDescription
No parameters.
remove_classification_from_folder Write

Execute official Box API operation `delete_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo`. Endpoint: DELETE /folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo.

Lua path
app.integrations.box.remove_classification_from_folder
Full name
box.box_delete_folders_id_metadata_enterprise_security_classification_6_vmvochw_uwo
ParameterTypeRequiredDescription
No parameters.
get_metadata_instance_folder Read

Execute official Box API operation `get_folders_id_metadata_id_id`. Endpoint: GET /folders/{folder_id}/metadata/{scope}/{template_key}.

Lua path
app.integrations.box.get_metadata_instance_folder
Full name
box.box_get_folders_id_metadata_id_id
ParameterTypeRequiredDescription
No parameters.
create_metadata_instance_folder Write

Execute official Box API operation `post_folders_id_metadata_id_id`. Endpoint: POST /folders/{folder_id}/metadata/{scope}/{template_key}.

Lua path
app.integrations.box.create_metadata_instance_folder
Full name
box.box_post_folders_id_metadata_id_id
ParameterTypeRequiredDescription
No parameters.
update_metadata_instance_folder Write

Execute official Box API operation `put_folders_id_metadata_id_id`. Endpoint: PUT /folders/{folder_id}/metadata/{scope}/{template_key}.

Lua path
app.integrations.box.update_metadata_instance_folder
Full name
box.box_put_folders_id_metadata_id_id
ParameterTypeRequiredDescription
No parameters.
remove_metadata_instance_from_folder Write

Execute official Box API operation `delete_folders_id_metadata_id_id`. Endpoint: DELETE /folders/{folder_id}/metadata/{scope}/{template_key}.

Lua path
app.integrations.box.remove_metadata_instance_from_folder
Full name
box.box_delete_folders_id_metadata_id_id
ParameterTypeRequiredDescription
No parameters.
list_trashed_items Read

Execute official Box API operation `get_folders_trash_items`. Endpoint: GET /folders/trash/items.

Lua path
app.integrations.box.list_trashed_items
Full name
box.box_get_folders_trash_items
ParameterTypeRequiredDescription
No parameters.
get_watermark_folder Read

Execute official Box API operation `get_folders_id_watermark`. Endpoint: GET /folders/{folder_id}/watermark.

Lua path
app.integrations.box.get_watermark_folder
Full name
box.box_get_folders_id_watermark
ParameterTypeRequiredDescription
No parameters.
apply_watermark_folder Write

Execute official Box API operation `put_folders_id_watermark`. Endpoint: PUT /folders/{folder_id}/watermark.

Lua path
app.integrations.box.apply_watermark_folder
Full name
box.box_put_folders_id_watermark
ParameterTypeRequiredDescription
No parameters.
remove_watermark_from_folder Write

Execute official Box API operation `delete_folders_id_watermark`. Endpoint: DELETE /folders/{folder_id}/watermark.

Lua path
app.integrations.box.remove_watermark_from_folder
Full name
box.box_delete_folders_id_watermark
ParameterTypeRequiredDescription
No parameters.
list_folder_locks Read

Execute official Box API operation `get_folder_locks`. Endpoint: GET /folder_locks.

Lua path
app.integrations.box.list_folder_locks
Full name
box.box_get_folder_locks
ParameterTypeRequiredDescription
No parameters.
create_folder_lock Write

Execute official Box API operation `post_folder_locks`. Endpoint: POST /folder_locks.

Lua path
app.integrations.box.create_folder_lock
Full name
box.box_post_folder_locks
ParameterTypeRequiredDescription
No parameters.
delete_folder_lock Write

Execute official Box API operation `delete_folder_locks_id`. Endpoint: DELETE /folder_locks/{folder_lock_id}.

Lua path
app.integrations.box.delete_folder_lock
Full name
box.box_delete_folder_locks_id
ParameterTypeRequiredDescription
No parameters.
find_metadata_template_by_instance_id Read

Execute official Box API operation `get_metadata_templates`. Endpoint: GET /metadata_templates.

Lua path
app.integrations.box.find_metadata_template_by_instance_id
Full name
box.box_get_metadata_templates
ParameterTypeRequiredDescription
No parameters.
list_all_classifications Read

Execute official Box API operation `get_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema`. Endpoint: GET /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema.

Lua path
app.integrations.box.list_all_classifications
Full name
box.box_get_metadata_templates_enterprise_security_classification_6_vmvochw_uwo_schema
ParameterTypeRequiredDescription
No parameters.
add_classification Write

Execute official Box API operation `put_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema#add`. Endpoint: PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#add.

Lua path
app.integrations.box.add_classification
Full name
box.box_put_metadata_templates_enterprise_security_classification_6_vmvochw_uwo_schema_add
ParameterTypeRequiredDescription
No parameters.
update_classification Write

Execute official Box API operation `put_metadata_templates_enterprise_securityClassification-6VMVochwUWo_schema#update`. Endpoint: PUT /metadata_templates/enterprise/securityClassification-6VMVochwUWo/schema#update.

Lua path
app.integrations.box.update_classification
Full name
box.box_put_metadata_templates_enterprise_security_classification_6_vmvochw_uwo_schema_update
ParameterTypeRequiredDescription
No parameters.
get_metadata_template_by_name Read

Execute official Box API operation `get_metadata_templates_id_id_schema`. Endpoint: GET /metadata_templates/{scope}/{template_key}/schema.

Lua path
app.integrations.box.get_metadata_template_by_name
Full name
box.box_get_metadata_templates_id_id_schema
ParameterTypeRequiredDescription
No parameters.
update_metadata_template Write

Execute official Box API operation `put_metadata_templates_id_id_schema`. Endpoint: PUT /metadata_templates/{scope}/{template_key}/schema.

Lua path
app.integrations.box.update_metadata_template
Full name
box.box_put_metadata_templates_id_id_schema
ParameterTypeRequiredDescription
No parameters.
remove_metadata_template Write

Execute official Box API operation `delete_metadata_templates_id_id_schema`. Endpoint: DELETE /metadata_templates/{scope}/{template_key}/schema.

Lua path
app.integrations.box.remove_metadata_template
Full name
box.box_delete_metadata_templates_id_id_schema
ParameterTypeRequiredDescription
No parameters.
get_metadata_template_by_id Read

Execute official Box API operation `get_metadata_templates_id`. Endpoint: GET /metadata_templates/{template_id}.

Lua path
app.integrations.box.get_metadata_template_by_id
Full name
box.box_get_metadata_templates_id
ParameterTypeRequiredDescription
No parameters.
list_all_global_metadata_templates Read

Execute official Box API operation `get_metadata_templates_global`. Endpoint: GET /metadata_templates/global.

Lua path
app.integrations.box.list_all_global_metadata_templates
Full name
box.box_get_metadata_templates_global
ParameterTypeRequiredDescription
No parameters.
list_all_metadata_templates_enterprise Read

Execute official Box API operation `get_metadata_templates_enterprise`. Endpoint: GET /metadata_templates/enterprise.

Lua path
app.integrations.box.list_all_metadata_templates_enterprise
Full name
box.box_get_metadata_templates_enterprise
ParameterTypeRequiredDescription
No parameters.
create_metadata_template Write

Execute official Box API operation `post_metadata_templates_schema`. Endpoint: POST /metadata_templates/schema.

Lua path
app.integrations.box.create_metadata_template
Full name
box.box_post_metadata_templates_schema
ParameterTypeRequiredDescription
No parameters.
add_initial_classifications Write

Execute official Box API operation `post_metadata_templates_schema#classifications`. Endpoint: POST /metadata_templates/schema#classifications.

Lua path
app.integrations.box.add_initial_classifications
Full name
box.box_post_metadata_templates_schema_classifications
ParameterTypeRequiredDescription
No parameters.
list_metadata_cascade_policies Read

Execute official Box API operation `get_metadata_cascade_policies`. Endpoint: GET /metadata_cascade_policies.

Lua path
app.integrations.box.list_metadata_cascade_policies
Full name
box.box_get_metadata_cascade_policies
ParameterTypeRequiredDescription
No parameters.
create_metadata_cascade_policy Write

Execute official Box API operation `post_metadata_cascade_policies`. Endpoint: POST /metadata_cascade_policies.

Lua path
app.integrations.box.create_metadata_cascade_policy
Full name
box.box_post_metadata_cascade_policies
ParameterTypeRequiredDescription
No parameters.
get_metadata_cascade_policy Read

Execute official Box API operation `get_metadata_cascade_policies_id`. Endpoint: GET /metadata_cascade_policies/{metadata_cascade_policy_id}.

Lua path
app.integrations.box.get_metadata_cascade_policy
Full name
box.box_get_metadata_cascade_policies_id
ParameterTypeRequiredDescription
No parameters.
remove_metadata_cascade_policy Write

Execute official Box API operation `delete_metadata_cascade_policies_id`. Endpoint: DELETE /metadata_cascade_policies/{metadata_cascade_policy_id}.

Lua path
app.integrations.box.remove_metadata_cascade_policy
Full name
box.box_delete_metadata_cascade_policies_id
ParameterTypeRequiredDescription
No parameters.
force_apply_metadata_cascade_policy_folder Write

Execute official Box API operation `post_metadata_cascade_policies_id_apply`. Endpoint: POST /metadata_cascade_policies/{metadata_cascade_policy_id}/apply.

Lua path
app.integrations.box.force_apply_metadata_cascade_policy_folder
Full name
box.box_post_metadata_cascade_policies_id_apply
ParameterTypeRequiredDescription
No parameters.
query_files_folders_by_metadata Write

Execute official Box API operation `post_metadata_queries_execute_read`. Endpoint: POST /metadata_queries/execute_read.

Lua path
app.integrations.box.query_files_folders_by_metadata
Full name
box.box_post_metadata_queries_execute_read
ParameterTypeRequiredDescription
No parameters.
get_comment Read

Execute official Box API operation `get_comments_id`. Endpoint: GET /comments/{comment_id}.

Lua path
app.integrations.box.get_comment
Full name
box.box_get_comments_id
ParameterTypeRequiredDescription
No parameters.
update_comment Write

Execute official Box API operation `put_comments_id`. Endpoint: PUT /comments/{comment_id}.

Lua path
app.integrations.box.update_comment
Full name
box.box_put_comments_id
ParameterTypeRequiredDescription
No parameters.
remove_comment Write

Execute official Box API operation `delete_comments_id`. Endpoint: DELETE /comments/{comment_id}.

Lua path
app.integrations.box.remove_comment
Full name
box.box_delete_comments_id
ParameterTypeRequiredDescription
No parameters.
create_comment Write

Execute official Box API operation `post_comments`. Endpoint: POST /comments.

Lua path
app.integrations.box.create_comment
Full name
box.box_post_comments
ParameterTypeRequiredDescription
No parameters.
get_collaboration Read

Execute official Box API operation `get_collaborations_id`. Endpoint: GET /collaborations/{collaboration_id}.

Lua path
app.integrations.box.get_collaboration
Full name
box.box_get_collaborations_id
ParameterTypeRequiredDescription
No parameters.
update_collaboration Write

Execute official Box API operation `put_collaborations_id`. Endpoint: PUT /collaborations/{collaboration_id}.

Lua path
app.integrations.box.update_collaboration
Full name
box.box_put_collaborations_id
ParameterTypeRequiredDescription
No parameters.
remove_collaboration Write

Execute official Box API operation `delete_collaborations_id`. Endpoint: DELETE /collaborations/{collaboration_id}.

Lua path
app.integrations.box.remove_collaboration
Full name
box.box_delete_collaborations_id
ParameterTypeRequiredDescription
No parameters.
list_pending_collaborations Read

Execute official Box API operation `get_collaborations`. Endpoint: GET /collaborations.

Lua path
app.integrations.box.list_pending_collaborations
Full name
box.box_get_collaborations
ParameterTypeRequiredDescription
No parameters.
create_collaboration Write

Execute official Box API operation `post_collaborations`. Endpoint: POST /collaborations.

Lua path
app.integrations.box.create_collaboration
Full name
box.box_post_collaborations
ParameterTypeRequiredDescription
No parameters.
search_content Read

Execute official Box API operation `get_search`. Endpoint: GET /search.

Lua path
app.integrations.box.search_content
Full name
box.box_get_search
ParameterTypeRequiredDescription
No parameters.
create_task Write

Execute official Box API operation `post_tasks`. Endpoint: POST /tasks.

Lua path
app.integrations.box.create_task
Full name
box.box_post_tasks
ParameterTypeRequiredDescription
No parameters.
get_task Read

Execute official Box API operation `get_tasks_id`. Endpoint: GET /tasks/{task_id}.

Lua path
app.integrations.box.get_task
Full name
box.box_get_tasks_id
ParameterTypeRequiredDescription
No parameters.
update_task Write

Execute official Box API operation `put_tasks_id`. Endpoint: PUT /tasks/{task_id}.

Lua path
app.integrations.box.update_task
Full name
box.box_put_tasks_id
ParameterTypeRequiredDescription
No parameters.
remove_task Write

Execute official Box API operation `delete_tasks_id`. Endpoint: DELETE /tasks/{task_id}.

Lua path
app.integrations.box.remove_task
Full name
box.box_delete_tasks_id
ParameterTypeRequiredDescription
No parameters.
list_task_assignments Read

Execute official Box API operation `get_tasks_id_assignments`. Endpoint: GET /tasks/{task_id}/assignments.

Lua path
app.integrations.box.list_task_assignments
Full name
box.box_get_tasks_id_assignments
ParameterTypeRequiredDescription
No parameters.
assign_task Write

Execute official Box API operation `post_task_assignments`. Endpoint: POST /task_assignments.

Lua path
app.integrations.box.assign_task
Full name
box.box_post_task_assignments
ParameterTypeRequiredDescription
No parameters.
get_task_assignment Read

Execute official Box API operation `get_task_assignments_id`. Endpoint: GET /task_assignments/{task_assignment_id}.

Lua path
app.integrations.box.get_task_assignment
Full name
box.box_get_task_assignments_id
ParameterTypeRequiredDescription
No parameters.
update_task_assignment Write

Execute official Box API operation `put_task_assignments_id`. Endpoint: PUT /task_assignments/{task_assignment_id}.

Lua path
app.integrations.box.update_task_assignment
Full name
box.box_put_task_assignments_id
ParameterTypeRequiredDescription
No parameters.
unassign_task Write

Execute official Box API operation `delete_task_assignments_id`. Endpoint: DELETE /task_assignments/{task_assignment_id}.

Lua path
app.integrations.box.unassign_task
Full name
box.box_delete_task_assignments_id
ParameterTypeRequiredDescription
No parameters.
list_enterprise_users Read

Execute official Box API operation `get_users`. Endpoint: GET /users.

Lua path
app.integrations.box.list_enterprise_users
Full name
box.box_get_users
ParameterTypeRequiredDescription
No parameters.
create_user Write

Execute official Box API operation `post_users`. Endpoint: POST /users.

Lua path
app.integrations.box.create_user
Full name
box.box_post_users
ParameterTypeRequiredDescription
No parameters.
get_current_user Read

Execute official Box API operation `get_users_me`. Endpoint: GET /users/me.

Lua path
app.integrations.box.get_current_user
Full name
box.box_get_users_me
ParameterTypeRequiredDescription
No parameters.
create_jobs_terminate_users_session Write

Execute official Box API operation `post_users_terminate_sessions`. Endpoint: POST /users/terminate_sessions.

Lua path
app.integrations.box.create_jobs_terminate_users_session
Full name
box.box_post_users_terminate_sessions
ParameterTypeRequiredDescription
No parameters.
get_user Read

Execute official Box API operation `get_users_id`. Endpoint: GET /users/{user_id}.

Lua path
app.integrations.box.get_user
Full name
box.box_get_users_id
ParameterTypeRequiredDescription
No parameters.
update_user Write

Execute official Box API operation `put_users_id`. Endpoint: PUT /users/{user_id}.

Lua path
app.integrations.box.update_user
Full name
box.box_put_users_id
ParameterTypeRequiredDescription
No parameters.
delete_user Write

Execute official Box API operation `delete_users_id`. Endpoint: DELETE /users/{user_id}.

Lua path
app.integrations.box.delete_user
Full name
box.box_delete_users_id
ParameterTypeRequiredDescription
No parameters.
get_user_avatar Read

Execute official Box API operation `get_users_id_avatar`. Endpoint: GET /users/{user_id}/avatar.

Lua path
app.integrations.box.get_user_avatar
Full name
box.box_get_users_id_avatar
ParameterTypeRequiredDescription
No parameters.
add_or_update_user_avatar Write

Execute official Box API operation `post_users_id_avatar`. Endpoint: POST /users/{user_id}/avatar.

Lua path
app.integrations.box.add_or_update_user_avatar
Full name
box.box_post_users_id_avatar
ParameterTypeRequiredDescription
No parameters.
delete_user_avatar Write

Execute official Box API operation `delete_users_id_avatar`. Endpoint: DELETE /users/{user_id}/avatar.

Lua path
app.integrations.box.delete_user_avatar
Full name
box.box_delete_users_id_avatar
ParameterTypeRequiredDescription
No parameters.
transfer_owned_folders Write

Execute official Box API operation `put_users_id_folders_0`. Endpoint: PUT /users/{user_id}/folders/0.

Lua path
app.integrations.box.transfer_owned_folders
Full name
box.box_put_users_id_folders_0
ParameterTypeRequiredDescription
No parameters.
list_user_email_aliases Read

Execute official Box API operation `get_users_id_email_aliases`. Endpoint: GET /users/{user_id}/email_aliases.

Lua path
app.integrations.box.list_user_email_aliases
Full name
box.box_get_users_id_email_aliases
ParameterTypeRequiredDescription
No parameters.
create_email_alias Write

Execute official Box API operation `post_users_id_email_aliases`. Endpoint: POST /users/{user_id}/email_aliases.

Lua path
app.integrations.box.create_email_alias
Full name
box.box_post_users_id_email_aliases
ParameterTypeRequiredDescription
No parameters.
remove_email_alias Write

Execute official Box API operation `delete_users_id_email_aliases_id`. Endpoint: DELETE /users/{user_id}/email_aliases/{email_alias_id}.

Lua path
app.integrations.box.remove_email_alias
Full name
box.box_delete_users_id_email_aliases_id
ParameterTypeRequiredDescription
No parameters.
list_user_groups Read

Execute official Box API operation `get_users_id_memberships`. Endpoint: GET /users/{user_id}/memberships.

Lua path
app.integrations.box.list_user_groups
Full name
box.box_get_users_id_memberships
ParameterTypeRequiredDescription
No parameters.
create_user_invite Write

Execute official Box API operation `post_invites`. Endpoint: POST /invites.

Lua path
app.integrations.box.create_user_invite
Full name
box.box_post_invites
ParameterTypeRequiredDescription
No parameters.
get_user_invite_status Read

Execute official Box API operation `get_invites_id`. Endpoint: GET /invites/{invite_id}.

Lua path
app.integrations.box.get_user_invite_status
Full name
box.box_get_invites_id
ParameterTypeRequiredDescription
No parameters.
list_groups_enterprise Read

Execute official Box API operation `get_groups`. Endpoint: GET /groups.

Lua path
app.integrations.box.list_groups_enterprise
Full name
box.box_get_groups
ParameterTypeRequiredDescription
No parameters.
create_group Write

Execute official Box API operation `post_groups`. Endpoint: POST /groups.

Lua path
app.integrations.box.create_group
Full name
box.box_post_groups
ParameterTypeRequiredDescription
No parameters.
create_jobs_terminate_user_group_session Write

Execute official Box API operation `post_groups_terminate_sessions`. Endpoint: POST /groups/terminate_sessions.

Lua path
app.integrations.box.create_jobs_terminate_user_group_session
Full name
box.box_post_groups_terminate_sessions
ParameterTypeRequiredDescription
No parameters.
get_group Read

Execute official Box API operation `get_groups_id`. Endpoint: GET /groups/{group_id}.

Lua path
app.integrations.box.get_group
Full name
box.box_get_groups_id
ParameterTypeRequiredDescription
No parameters.
update_group Write

Execute official Box API operation `put_groups_id`. Endpoint: PUT /groups/{group_id}.

Lua path
app.integrations.box.update_group
Full name
box.box_put_groups_id
ParameterTypeRequiredDescription
No parameters.
remove_group Write

Execute official Box API operation `delete_groups_id`. Endpoint: DELETE /groups/{group_id}.

Lua path
app.integrations.box.remove_group
Full name
box.box_delete_groups_id
ParameterTypeRequiredDescription
No parameters.
list_members_group Read

Execute official Box API operation `get_groups_id_memberships`. Endpoint: GET /groups/{group_id}/memberships.

Lua path
app.integrations.box.list_members_group
Full name
box.box_get_groups_id_memberships
ParameterTypeRequiredDescription
No parameters.
list_group_collaborations Read

Execute official Box API operation `get_groups_id_collaborations`. Endpoint: GET /groups/{group_id}/collaborations.

Lua path
app.integrations.box.list_group_collaborations
Full name
box.box_get_groups_id_collaborations
ParameterTypeRequiredDescription
No parameters.
add_user_group Write

Execute official Box API operation `post_group_memberships`. Endpoint: POST /group_memberships.

Lua path
app.integrations.box.add_user_group
Full name
box.box_post_group_memberships
ParameterTypeRequiredDescription
No parameters.
get_group_membership Read

Execute official Box API operation `get_group_memberships_id`. Endpoint: GET /group_memberships/{group_membership_id}.

Lua path
app.integrations.box.get_group_membership
Full name
box.box_get_group_memberships_id
ParameterTypeRequiredDescription
No parameters.
update_group_membership Write

Execute official Box API operation `put_group_memberships_id`. Endpoint: PUT /group_memberships/{group_membership_id}.

Lua path
app.integrations.box.update_group_membership
Full name
box.box_put_group_memberships_id
ParameterTypeRequiredDescription
No parameters.
remove_user_from_group Write

Execute official Box API operation `delete_group_memberships_id`. Endpoint: DELETE /group_memberships/{group_membership_id}.

Lua path
app.integrations.box.remove_user_from_group
Full name
box.box_delete_group_memberships_id
ParameterTypeRequiredDescription
No parameters.
list_all_webhooks Read

Execute official Box API operation `get_webhooks`. Endpoint: GET /webhooks.

Lua path
app.integrations.box.list_all_webhooks
Full name
box.box_get_webhooks
ParameterTypeRequiredDescription
No parameters.
create_webhook Write

Execute official Box API operation `post_webhooks`. Endpoint: POST /webhooks.

Lua path
app.integrations.box.create_webhook
Full name
box.box_post_webhooks
ParameterTypeRequiredDescription
No parameters.
get_webhook Read

Execute official Box API operation `get_webhooks_id`. Endpoint: GET /webhooks/{webhook_id}.

Lua path
app.integrations.box.get_webhook
Full name
box.box_get_webhooks_id
ParameterTypeRequiredDescription
No parameters.
update_webhook Write

Execute official Box API operation `put_webhooks_id`. Endpoint: PUT /webhooks/{webhook_id}.

Lua path
app.integrations.box.update_webhook
Full name
box.box_put_webhooks_id
ParameterTypeRequiredDescription
No parameters.
remove_webhook Write

Execute official Box API operation `delete_webhooks_id`. Endpoint: DELETE /webhooks/{webhook_id}.

Lua path
app.integrations.box.remove_webhook
Full name
box.box_delete_webhooks_id
ParameterTypeRequiredDescription
No parameters.
update_all_skill_cards_file Write

Execute official Box API operation `put_skill_invocations_id`. Endpoint: PUT /skill_invocations/{skill_id}.

Lua path
app.integrations.box.update_all_skill_cards_file
Full name
box.box_put_skill_invocations_id
ParameterTypeRequiredDescription
No parameters.
list_user_and_enterprise_events Read

Execute official Box API operation `get_events`. Endpoint: GET /events.

Lua path
app.integrations.box.list_user_and_enterprise_events
Full name
box.box_get_events
ParameterTypeRequiredDescription
No parameters.
list_all_collections Read

Execute official Box API operation `get_collections`. Endpoint: GET /collections.

Lua path
app.integrations.box.list_all_collections
Full name
box.box_get_collections
ParameterTypeRequiredDescription
No parameters.
list_collection_items Read

Execute official Box API operation `get_collections_id_items`. Endpoint: GET /collections/{collection_id}/items.

Lua path
app.integrations.box.list_collection_items
Full name
box.box_get_collections_id_items
ParameterTypeRequiredDescription
No parameters.
get_collection_by_id Read

Execute official Box API operation `get_collections_id`. Endpoint: GET /collections/{collection_id}.

Lua path
app.integrations.box.get_collection_by_id
Full name
box.box_get_collections_id
ParameterTypeRequiredDescription
No parameters.
list_recently_accessed_items Read

Execute official Box API operation `get_recent_items`. Endpoint: GET /recent_items.

Lua path
app.integrations.box.list_recently_accessed_items
Full name
box.box_get_recent_items
ParameterTypeRequiredDescription
No parameters.
list_retention_policies Read

Execute official Box API operation `get_retention_policies`. Endpoint: GET /retention_policies.

Lua path
app.integrations.box.list_retention_policies
Full name
box.box_get_retention_policies
ParameterTypeRequiredDescription
No parameters.
create_retention_policy Write

Execute official Box API operation `post_retention_policies`. Endpoint: POST /retention_policies.

Lua path
app.integrations.box.create_retention_policy
Full name
box.box_post_retention_policies
ParameterTypeRequiredDescription
No parameters.
get_retention_policy Read

Execute official Box API operation `get_retention_policies_id`. Endpoint: GET /retention_policies/{retention_policy_id}.

Lua path
app.integrations.box.get_retention_policy
Full name
box.box_get_retention_policies_id
ParameterTypeRequiredDescription
No parameters.
update_retention_policy Write

Execute official Box API operation `put_retention_policies_id`. Endpoint: PUT /retention_policies/{retention_policy_id}.

Lua path
app.integrations.box.update_retention_policy
Full name
box.box_put_retention_policies_id
ParameterTypeRequiredDescription
No parameters.
delete_retention_policy Write

Execute official Box API operation `delete_retention_policies_id`. Endpoint: DELETE /retention_policies/{retention_policy_id}.

Lua path
app.integrations.box.delete_retention_policy
Full name
box.box_delete_retention_policies_id
ParameterTypeRequiredDescription
No parameters.
list_retention_policy_assignments Read

Execute official Box API operation `get_retention_policies_id_assignments`. Endpoint: GET /retention_policies/{retention_policy_id}/assignments.

Lua path
app.integrations.box.list_retention_policy_assignments
Full name
box.box_get_retention_policies_id_assignments
ParameterTypeRequiredDescription
No parameters.
assign_retention_policy Write

Execute official Box API operation `post_retention_policy_assignments`. Endpoint: POST /retention_policy_assignments.

Lua path
app.integrations.box.assign_retention_policy
Full name
box.box_post_retention_policy_assignments
ParameterTypeRequiredDescription
No parameters.
get_retention_policy_assignment Read

Execute official Box API operation `get_retention_policy_assignments_id`. Endpoint: GET /retention_policy_assignments/{retention_policy_assignment_id}.

Lua path
app.integrations.box.get_retention_policy_assignment
Full name
box.box_get_retention_policy_assignments_id
ParameterTypeRequiredDescription
No parameters.
remove_retention_policy_assignment Write

Execute official Box API operation `delete_retention_policy_assignments_id`. Endpoint: DELETE /retention_policy_assignments/{retention_policy_assignment_id}.

Lua path
app.integrations.box.remove_retention_policy_assignment
Full name
box.box_delete_retention_policy_assignments_id
ParameterTypeRequiredDescription
No parameters.
get_files_under_retention Read

Execute official Box API operation `get_retention_policy_assignments_id_files_under_retention`. Endpoint: GET /retention_policy_assignments/{retention_policy_assignment_id}/files_under_retention.

Lua path
app.integrations.box.get_files_under_retention
Full name
box.box_get_retention_policy_assignments_id_files_under_retention
ParameterTypeRequiredDescription
No parameters.
get_file_versions_under_retention Read

Execute official Box API operation `get_retention_policy_assignments_id_file_versions_under_retention`. Endpoint: GET /retention_policy_assignments/{retention_policy_assignment_id}/file_versions_under_retention.

Lua path
app.integrations.box.get_file_versions_under_retention
Full name
box.box_get_retention_policy_assignments_id_file_versions_under_retention
ParameterTypeRequiredDescription
No parameters.
list_file_version_retentions Read

Execute official Box API operation `get_file_version_retentions`. Endpoint: GET /file_version_retentions.

Lua path
app.integrations.box.list_file_version_retentions
Full name
box.box_get_file_version_retentions
ParameterTypeRequiredDescription
No parameters.
get_retention_file Read

Execute official Box API operation `get_file_version_retentions_id`. Endpoint: GET /file_version_retentions/{file_version_retention_id}.

Lua path
app.integrations.box.get_retention_file
Full name
box.box_get_file_version_retentions_id
ParameterTypeRequiredDescription
No parameters.
get_shield_information_barrier_with_specified_id Read

Execute official Box API operation `get_shield_information_barriers_id`. Endpoint: GET /shield_information_barriers/{shield_information_barrier_id}.

Lua path
app.integrations.box.get_shield_information_barrier_with_specified_id
Full name
box.box_get_shield_information_barriers_id
ParameterTypeRequiredDescription
No parameters.
add_changed_status_shield_information_barrier_with_specified_id Write

Execute official Box API operation `post_shield_information_barriers_change_status`. Endpoint: POST /shield_information_barriers/change_status.

Lua path
app.integrations.box.add_changed_status_shield_information_barrier_with_specified_id
Full name
box.box_post_shield_information_barriers_change_status
ParameterTypeRequiredDescription
No parameters.
list_shield_information_barriers Read

Execute official Box API operation `get_shield_information_barriers`. Endpoint: GET /shield_information_barriers.

Lua path
app.integrations.box.list_shield_information_barriers
Full name
box.box_get_shield_information_barriers
ParameterTypeRequiredDescription
No parameters.
create_shield_information_barrier Write

Execute official Box API operation `post_shield_information_barriers`. Endpoint: POST /shield_information_barriers.

Lua path
app.integrations.box.create_shield_information_barrier
Full name
box.box_post_shield_information_barriers
ParameterTypeRequiredDescription
No parameters.
list_shield_information_barrier_reports Read

Execute official Box API operation `get_shield_information_barrier_reports`. Endpoint: GET /shield_information_barrier_reports.

Lua path
app.integrations.box.list_shield_information_barrier_reports
Full name
box.box_get_shield_information_barrier_reports
ParameterTypeRequiredDescription
No parameters.
create_shield_information_barrier_report Write

Execute official Box API operation `post_shield_information_barrier_reports`. Endpoint: POST /shield_information_barrier_reports.

Lua path
app.integrations.box.create_shield_information_barrier_report
Full name
box.box_post_shield_information_barrier_reports
ParameterTypeRequiredDescription
No parameters.
get_shield_information_barrier_report_by_id Read

Execute official Box API operation `get_shield_information_barrier_reports_id`. Endpoint: GET /shield_information_barrier_reports/{shield_information_barrier_report_id}.

Lua path
app.integrations.box.get_shield_information_barrier_report_by_id
Full name
box.box_get_shield_information_barrier_reports_id
ParameterTypeRequiredDescription
No parameters.
get_shield_information_barrier_segment_with_specified_id Read

Execute official Box API operation `get_shield_information_barrier_segments_id`. Endpoint: GET /shield_information_barrier_segments/{shield_information_barrier_segment_id}.

Lua path
app.integrations.box.get_shield_information_barrier_segment_with_specified_id
Full name
box.box_get_shield_information_barrier_segments_id
ParameterTypeRequiredDescription
No parameters.
delete_shield_information_barrier_segment Write

Execute official Box API operation `delete_shield_information_barrier_segments_id`. Endpoint: DELETE /shield_information_barrier_segments/{shield_information_barrier_segment_id}.

Lua path
app.integrations.box.delete_shield_information_barrier_segment
Full name
box.box_delete_shield_information_barrier_segments_id
ParameterTypeRequiredDescription
No parameters.
update_shield_information_barrier_segment_with_specified_id Write

Execute official Box API operation `put_shield_information_barrier_segments_id`. Endpoint: PUT /shield_information_barrier_segments/{shield_information_barrier_segment_id}.

Lua path
app.integrations.box.update_shield_information_barrier_segment_with_specified_id
Full name
box.box_put_shield_information_barrier_segments_id
ParameterTypeRequiredDescription
No parameters.
list_shield_information_barrier_segments Read

Execute official Box API operation `get_shield_information_barrier_segments`. Endpoint: GET /shield_information_barrier_segments.

Lua path
app.integrations.box.list_shield_information_barrier_segments
Full name
box.box_get_shield_information_barrier_segments
ParameterTypeRequiredDescription
No parameters.
create_shield_information_barrier_segment Write

Execute official Box API operation `post_shield_information_barrier_segments`. Endpoint: POST /shield_information_barrier_segments.

Lua path
app.integrations.box.create_shield_information_barrier_segment
Full name
box.box_post_shield_information_barrier_segments
ParameterTypeRequiredDescription
No parameters.
get_shield_information_barrier_segment_member_by_id Read

Execute official Box API operation `get_shield_information_barrier_segment_members_id`. Endpoint: GET /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}.

Lua path
app.integrations.box.get_shield_information_barrier_segment_member_by_id
Full name
box.box_get_shield_information_barrier_segment_members_id
ParameterTypeRequiredDescription
No parameters.
delete_shield_information_barrier_segment_member_by_id Write

Execute official Box API operation `delete_shield_information_barrier_segment_members_id`. Endpoint: DELETE /shield_information_barrier_segment_members/{shield_information_barrier_segment_member_id}.

Lua path
app.integrations.box.delete_shield_information_barrier_segment_member_by_id
Full name
box.box_delete_shield_information_barrier_segment_members_id
ParameterTypeRequiredDescription
No parameters.
list_shield_information_barrier_segment_members Read

Execute official Box API operation `get_shield_information_barrier_segment_members`. Endpoint: GET /shield_information_barrier_segment_members.

Lua path
app.integrations.box.list_shield_information_barrier_segment_members
Full name
box.box_get_shield_information_barrier_segment_members
ParameterTypeRequiredDescription
No parameters.
create_shield_information_barrier_segment_member Write

Execute official Box API operation `post_shield_information_barrier_segment_members`. Endpoint: POST /shield_information_barrier_segment_members.

Lua path
app.integrations.box.create_shield_information_barrier_segment_member
Full name
box.box_post_shield_information_barrier_segment_members
ParameterTypeRequiredDescription
No parameters.
get_shield_information_barrier_segment_restriction_by_id Read

Execute official Box API operation `get_shield_information_barrier_segment_restrictions_id`. Endpoint: GET /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}.

Lua path
app.integrations.box.get_shield_information_barrier_segment_restriction_by_id
Full name
box.box_get_shield_information_barrier_segment_restrictions_id
ParameterTypeRequiredDescription
No parameters.
delete_shield_information_barrier_segment_restriction_by_id Write

Execute official Box API operation `delete_shield_information_barrier_segment_restrictions_id`. Endpoint: DELETE /shield_information_barrier_segment_restrictions/{shield_information_barrier_segment_restriction_id}.

Lua path
app.integrations.box.delete_shield_information_barrier_segment_restriction_by_id
Full name
box.box_delete_shield_information_barrier_segment_restrictions_id
ParameterTypeRequiredDescription
No parameters.
list_shield_information_barrier_segment_restrictions Read

Execute official Box API operation `get_shield_information_barrier_segment_restrictions`. Endpoint: GET /shield_information_barrier_segment_restrictions.

Lua path
app.integrations.box.list_shield_information_barrier_segment_restrictions
Full name
box.box_get_shield_information_barrier_segment_restrictions
ParameterTypeRequiredDescription
No parameters.
create_shield_information_barrier_segment_restriction Write

Execute official Box API operation `post_shield_information_barrier_segment_restrictions`. Endpoint: POST /shield_information_barrier_segment_restrictions.

Lua path
app.integrations.box.create_shield_information_barrier_segment_restriction
Full name
box.box_post_shield_information_barrier_segment_restrictions
ParameterTypeRequiredDescription
No parameters.
get_device_pin Read

Execute official Box API operation `get_device_pinners_id`. Endpoint: GET /device_pinners/{device_pinner_id}.

Lua path
app.integrations.box.get_device_pin
Full name
box.box_get_device_pinners_id
ParameterTypeRequiredDescription
No parameters.
remove_device_pin Write

Execute official Box API operation `delete_device_pinners_id`. Endpoint: DELETE /device_pinners/{device_pinner_id}.

Lua path
app.integrations.box.remove_device_pin
Full name
box.box_delete_device_pinners_id
ParameterTypeRequiredDescription
No parameters.
list_enterprise_device_pins Read

Execute official Box API operation `get_enterprises_id_device_pinners`. Endpoint: GET /enterprises/{enterprise_id}/device_pinners.

Lua path
app.integrations.box.list_enterprise_device_pins
Full name
box.box_get_enterprises_id_device_pinners
ParameterTypeRequiredDescription
No parameters.
list_terms_services Read

Execute official Box API operation `get_terms_of_services`. Endpoint: GET /terms_of_services.

Lua path
app.integrations.box.list_terms_services
Full name
box.box_get_terms_of_services
ParameterTypeRequiredDescription
No parameters.
create_terms_service Write

Execute official Box API operation `post_terms_of_services`. Endpoint: POST /terms_of_services.

Lua path
app.integrations.box.create_terms_service
Full name
box.box_post_terms_of_services
ParameterTypeRequiredDescription
No parameters.
get_terms_service Read

Execute official Box API operation `get_terms_of_services_id`. Endpoint: GET /terms_of_services/{terms_of_service_id}.

Lua path
app.integrations.box.get_terms_service
Full name
box.box_get_terms_of_services_id
ParameterTypeRequiredDescription
No parameters.
update_terms_service Write

Execute official Box API operation `put_terms_of_services_id`. Endpoint: PUT /terms_of_services/{terms_of_service_id}.

Lua path
app.integrations.box.update_terms_service
Full name
box.box_put_terms_of_services_id
ParameterTypeRequiredDescription
No parameters.
list_terms_service_user_statuses Read

Execute official Box API operation `get_terms_of_service_user_statuses`. Endpoint: GET /terms_of_service_user_statuses.

Lua path
app.integrations.box.list_terms_service_user_statuses
Full name
box.box_get_terms_of_service_user_statuses
ParameterTypeRequiredDescription
No parameters.
create_terms_service_status_new_user Write

Execute official Box API operation `post_terms_of_service_user_statuses`. Endpoint: POST /terms_of_service_user_statuses.

Lua path
app.integrations.box.create_terms_service_status_new_user
Full name
box.box_post_terms_of_service_user_statuses
ParameterTypeRequiredDescription
No parameters.
update_terms_service_status_existing_user Write

Execute official Box API operation `put_terms_of_service_user_statuses_id`. Endpoint: PUT /terms_of_service_user_statuses/{terms_of_service_user_status_id}.

Lua path
app.integrations.box.update_terms_service_status_existing_user
Full name
box.box_put_terms_of_service_user_statuses_id
ParameterTypeRequiredDescription
No parameters.
list_allowed_collaboration_domains Read

Execute official Box API operation `get_collaboration_whitelist_entries`. Endpoint: GET /collaboration_whitelist_entries.

Lua path
app.integrations.box.list_allowed_collaboration_domains
Full name
box.box_get_collaboration_whitelist_entries
ParameterTypeRequiredDescription
No parameters.
add_domain_list_allowed_collaboration_domains Write

Execute official Box API operation `post_collaboration_whitelist_entries`. Endpoint: POST /collaboration_whitelist_entries.

Lua path
app.integrations.box.add_domain_list_allowed_collaboration_domains
Full name
box.box_post_collaboration_whitelist_entries
ParameterTypeRequiredDescription
No parameters.
get_allowed_collaboration_domain Read

Execute official Box API operation `get_collaboration_whitelist_entries_id`. Endpoint: GET /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}.

Lua path
app.integrations.box.get_allowed_collaboration_domain
Full name
box.box_get_collaboration_whitelist_entries_id
ParameterTypeRequiredDescription
No parameters.
remove_domain_from_list_allowed_collaboration_domains Write

Execute official Box API operation `delete_collaboration_whitelist_entries_id`. Endpoint: DELETE /collaboration_whitelist_entries/{collaboration_whitelist_entry_id}.

Lua path
app.integrations.box.remove_domain_from_list_allowed_collaboration_domains
Full name
box.box_delete_collaboration_whitelist_entries_id
ParameterTypeRequiredDescription
No parameters.
list_users_exempt_from_collaboration_domain_restrictions Read

Execute official Box API operation `get_collaboration_whitelist_exempt_targets`. Endpoint: GET /collaboration_whitelist_exempt_targets.

Lua path
app.integrations.box.list_users_exempt_from_collaboration_domain_restrictions
Full name
box.box_get_collaboration_whitelist_exempt_targets
ParameterTypeRequiredDescription
No parameters.
create_user_exemption_from_collaboration_domain_restrictions Write

Execute official Box API operation `post_collaboration_whitelist_exempt_targets`. Endpoint: POST /collaboration_whitelist_exempt_targets.

Lua path
app.integrations.box.create_user_exemption_from_collaboration_domain_restrictions
Full name
box.box_post_collaboration_whitelist_exempt_targets
ParameterTypeRequiredDescription
No parameters.
get_user_exempt_from_collaboration_domain_restrictions Read

Execute official Box API operation `get_collaboration_whitelist_exempt_targets_id`. Endpoint: GET /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}.

Lua path
app.integrations.box.get_user_exempt_from_collaboration_domain_restrictions
Full name
box.box_get_collaboration_whitelist_exempt_targets_id
ParameterTypeRequiredDescription
No parameters.
remove_user_from_list_users_exempt_from_domain_restrictions Write

Execute official Box API operation `delete_collaboration_whitelist_exempt_targets_id`. Endpoint: DELETE /collaboration_whitelist_exempt_targets/{collaboration_whitelist_exempt_target_id}.

Lua path
app.integrations.box.remove_user_from_list_users_exempt_from_domain_restrictions
Full name
box.box_delete_collaboration_whitelist_exempt_targets_id
ParameterTypeRequiredDescription
No parameters.
list_storage_policies Read

Execute official Box API operation `get_storage_policies`. Endpoint: GET /storage_policies.

Lua path
app.integrations.box.list_storage_policies
Full name
box.box_get_storage_policies
ParameterTypeRequiredDescription
No parameters.
get_storage_policy Read

Execute official Box API operation `get_storage_policies_id`. Endpoint: GET /storage_policies/{storage_policy_id}.

Lua path
app.integrations.box.get_storage_policy
Full name
box.box_get_storage_policies_id
ParameterTypeRequiredDescription
No parameters.
list_storage_policy_assignments Read

Execute official Box API operation `get_storage_policy_assignments`. Endpoint: GET /storage_policy_assignments.

Lua path
app.integrations.box.list_storage_policy_assignments
Full name
box.box_get_storage_policy_assignments
ParameterTypeRequiredDescription
No parameters.
assign_storage_policy Write

Execute official Box API operation `post_storage_policy_assignments`. Endpoint: POST /storage_policy_assignments.

Lua path
app.integrations.box.assign_storage_policy
Full name
box.box_post_storage_policy_assignments
ParameterTypeRequiredDescription
No parameters.
get_storage_policy_assignment Read

Execute official Box API operation `get_storage_policy_assignments_id`. Endpoint: GET /storage_policy_assignments/{storage_policy_assignment_id}.

Lua path
app.integrations.box.get_storage_policy_assignment
Full name
box.box_get_storage_policy_assignments_id
ParameterTypeRequiredDescription
No parameters.
update_storage_policy_assignment Write

Execute official Box API operation `put_storage_policy_assignments_id`. Endpoint: PUT /storage_policy_assignments/{storage_policy_assignment_id}.

Lua path
app.integrations.box.update_storage_policy_assignment
Full name
box.box_put_storage_policy_assignments_id
ParameterTypeRequiredDescription
No parameters.
unassign_storage_policy Write

Execute official Box API operation `delete_storage_policy_assignments_id`. Endpoint: DELETE /storage_policy_assignments/{storage_policy_assignment_id}.

Lua path
app.integrations.box.unassign_storage_policy
Full name
box.box_delete_storage_policy_assignments_id
ParameterTypeRequiredDescription
No parameters.
create_zip_download Write

Execute official Box API operation `post_zip_downloads`. Endpoint: POST /zip_downloads.

Lua path
app.integrations.box.create_zip_download
Full name
box.box_post_zip_downloads
ParameterTypeRequiredDescription
No parameters.
download_zip_archive Read

Execute official Box API operation `get_zip_downloads_id_content`. Endpoint: GET /zip_downloads/{zip_download_id}/content.

Lua path
app.integrations.box.download_zip_archive
Full name
box.box_get_zip_downloads_id_content
ParameterTypeRequiredDescription
No parameters.
get_zip_download_status Read

Execute official Box API operation `get_zip_downloads_id_status`. Endpoint: GET /zip_downloads/{zip_download_id}/status.

Lua path
app.integrations.box.get_zip_download_status
Full name
box.box_get_zip_downloads_id_status
ParameterTypeRequiredDescription
No parameters.
cancel_sign_request Write

Execute official Box API operation `post_sign_requests_id_cancel`. Endpoint: POST /sign_requests/{sign_request_id}/cancel.

Lua path
app.integrations.box.cancel_sign_request
Full name
box.box_post_sign_requests_id_cancel
ParameterTypeRequiredDescription
No parameters.
resend_sign_request Write

Execute official Box API operation `post_sign_requests_id_resend`. Endpoint: POST /sign_requests/{sign_request_id}/resend.

Lua path
app.integrations.box.resend_sign_request
Full name
box.box_post_sign_requests_id_resend
ParameterTypeRequiredDescription
No parameters.
get_sign_request_by_id Read

Execute official Box API operation `get_sign_requests_id`. Endpoint: GET /sign_requests/{sign_request_id}.

Lua path
app.integrations.box.get_sign_request_by_id
Full name
box.box_get_sign_requests_id
ParameterTypeRequiredDescription
No parameters.
list_sign_requests Read

Execute official Box API operation `get_sign_requests`. Endpoint: GET /sign_requests.

Lua path
app.integrations.box.list_sign_requests
Full name
box.box_get_sign_requests
ParameterTypeRequiredDescription
No parameters.
create_sign_request Write

Execute official Box API operation `post_sign_requests`. Endpoint: POST /sign_requests.

Lua path
app.integrations.box.create_sign_request
Full name
box.box_post_sign_requests
ParameterTypeRequiredDescription
No parameters.
list_workflows Read

Execute official Box API operation `get_workflows`. Endpoint: GET /workflows.

Lua path
app.integrations.box.list_workflows
Full name
box.box_get_workflows
ParameterTypeRequiredDescription
No parameters.
starts_workflow_based_request_body Write

Execute official Box API operation `post_workflows_id_start`. Endpoint: POST /workflows/{workflow_id}/start.

Lua path
app.integrations.box.starts_workflow_based_request_body
Full name
box.box_post_workflows_id_start
ParameterTypeRequiredDescription
No parameters.
list_sign_templates Read

Execute official Box API operation `get_sign_templates`. Endpoint: GET /sign_templates.

Lua path
app.integrations.box.list_sign_templates
Full name
box.box_get_sign_templates
ParameterTypeRequiredDescription
No parameters.
get_sign_template_by_id Read

Execute official Box API operation `get_sign_templates_id`. Endpoint: GET /sign_templates/{template_id}.

Lua path
app.integrations.box.get_sign_template_by_id
Full name
box.box_get_sign_templates_id
ParameterTypeRequiredDescription
No parameters.
list_slack_integration_mappings Read

Execute official Box API operation `get_integration_mappings_slack`. Endpoint: GET /integration_mappings/slack.

Lua path
app.integrations.box.list_slack_integration_mappings
Full name
box.box_get_integration_mappings_slack
ParameterTypeRequiredDescription
No parameters.
create_slack_integration_mapping Write

Execute official Box API operation `post_integration_mappings_slack`. Endpoint: POST /integration_mappings/slack.

Lua path
app.integrations.box.create_slack_integration_mapping
Full name
box.box_post_integration_mappings_slack
ParameterTypeRequiredDescription
No parameters.
update_slack_integration_mapping Write

Execute official Box API operation `put_integration_mappings_slack_id`. Endpoint: PUT /integration_mappings/slack/{integration_mapping_id}.

Lua path
app.integrations.box.update_slack_integration_mapping
Full name
box.box_put_integration_mappings_slack_id
ParameterTypeRequiredDescription
No parameters.
delete_slack_integration_mapping Write

Execute official Box API operation `delete_integration_mappings_slack_id`. Endpoint: DELETE /integration_mappings/slack/{integration_mapping_id}.

Lua path
app.integrations.box.delete_slack_integration_mapping
Full name
box.box_delete_integration_mappings_slack_id
ParameterTypeRequiredDescription
No parameters.
list_teams_integration_mappings Read

Execute official Box API operation `get_integration_mappings_teams`. Endpoint: GET /integration_mappings/teams.

Lua path
app.integrations.box.list_teams_integration_mappings
Full name
box.box_get_integration_mappings_teams
ParameterTypeRequiredDescription
No parameters.
create_teams_integration_mapping Write

Execute official Box API operation `post_integration_mappings_teams`. Endpoint: POST /integration_mappings/teams.

Lua path
app.integrations.box.create_teams_integration_mapping
Full name
box.box_post_integration_mappings_teams
ParameterTypeRequiredDescription
No parameters.
update_teams_integration_mapping Write

Execute official Box API operation `put_integration_mappings_teams_id`. Endpoint: PUT /integration_mappings/teams/{integration_mapping_id}.

Lua path
app.integrations.box.update_teams_integration_mapping
Full name
box.box_put_integration_mappings_teams_id
ParameterTypeRequiredDescription
No parameters.
delete_teams_integration_mapping Write

Execute official Box API operation `delete_integration_mappings_teams_id`. Endpoint: DELETE /integration_mappings/teams/{integration_mapping_id}.

Lua path
app.integrations.box.delete_teams_integration_mapping
Full name
box.box_delete_integration_mappings_teams_id
ParameterTypeRequiredDescription
No parameters.
ask_question Write

Execute official Box API operation `post_ai_ask`. Endpoint: POST /ai/ask.

Lua path
app.integrations.box.ask_question
Full name
box.box_post_ai_ask
ParameterTypeRequiredDescription
No parameters.
generate_text Write

Execute official Box API operation `post_ai_text_gen`. Endpoint: POST /ai/text_gen.

Lua path
app.integrations.box.generate_text
Full name
box.box_post_ai_text_gen
ParameterTypeRequiredDescription
No parameters.
get_ai_agent_default_configuration Read

Execute official Box API operation `get_ai_agent_default`. Endpoint: GET /ai_agent_default.

Lua path
app.integrations.box.get_ai_agent_default_configuration
Full name
box.box_get_ai_agent_default
ParameterTypeRequiredDescription
No parameters.
extract_metadata_freeform Write

Execute official Box API operation `post_ai_extract`. Endpoint: POST /ai/extract.

Lua path
app.integrations.box.extract_metadata_freeform
Full name
box.box_post_ai_extract
ParameterTypeRequiredDescription
No parameters.
extract_metadata_structured Write

Execute official Box API operation `post_ai_extract_structured`. Endpoint: POST /ai/extract_structured.

Lua path
app.integrations.box.extract_metadata_structured
Full name
box.box_post_ai_extract_structured
ParameterTypeRequiredDescription
No parameters.
list_ai_agents Read

Execute official Box API operation `get_ai_agents`. Endpoint: GET /ai_agents.

Lua path
app.integrations.box.list_ai_agents
Full name
box.box_get_ai_agents
ParameterTypeRequiredDescription
No parameters.
create_ai_agent Write

Execute official Box API operation `post_ai_agents`. Endpoint: POST /ai_agents.

Lua path
app.integrations.box.create_ai_agent
Full name
box.box_post_ai_agents
ParameterTypeRequiredDescription
No parameters.
update_ai_agent Write

Execute official Box API operation `put_ai_agents_id`. Endpoint: PUT /ai_agents/{agent_id}.

Lua path
app.integrations.box.update_ai_agent
Full name
box.box_put_ai_agents_id
ParameterTypeRequiredDescription
No parameters.
get_ai_agent_by_agent_id Read

Execute official Box API operation `get_ai_agents_id`. Endpoint: GET /ai_agents/{agent_id}.

Lua path
app.integrations.box.get_ai_agent_by_agent_id
Full name
box.box_get_ai_agents_id
ParameterTypeRequiredDescription
No parameters.
delete_ai_agent Write

Execute official Box API operation `delete_ai_agents_id`. Endpoint: DELETE /ai_agents/{agent_id}.

Lua path
app.integrations.box.delete_ai_agent
Full name
box.box_delete_ai_agents_id
ParameterTypeRequiredDescription
No parameters.
create_metadata_taxonomy Write

Execute official Box API operation `post_metadata_taxonomies`. Endpoint: POST /metadata_taxonomies.

Lua path
app.integrations.box.create_metadata_taxonomy
Full name
box.box_post_metadata_taxonomies
ParameterTypeRequiredDescription
No parameters.
get_metadata_taxonomies_namespace Read

Execute official Box API operation `get_metadata_taxonomies_id`. Endpoint: GET /metadata_taxonomies/{namespace}.

Lua path
app.integrations.box.get_metadata_taxonomies_namespace
Full name
box.box_get_metadata_taxonomies_id
ParameterTypeRequiredDescription
No parameters.
get_metadata_taxonomy_by_taxonomy_key Read

Execute official Box API operation `get_metadata_taxonomies_id_id`. Endpoint: GET /metadata_taxonomies/{namespace}/{taxonomy_key}.

Lua path
app.integrations.box.get_metadata_taxonomy_by_taxonomy_key
Full name
box.box_get_metadata_taxonomies_id_id
ParameterTypeRequiredDescription
No parameters.
update_metadata_taxonomy Write

Execute official Box API operation `patch_metadata_taxonomies_id_id`. Endpoint: PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}.

Lua path
app.integrations.box.update_metadata_taxonomy
Full name
box.box_patch_metadata_taxonomies_id_id
ParameterTypeRequiredDescription
No parameters.
remove_metadata_taxonomy Write

Execute official Box API operation `delete_metadata_taxonomies_id_id`. Endpoint: DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}.

Lua path
app.integrations.box.remove_metadata_taxonomy
Full name
box.box_delete_metadata_taxonomies_id_id
ParameterTypeRequiredDescription
No parameters.
create_metadata_taxonomy_levels Write

Execute official Box API operation `post_metadata_taxonomies_id_id_levels`. Endpoint: POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels.

Lua path
app.integrations.box.create_metadata_taxonomy_levels
Full name
box.box_post_metadata_taxonomies_id_id_levels
ParameterTypeRequiredDescription
No parameters.
update_metadata_taxonomy_level Write

Execute official Box API operation `patch_metadata_taxonomies_id_id_levels_id`. Endpoint: PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/levels/{level_index}.

Lua path
app.integrations.box.update_metadata_taxonomy_level
Full name
box.box_patch_metadata_taxonomies_id_id_levels_id
ParameterTypeRequiredDescription
No parameters.
add_metadata_taxonomy_level Write

Execute official Box API operation `post_metadata_taxonomies_id_id_levels:append`. Endpoint: POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:append.

Lua path
app.integrations.box.add_metadata_taxonomy_level
Full name
box.box_post_metadata_taxonomies_id_id_levels_append
ParameterTypeRequiredDescription
No parameters.
delete_metadata_taxonomy_level Write

Execute official Box API operation `post_metadata_taxonomies_id_id_levels:trim`. Endpoint: POST /metadata_taxonomies/{namespace}/{taxonomy_key}/levels:trim.

Lua path
app.integrations.box.delete_metadata_taxonomy_level
Full name
box.box_post_metadata_taxonomies_id_id_levels_trim
ParameterTypeRequiredDescription
No parameters.
list_metadata_taxonomy_nodes Read

Execute official Box API operation `get_metadata_taxonomies_id_id_nodes`. Endpoint: GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes.

Lua path
app.integrations.box.list_metadata_taxonomy_nodes
Full name
box.box_get_metadata_taxonomies_id_id_nodes
ParameterTypeRequiredDescription
No parameters.
create_metadata_taxonomy_node Write

Execute official Box API operation `post_metadata_taxonomies_id_id_nodes`. Endpoint: POST /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes.

Lua path
app.integrations.box.create_metadata_taxonomy_node
Full name
box.box_post_metadata_taxonomies_id_id_nodes
ParameterTypeRequiredDescription
No parameters.
get_metadata_taxonomy_node_by_id Read

Execute official Box API operation `get_metadata_taxonomies_id_id_nodes_id`. Endpoint: GET /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}.

Lua path
app.integrations.box.get_metadata_taxonomy_node_by_id
Full name
box.box_get_metadata_taxonomies_id_id_nodes_id
ParameterTypeRequiredDescription
No parameters.
update_metadata_taxonomy_node Write

Execute official Box API operation `patch_metadata_taxonomies_id_id_nodes_id`. Endpoint: PATCH /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}.

Lua path
app.integrations.box.update_metadata_taxonomy_node
Full name
box.box_patch_metadata_taxonomies_id_id_nodes_id
ParameterTypeRequiredDescription
No parameters.
remove_metadata_taxonomy_node Write

Execute official Box API operation `delete_metadata_taxonomies_id_id_nodes_id`. Endpoint: DELETE /metadata_taxonomies/{namespace}/{taxonomy_key}/nodes/{node_id}.

Lua path
app.integrations.box.remove_metadata_taxonomy_node
Full name
box.box_delete_metadata_taxonomies_id_id_nodes_id
ParameterTypeRequiredDescription
No parameters.
list_metadata_template_options_taxonomy_field Read

Execute official Box API operation `get_metadata_templates_id_id_fields_id_options`. Endpoint: GET /metadata_templates/{namespace}/{template_key}/fields/{field_key}/options.

Lua path
app.integrations.box.list_metadata_template_options_taxonomy_field
Full name
box.box_get_metadata_templates_id_id_fields_id_options
ParameterTypeRequiredDescription
No parameters.