{ "openapi": "3.0.2", "info": { "title": "Box Platform API", "description": "[Box Platform](https://developer.box.com) provides functionality to provide access to content stored within [Box](https://box.com). It provides endpoints for basic manipulation of files and folders, management of users within an enterprise, as well as more complex topics such as legal holds and retention policies.", "termsOfService": "https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9", "contact": { "name": "Box, Inc", "url": "https://developer.box.com", "email": "devrel@box.com" }, "license": { "name": "Apache-2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" }, "version": "2025.0", "x-box-commit-hash": "21e370b9bd" }, "servers": [ { "url": "https://api.box.com/2.0", "description": "Box Platform API server." } ], "paths": { "/docgen_templates": { "post": { "operationId": "post_docgen_templates_v2025.0", "summary": "Create Box Doc Gen template", "description": "Marks a file as a Box Doc Gen template.", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "description": "Marks the provided file as a Box Doc Gen template.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenTemplateCreateRequest" } } } }, "responses": { "201": { "description": "The file which has now been marked as a Box Doc Gen template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenTemplate--Base" } } } }, "400": { "description": "The server cannot or will not process the request due to an apparent client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "The client does not have access rights to the content or resource requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "The user has sent too many requests in a given amount of time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected condition was encountered on the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "docgen_template", "tags": [ "Box Doc Gen templates" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Create Box Doc Gen template", "source": "curl -L 'https://api.box.com/2.0/docgen_templates' \\\n -H 'box-version: 2025.0' \\\n -H 'Authorization: Bearer ' \\\n -H 'Content-Type: application/json' \\\n -D '{\n \"file\": {\n \"id\": \"12345678\",\n \"type\": \"file\"\n }\n}'" }, { "lang": "dotnet", "label": "Create Box Doc Gen template", "source": "await client.DocgenTemplate.CreateDocgenTemplateV2025R0Async(requestBody: new DocGenTemplateCreateRequestV2025R0(file: new FileReferenceV2025R0(id: file.Id)));" }, { "lang": "swift", "label": "Create Box Doc Gen template", "source": "try await client.docgenTemplate.createDocgenTemplateV2025R0(requestBody: DocGenTemplateCreateRequestV2025R0(file: FileReferenceV2025R0(id: file.id)))" }, { "lang": "java", "label": "Create Box Doc Gen template", "source": "client.getDocgenTemplate().createDocgenTemplateV2025R0(new DocGenTemplateCreateRequestV2025R0(new FileReferenceV2025R0(file.getId())))" }, { "lang": "node", "label": "Create Box Doc Gen template", "source": "await client.docgenTemplate.createDocgenTemplateV2025R0({\n file: new FileReferenceV2025R0({ id: file.id }),\n} satisfies DocGenTemplateCreateRequestV2025R0);" }, { "lang": "python", "label": "Create Box Doc Gen template", "source": "client.docgen_template.create_docgen_template_v2025_r0(FileReferenceV2025R0(id=file.id))" } ] }, "get": { "operationId": "get_docgen_templates_v2025.0", "summary": "List Box Doc Gen templates", "description": "Lists Box Doc Gen templates on which the user is a collaborator.", "parameters": [ { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns a collection of templates.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenTemplates" } } } }, "400": { "description": "Returned if the user has passed in a malformed marker or limit value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "docgen_template", "tags": [ "Box Doc Gen templates" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "List Box Doc Gen templates", "source": "curl -L 'https://api.box.com/2.0/docgen_templates' \\\n -H 'box-version: 2025.0' \\\n -H 'Authorization: Bearer '" }, { "lang": "dotnet", "label": "List Box Doc Gen templates", "source": "await client.DocgenTemplate.GetDocgenTemplatesV2025R0Async();" }, { "lang": "swift", "label": "List Box Doc Gen templates", "source": "try await client.docgenTemplate.getDocgenTemplatesV2025R0()" }, { "lang": "java", "label": "List Box Doc Gen templates", "source": "client.getDocgenTemplate().getDocgenTemplatesV2025R0()" }, { "lang": "node", "label": "List Box Doc Gen templates", "source": "await client.docgenTemplate.getDocgenTemplatesV2025R0();" }, { "lang": "python", "label": "List Box Doc Gen templates", "source": "client.docgen_template.get_docgen_templates_v2025_r0()" } ] } }, "/docgen_templates/{template_id}": { "delete": { "operationId": "delete_docgen_templates_id_v2025.0", "summary": "Delete Box Doc Gen template", "description": "Unmarks file as Box Doc Gen template.", "parameters": [ { "name": "template_id", "in": "path", "description": "ID of the file which will no longer be marked as a Box Doc Gen template.", "required": true, "schema": { "type": "string" }, "example": "123" }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "204": { "description": "Returns an empty response when a file is no longer marked as a Box Doc Gen template." }, "400": { "description": "The server cannot or will not process the request due to an apparent client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "The client does not have access rights to the content or resource requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the template is not found or the user does not have access to the associated template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "The user has sent too many requests in a given amount of time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected condition was encountered on the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "docgen_template", "tags": [ "Box Doc Gen templates" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Delete Box Doc Gen template", "source": "curl -L -X DELETE 'https://api.box.com/2.0/docgen_templates/12345678' \\\n -H 'box-version: 2025.0' \\\n -H 'Authorization: Bearer '" }, { "lang": "dotnet", "label": "Delete Box Doc Gen template", "source": "await client.DocgenTemplate.DeleteDocgenTemplateByIdV2025R0Async(templateId: NullableUtils.Unwrap(createdDocgenTemplate.File).Id);" }, { "lang": "swift", "label": "Delete Box Doc Gen template", "source": "try await client.docgenTemplate.deleteDocgenTemplateByIdV2025R0(templateId: createdDocgenTemplate.file!.id)" }, { "lang": "java", "label": "Delete Box Doc Gen template", "source": "client.getDocgenTemplate().deleteDocgenTemplateByIdV2025R0(createdDocgenTemplate.getFile().getId())" }, { "lang": "node", "label": "Delete Box Doc Gen template", "source": "await client.docgenTemplate.deleteDocgenTemplateByIdV2025R0(\n createdDocgenTemplate.file!.id,\n);" }, { "lang": "python", "label": "Delete Box Doc Gen template", "source": "client.docgen_template.delete_docgen_template_by_id_v2025_r0(\n created_docgen_template.file.id\n)" } ] }, "get": { "operationId": "get_docgen_templates_id_v2025.0", "summary": "Get Box Doc Gen template by ID", "description": "Lists details of a specific Box Doc Gen template.", "parameters": [ { "name": "template_id", "in": "path", "description": "The ID of a Box Doc Gen template.", "required": true, "schema": { "type": "string" }, "example": 123 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns a template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenTemplate" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the template is not found or the user does not have access to the associated template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "docgen_template", "tags": [ "Box Doc Gen templates" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Get Box Doc Gen template by ID", "source": "curl -L 'https://api.box.com/2.0/docgen_templates/12345678' \\\n -H 'box-version: 2025.0' \\\n -H 'Authorization: Bearer '" }, { "lang": "dotnet", "label": "Get Box Doc Gen template by ID", "source": "await client.DocgenTemplate.GetDocgenTemplateByIdV2025R0Async(templateId: NullableUtils.Unwrap(createdDocgenTemplate.File).Id);" }, { "lang": "swift", "label": "Get Box Doc Gen template by ID", "source": "try await client.docgenTemplate.getDocgenTemplateByIdV2025R0(templateId: createdDocgenTemplate.file!.id)" }, { "lang": "java", "label": "Get Box Doc Gen template by ID", "source": "client.getDocgenTemplate().getDocgenTemplateByIdV2025R0(createdDocgenTemplate.getFile().getId())" }, { "lang": "node", "label": "Get Box Doc Gen template by ID", "source": "await client.docgenTemplate.getDocgenTemplateByIdV2025R0(\n createdDocgenTemplate.file!.id,\n);" }, { "lang": "python", "label": "Get Box Doc Gen template by ID", "source": "client.docgen_template.get_docgen_template_by_id_v2025_r0(\n created_docgen_template.file.id\n)" } ] } }, "/docgen_templates/{template_id}/tags": { "get": { "operationId": "get_docgen_templates_id_tags_v2025.0", "summary": "List all Box Doc Gen template tags in template", "description": "Lists all tags in a Box Doc Gen template.", "parameters": [ { "name": "template_id", "in": "path", "description": "ID of template.", "required": true, "schema": { "type": "string" }, "example": 123 }, { "name": "template_version_id", "in": "query", "description": "Id of template version.", "required": false, "schema": { "type": "string" }, "example": 123 }, { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "A list of document generation template tags.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenTags" } } } }, "202": { "description": "Processing tags for the file.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenTagsProcessingMessage" } } } }, "400": { "description": "Returned if the user has passed in a malformed marker or limit value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "The client does not have access rights to the content or resource requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "The requested resource could not be found but may be available in the future.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "The user has sent too many requests in a given amount of time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected condition was encountered on the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "docgen_template", "tags": [ "Box Doc Gen templates" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "List all Box Doc Gen template tags in template", "source": "curl -L 'https://api.box.com/2.0/docgen_templates/12345678/tags' \\\n -H 'box-version: 2025.0' \\\n -H 'Authorization: Bearer '" }, { "lang": "dotnet", "label": "List all Box Doc Gen template tags in template", "source": "await client.DocgenTemplate.GetDocgenTemplateTagsV2025R0Async(templateId: NullableUtils.Unwrap(fetchedDocgenTemplate.File).Id);" }, { "lang": "swift", "label": "List all Box Doc Gen template tags in template", "source": "try await client.docgenTemplate.getDocgenTemplateTagsV2025R0(templateId: fetchedDocgenTemplate.file!.id)" }, { "lang": "java", "label": "List all Box Doc Gen template tags in template", "source": "client.getDocgenTemplate().getDocgenTemplateTagsV2025R0(fetchedDocgenTemplate.getFile().getId())" }, { "lang": "node", "label": "List all Box Doc Gen template tags in template", "source": "await client.docgenTemplate.getDocgenTemplateTagsV2025R0(\n fetchedDocgenTemplate.file!.id,\n);" }, { "lang": "python", "label": "List all Box Doc Gen template tags in template", "source": "client.docgen_template.get_docgen_template_tags_v2025_r0(\n fetched_docgen_template.file.id\n)" } ] } }, "/docgen_jobs/{job_id}": { "get": { "operationId": "get_docgen_jobs_id_v2025.0", "summary": "Get Box Doc Gen job by ID", "description": "Get details of the Box Doc Gen job.", "parameters": [ { "name": "job_id", "in": "path", "description": "Box Doc Gen job ID.", "required": true, "schema": { "type": "string" }, "example": 123 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Details of the Box Doc Gen job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenJob" } } } }, "403": { "description": "The client does not have access rights to the content or resource requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the job is not found or the user does not have access to the associated job.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "The user has sent too many requests in a given amount of time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected condition was encountered on the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "docgen", "tags": [ "Box Doc Gen" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Get Box Doc Gen job by ID", "source": "curl -i -X GET \"https://api.box.com/2.0/docgen_jobs/12345\" \\\n -H 'box-version: 2025.0' \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Get Box Doc Gen job by ID", "source": "await client.Docgen.GetDocgenJobByIdV2025R0Async(jobId: docgenJobItemFromList.Id);" }, { "lang": "swift", "label": "Get Box Doc Gen job by ID", "source": "try await client.docgen.getDocgenJobByIdV2025R0(jobId: docgenJobItemFromList.id)" }, { "lang": "java", "label": "Get Box Doc Gen job by ID", "source": "client.getDocgen().getDocgenJobByIdV2025R0(docgenJobItemFromList.getId())" }, { "lang": "node", "label": "Get Box Doc Gen job by ID", "source": "await client.docgen.getDocgenJobByIdV2025R0(docgenJobItemFromList.id);" }, { "lang": "python", "label": "Get Box Doc Gen job by ID", "source": "client.docgen.get_docgen_job_by_id_v2025_r0(docgen_job_item_from_list.id)" } ] } }, "/docgen_jobs": { "get": { "operationId": "get_docgen_jobs_v2025.0", "summary": "List all Box Doc Gen jobs", "description": "Lists all Box Doc Gen jobs for a user.", "parameters": [ { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "A list of Box Doc Gen jobs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenJobs--Full" } } } }, "400": { "description": "Returned if the user has passed in a malformed marker or limit value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "The client does not have access rights to the content or resource requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "The user has sent too many requests in a given amount of time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected condition was encountered on the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "docgen", "tags": [ "Box Doc Gen" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "List all Box Doc Gen jobs", "source": "curl -i -X GET \"https://api.box.com/2.0/docgen_jobs\" \\\n -H 'box-version: 2025.0' \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "List all Box Doc Gen jobs", "source": "await client.Docgen.GetDocgenJobsV2025R0Async(queryParams: new GetDocgenJobsV2025R0QueryParams() { Limit = 10000L });" }, { "lang": "swift", "label": "List all Box Doc Gen jobs", "source": "try await client.docgen.getDocgenJobsV2025R0(queryParams: GetDocgenJobsV2025R0QueryParams(limit: Int64(10000)))" }, { "lang": "java", "label": "List all Box Doc Gen jobs", "source": "client.getDocgen().getDocgenJobsV2025R0(new GetDocgenJobsV2025R0QueryParams.Builder().limit(10000L).build())" }, { "lang": "node", "label": "List all Box Doc Gen jobs", "source": "await client.docgen.getDocgenJobsV2025R0({\n limit: 10000,\n} satisfies GetDocgenJobsV2025R0QueryParams);" }, { "lang": "python", "label": "List all Box Doc Gen jobs", "source": "client.docgen.get_docgen_jobs_v2025_r0(limit=10000)" } ] } }, "/docgen_template_jobs/{template_id}": { "get": { "operationId": "get_docgen_template_jobs_id_v2025.0", "summary": "Get list of all Box Doc Gen jobs for template", "description": "Lists the users jobs which use this template.", "parameters": [ { "name": "template_id", "in": "path", "description": "Id of template to fetch jobs for.", "required": true, "schema": { "type": "string" }, "example": 123 }, { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "A single Box Doc Gen template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenJobs" } } } }, "400": { "description": "Returned if the user has passed in a malformed marker or limit value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "The client does not have access rights to the content or resource requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the template is not found or the user does not have access to the associated template.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "The user has sent too many requests in a given amount of time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected condition was encountered on the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "docgen_template", "tags": [ "Box Doc Gen templates" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Get list of all Box Doc Gen jobs for template", "source": "curl -L 'https://api.box.com/2.0/docgen_template_jobs/12345678' \\\n -H 'box-version: 2025.0' \\\n -H 'Authorization: Bearer '" }, { "lang": "dotnet", "label": "Get list of all Box Doc Gen jobs for template", "source": "await client.DocgenTemplate.GetDocgenTemplateJobByIdV2025R0Async(templateId: NullableUtils.Unwrap(fetchedDocgenTemplate.File).Id);" }, { "lang": "swift", "label": "Get list of all Box Doc Gen jobs for template", "source": "try await client.docgenTemplate.getDocgenTemplateJobByIdV2025R0(templateId: fetchedDocgenTemplate.file!.id)" }, { "lang": "java", "label": "Get list of all Box Doc Gen jobs for template", "source": "client.getDocgenTemplate().getDocgenTemplateJobByIdV2025R0(fetchedDocgenTemplate.getFile().getId())" }, { "lang": "node", "label": "Get list of all Box Doc Gen jobs for template", "source": "await client.docgenTemplate.getDocgenTemplateJobByIdV2025R0(\n fetchedDocgenTemplate.file!.id,\n);" }, { "lang": "python", "label": "Get list of all Box Doc Gen jobs for template", "source": "client.docgen_template.get_docgen_template_job_by_id_v2025_r0(\n fetched_docgen_template.file.id\n)" } ] } }, "/docgen_batch_jobs/{batch_id}": { "get": { "operationId": "get_docgen_batch_jobs_id_v2025.0", "summary": "Get Box Doc Gen jobs by batch ID", "description": "Lists Box Doc Gen jobs in a batch.", "parameters": [ { "name": "batch_id", "in": "path", "description": "Box Doc Gen batch ID.", "required": true, "schema": { "type": "string" }, "example": 123 }, { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns a list of Box Doc Gen jobs in a Box Doc Gen batch.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenJobs" } } } }, "400": { "description": "Returned if the user has passed in a malformed marker or limit value.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "The client does not have access rights to the content or resource requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the batch is not found or the user does not have access to the associated batch.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "The user has sent too many requests in a given amount of time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected condition was encountered on the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "docgen", "tags": [ "Box Doc Gen" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Get Box Doc Gen jobs by batch ID", "source": "curl -i -X GET \"https://api.box.com/2.0/docgen_batch_jobs/12345\" \\\n -H 'box-version: 2025.0' \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Get Box Doc Gen jobs by batch ID", "source": "await client.Docgen.GetDocgenBatchJobByIdV2025R0Async(batchId: docgenBatch.Id);" }, { "lang": "swift", "label": "Get Box Doc Gen jobs by batch ID", "source": "try await client.docgen.getDocgenBatchJobByIdV2025R0(batchId: docgenBatch.id)" }, { "lang": "java", "label": "Get Box Doc Gen jobs by batch ID", "source": "client.getDocgen().getDocgenBatchJobByIdV2025R0(docgenBatch.getId())" }, { "lang": "node", "label": "Get Box Doc Gen jobs by batch ID", "source": "await client.docgen.getDocgenBatchJobByIdV2025R0(docgenBatch.id);" }, { "lang": "python", "label": "Get Box Doc Gen jobs by batch ID", "source": "client.docgen.get_docgen_batch_job_by_id_v2025_r0(docgen_batch.id)" } ] } }, "/docgen_batches": { "post": { "operationId": "post_docgen_batches_v2025.0", "summary": "Generate document using Box Doc Gen template", "description": "Generates a document using a Box Doc Gen template.", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenBatchCreateRequest" } } } }, "responses": { "202": { "description": "The created Batch ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocGenBatch--Base" } } } }, "403": { "description": "The client does not have access rights to the content or resource requested.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "413": { "description": "The request payload exceeds the maximum allowed size.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "429": { "description": "The user has sent too many requests in a given amount of time.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected condition was encountered on the server.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "docgen", "tags": [ "Box Doc Gen" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Generate document using Box Doc Gen template", "source": "curl -L 'https://api.box.com/2.0/docgen_batches' \\\n -H 'box-version: 2025.0' \\\n -H 'Authorization: Bearer ' \\\n -D '{\n \"file\": {\n \"id\": \"12345678\",\n \"type\": \"file\"\n },\n \"input_source\": \"api\",\n \"destination_folder\": {\n \"id\": \"12345678\",\n \"type\": \"folder\"\n },\n \"output_type\": \"docx\",\n \"document_generation_data\": [\n {\n \"generated_file_name\": \"Image test\",\n \"user_input\": {\n \"order\": {\n \"id\": \"12305\",\n \"date\": \"18-08-2023\",\n \"country\": \"US\",\n \"expiryDate\": \"18-08-2024\",\n \"currency\": \"$\",\n \"amount\": 5060.5,\n \"taxRate\": 10,\n \"requester\": \"John\",\n \"approver\": \"Smith\",\n \"department\": \"Procurement\",\n \"paymentTerms\": \"30 days\",\n \"deliveryTerms\": \"30 days\",\n \"deliveryDate\": \"18-09-2023\",\n \"vendor\": {\n \"company\": \"Example company\",\n \"address\": {\n \"street\": \"Example street\",\n \"city\": \"Example city\",\n \"zip\": \"EX-456\"\n }\n },\n \"products\": [\n {\n \"id\": 1,\n \"name\": \"A4 Papers\",\n \"type\": \"non-fragile\",\n \"quantity\": 100,\n \"price\": 29,\n \"amount\": 2900\n },\n {\n \"id\": 2,\n \"name\": \"Ink Cartridge\",\n \"type\": \"non-fragile\",\n \"quantity\": 40,\n \"price\": 39,\n \"amount\": 1560\n },\n {\n \"id\": 3,\n \"name\": \"Adhesive tape\",\n \"type\": \"non-fragile\",\n \"quantity\": 20,\n \"price\": 30,\n \"amount\": 600.5\n }\n ]\n }\n }\n }\n ]`" }, { "lang": "dotnet", "label": "Generate document using Box Doc Gen template", "source": "await client.Docgen.CreateDocgenBatchV2025R0Async(requestBody: new DocGenBatchCreateRequestV2025R0(file: new FileReferenceV2025R0(id: uploadedFileDocx.Id), inputSource: \"api\", destinationFolder: new DocGenBatchCreateRequestV2025R0DestinationFolderField(id: folder.Id), outputType: \"pdf\", documentGenerationData: Array.AsReadOnly(new [] {new DocGenDocumentGenerationDataV2025R0(generatedFileName: \"test\", userInput: new Dictionary() { { \"abc\", \"xyz\" } })})));" }, { "lang": "swift", "label": "Generate document using Box Doc Gen template", "source": "try await client.docgen.createDocgenBatchV2025R0(requestBody: DocGenBatchCreateRequestV2025R0(file: FileReferenceV2025R0(id: uploadedFileDocx.id), inputSource: \"api\", destinationFolder: DocGenBatchCreateRequestV2025R0DestinationFolderField(id: folder.id), outputType: \"pdf\", documentGenerationData: [DocGenDocumentGenerationDataV2025R0(generatedFileName: \"test\", userInput: [\"abc\": \"xyz\"])]))" }, { "lang": "java", "label": "Generate document using Box Doc Gen template", "source": "client.getDocgen().createDocgenBatchV2025R0(new DocGenBatchCreateRequestV2025R0(new FileReferenceV2025R0(uploadedFileDocx.getId()), \"api\", new DocGenBatchCreateRequestV2025R0DestinationFolderField(folder.getId()), \"pdf\", Arrays.asList(new DocGenDocumentGenerationDataV2025R0(\"test\", mapOf(entryOf(\"abc\", \"xyz\"))))))" }, { "lang": "node", "label": "Generate document using Box Doc Gen template", "source": "await client.docgen.createDocgenBatchV2025R0({\n file: new FileReferenceV2025R0({ id: uploadedFileDocx.id }),\n inputSource: 'api',\n destinationFolder: new DocGenBatchCreateRequestV2025R0DestinationFolderField({\n id: folder.id,\n }),\n outputType: 'pdf',\n documentGenerationData: [\n {\n generatedFileName: 'test',\n userInput: { ['abc']: 'xyz' },\n } satisfies DocGenDocumentGenerationDataV2025R0,\n ],\n} satisfies DocGenBatchCreateRequestV2025R0);" }, { "lang": "python", "label": "Generate document using Box Doc Gen template", "source": "client.docgen.create_docgen_batch_v2025_r0(\n FileReferenceV2025R0(id=uploaded_file_docx.id),\n \"api\",\n CreateDocgenBatchV2025R0DestinationFolder(id=folder.id),\n \"pdf\",\n [\n DocGenDocumentGenerationDataV2025R0(\n generated_file_name=\"test\", user_input={\"abc\": \"xyz\"}\n )\n ],\n)" } ] } }, "/enterprise_configurations/{enterprise_id}": { "get": { "operationId": "get_enterprise_configurations_id_v2025.0", "summary": "Get enterprise configuration", "description": "Retrieves the configuration for an enterprise.", "parameters": [ { "name": "enterprise_id", "in": "path", "description": "The ID of the enterprise.", "required": true, "schema": { "type": "string" }, "example": "3442311" }, { "name": "categories", "in": "query", "description": "A comma-separated list of the enterprise configuration categories. Allowed values: `security`, `content_and_sharing`, `user_settings`, `shield`.", "required": true, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "security", "content_and_sharing", "user_settings", "shield" ], "explode": false }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns the enterprise configuration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnterpriseConfiguration" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "enterprise_configurations", "x-codeSamples": [ { "lang": "curl", "label": "Get enterprise configuration", "source": "curl -i -X GET \"https://api.box.com/2.0/enterprise_configurations/3442311?categories=security,content_and_sharing\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Get enterprise configuration", "source": "await adminClient.EnterpriseConfigurations.GetEnterpriseConfigurationByIdV2025R0Async(enterpriseId: enterpriseId, queryParams: new GetEnterpriseConfigurationByIdV2025R0QueryParams(categories: Array.AsReadOnly(new [] {\"user_settings\",\"content_and_sharing\",\"security\",\"shield\"})));" }, { "lang": "swift", "label": "Get enterprise configuration", "source": "try await adminClient.enterpriseConfigurations.getEnterpriseConfigurationByIdV2025R0(enterpriseId: enterpriseId, queryParams: GetEnterpriseConfigurationByIdV2025R0QueryParams(categories: [\"user_settings\", \"content_and_sharing\", \"security\", \"shield\"]))" }, { "lang": "java", "label": "Get enterprise configuration", "source": "adminClient.getEnterpriseConfigurations().getEnterpriseConfigurationByIdV2025R0(enterpriseId, new GetEnterpriseConfigurationByIdV2025R0QueryParams(Arrays.asList(\"user_settings\", \"content_and_sharing\", \"security\", \"shield\")))" }, { "lang": "node", "label": "Get enterprise configuration", "source": "await adminClient.enterpriseConfigurations.getEnterpriseConfigurationByIdV2025R0(\n enterpriseId,\n {\n categories: ['user_settings', 'content_and_sharing', 'security', 'shield'],\n } satisfies GetEnterpriseConfigurationByIdV2025R0QueryParams,\n);" }, { "lang": "python", "label": "Get enterprise configuration", "source": "admin_client.enterprise_configurations.get_enterprise_configuration_by_id_v2025_r0(\n enterprise_id, [\"user_settings\", \"content_and_sharing\", \"security\", \"shield\"]\n)" } ] } }, "/hubs": { "get": { "operationId": "get_hubs_v2025.0", "summary": "List all Box Hubs", "description": "Retrieves all Box Hubs for requesting user.", "parameters": [ { "name": "query", "in": "query", "description": "The query string to search for Box Hubs.", "required": false, "schema": { "type": "string" }, "example": "Box" }, { "name": "scope", "in": "query", "description": "The scope of the Box Hubs to retrieve. Possible values include `editable`, `view_only`, and `all`. Default is `all`.", "required": false, "schema": { "type": "string", "default": "all" }, "example": "all" }, { "name": "sort", "in": "query", "description": "The field to sort results by. Possible values include `name`, `updated_at`, `last_accessed_at`, `view_count`, and `relevance`. Default is `relevance`.", "required": false, "schema": { "type": "string", "default": "relevance" }, "example": "name" }, { "name": "direction", "in": "query", "description": "The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] }, "example": "ASC" }, { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns all Box Hubs for the given user or enterprise.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hubs" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hubs", "tags": [ "Box Hubs" ], "x-codeSamples": [ { "lang": "curl", "label": "List all Box Hubs", "source": "curl -i -X GET \"https://api.box.com/2.0/hubs\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "List all Box Hubs", "source": "await client.Hubs.GetHubsV2025R0Async(queryParams: new GetHubsV2025R0QueryParams() { Scope = \"all\", Sort = \"name\", Direction = GetHubsV2025R0QueryParamsDirectionField.Asc });" }, { "lang": "swift", "label": "List all Box Hubs", "source": "try await client.hubs.getHubsV2025R0(queryParams: GetHubsV2025R0QueryParams(scope: \"all\", sort: \"name\", direction: GetHubsV2025R0QueryParamsDirectionField.asc))" }, { "lang": "java", "label": "List all Box Hubs", "source": "client.getHubs().getHubsV2025R0(new GetHubsV2025R0QueryParams.Builder().scope(\"all\").sort(\"name\").direction(GetHubsV2025R0QueryParamsDirectionField.ASC).build())" }, { "lang": "node", "label": "List all Box Hubs", "source": "await client.hubs.getHubsV2025R0({\n scope: 'all',\n sort: 'name',\n direction: 'ASC' as GetHubsV2025R0QueryParamsDirectionField,\n} satisfies GetHubsV2025R0QueryParams);" }, { "lang": "python", "label": "List all Box Hubs", "source": "client.hubs.get_hubs_v2025_r0(\n scope=\"all\", sort=\"name\", direction=GetHubsV2025R0Direction.ASC\n)" } ] }, "post": { "operationId": "post_hubs_v2025.0", "summary": "Create Box Hub", "description": "Creates a new Box Hub.", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubCreateRequest" } } } }, "responses": { "201": { "description": "Returns a new Hub object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hub" } } } }, "400": { "description": "Returned if any of the request parameters are not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "Returns an error when the user does not have the right permissions to create a Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hubs", "tags": [ "Box Hubs" ], "x-codeSamples": [ { "lang": "curl", "label": "Create Box Hub", "source": "curl -i -X POST \"https://api.box.com/2.0/hubs\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"title\": \"Hub Title\",\n \"description\": \"This is a description of the Box Hub.\"\n }'" }, { "lang": "dotnet", "label": "Create Box Hub", "source": "await client.Hubs.CreateHubV2025R0Async(requestBody: new HubCreateRequestV2025R0(title: hubTitle) { Description = hubDescription });" }, { "lang": "swift", "label": "Create Box Hub", "source": "try await client.hubs.createHubV2025R0(requestBody: HubCreateRequestV2025R0(title: hubTitle, description: hubDescription))" }, { "lang": "java", "label": "Create Box Hub", "source": "client.getHubs().createHubV2025R0(new HubCreateRequestV2025R0.Builder(hubTitle).description(hubDescription).build())" }, { "lang": "node", "label": "Create Box Hub", "source": "await client.hubs.createHubV2025R0({\n title: hubTitle,\n description: hubDescription,\n} satisfies HubCreateRequestV2025R0);" }, { "lang": "python", "label": "Create Box Hub", "source": "client.hubs.create_hub_v2025_r0(hub_title, description=hub_description)" } ] } }, "/enterprise_hubs": { "get": { "operationId": "get_enterprise_hubs_v2025.0", "summary": "List all Box Hubs for requesting enterprise", "description": "Retrieves all Box Hubs for a given enterprise.\n\nAdmins or Hub Co-admins of an enterprise with GCM scope can make this call.", "parameters": [ { "name": "query", "in": "query", "description": "The query string to search for Box Hubs.", "required": false, "schema": { "type": "string" }, "example": "Box" }, { "name": "sort", "in": "query", "description": "The field to sort results by. Possible values include `name`, `updated_at`, `last_accessed_at`, `view_count`, and `relevance`. Default is `relevance`.", "required": false, "schema": { "type": "string", "default": "relevance" }, "example": "name" }, { "name": "direction", "in": "query", "description": "The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order.", "required": false, "schema": { "type": "string", "enum": [ "ASC", "DESC" ] }, "example": "ASC" }, { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns all Box Hubs for the given user or enterprise.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hubs" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hubs", "tags": [ "Box Hubs" ], "x-codeSamples": [ { "lang": "curl", "label": "List all Box Hubs for requesting enterprise", "source": "curl -i -X GET \"https://api.box.com/2.0/enterprise_hubs\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "List all Box Hubs for requesting enterprise", "source": "await client.Hubs.GetEnterpriseHubsV2025R0Async(queryParams: new GetEnterpriseHubsV2025R0QueryParams() { Sort = \"name\", Direction = GetEnterpriseHubsV2025R0QueryParamsDirectionField.Asc });" }, { "lang": "swift", "label": "List all Box Hubs for requesting enterprise", "source": "try await client.hubs.getEnterpriseHubsV2025R0(queryParams: GetEnterpriseHubsV2025R0QueryParams(sort: \"name\", direction: GetEnterpriseHubsV2025R0QueryParamsDirectionField.asc))" }, { "lang": "java", "label": "List all Box Hubs for requesting enterprise", "source": "client.getHubs().getEnterpriseHubsV2025R0(new GetEnterpriseHubsV2025R0QueryParams.Builder().sort(\"name\").direction(GetEnterpriseHubsV2025R0QueryParamsDirectionField.ASC).build())" }, { "lang": "node", "label": "List all Box Hubs for requesting enterprise", "source": "await client.hubs.getEnterpriseHubsV2025R0({\n sort: 'name',\n direction: 'ASC' as GetEnterpriseHubsV2025R0QueryParamsDirectionField,\n} satisfies GetEnterpriseHubsV2025R0QueryParams);" }, { "lang": "python", "label": "List all Box Hubs for requesting enterprise", "source": "client.hubs.get_enterprise_hubs_v2025_r0(\n sort=\"name\", direction=GetEnterpriseHubsV2025R0Direction.ASC\n)" } ] } }, "/hubs/{hub_id}": { "get": { "operationId": "get_hubs_id_v2025.0", "summary": "Get Box Hub information by ID", "description": "Retrieves details for a Box Hub by its ID.", "parameters": [ { "name": "hub_id", "in": "path", "description": "The unique identifier that represent a hub.\n\nThe ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns a hub object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hub" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the hub is not found, or the user does not have access to the hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hubs", "tags": [ "Box Hubs" ], "x-codeSamples": [ { "lang": "curl", "label": "Get Box Hub information by ID", "source": "curl -i -X GET \"https://api.box.com/2.0/hubs/12345\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Get Box Hub information by ID", "source": "await client.Hubs.GetHubByIdV2025R0Async(hubId: hubId);" }, { "lang": "swift", "label": "Get Box Hub information by ID", "source": "try await client.hubs.getHubByIdV2025R0(hubId: hubId)" }, { "lang": "java", "label": "Get Box Hub information by ID", "source": "client.getHubs().getHubByIdV2025R0(hubId)" }, { "lang": "node", "label": "Get Box Hub information by ID", "source": "await client.hubs.getHubByIdV2025R0(hubId);" }, { "lang": "python", "label": "Get Box Hub information by ID", "source": "client.hubs.get_hub_by_id_v2025_r0(hub_id)" } ] }, "put": { "operationId": "put_hubs_id_v2025.0", "summary": "Update Box Hub information by ID", "description": "Updates a Box Hub. Can be used to change title, description, or Box Hub settings.", "parameters": [ { "name": "hub_id", "in": "path", "description": "The unique identifier that represent a hub.\n\nThe ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubUpdateRequest" } } } }, "responses": { "200": { "description": "Returns a Hub object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hub" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the Hub is not found, or the user does not have access to the Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hubs", "tags": [ "Box Hubs" ], "x-codeSamples": [ { "lang": "curl", "label": "Update Box Hub information by ID", "source": "curl -i -X PUT \"https://api.box.com/2.0/hubs/12345\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"title\": \"Updated Hub Title\",\n \"description\": \"Updated description of the Box Hub.\"\n }'" }, { "lang": "dotnet", "label": "Update Box Hub information by ID", "source": "await client.Hubs.UpdateHubByIdV2025R0Async(hubId: hubId, requestBody: new HubUpdateRequestV2025R0() { Title = newHubTitle, Description = newHubDescription });" }, { "lang": "swift", "label": "Update Box Hub information by ID", "source": "try await client.hubs.updateHubByIdV2025R0(hubId: hubId, requestBody: HubUpdateRequestV2025R0(title: newHubTitle, description: newHubDescription))" }, { "lang": "java", "label": "Update Box Hub information by ID", "source": "client.getHubs().updateHubByIdV2025R0(hubId, new HubUpdateRequestV2025R0.Builder().title(newHubTitle).description(newHubDescription).build())" }, { "lang": "node", "label": "Update Box Hub information by ID", "source": "await client.hubs.updateHubByIdV2025R0(hubId, {\n title: newHubTitle,\n description: newHubDescription,\n} satisfies HubUpdateRequestV2025R0);" }, { "lang": "python", "label": "Update Box Hub information by ID", "source": "client.hubs.update_hub_by_id_v2025_r0(\n hub_id, title=new_hub_title, description=new_hub_description\n)" } ] }, "delete": { "operationId": "delete_hubs_id_v2025.0", "summary": "Delete Box Hub", "description": "Deletes a single Box Hub.", "parameters": [ { "name": "hub_id", "in": "path", "description": "The unique identifier that represent a hub.\n\nThe ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "204": { "description": "A blank response is returned if the hub was successfully deleted." }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the hub is not found or has already been deleted, or the user does not have access to the hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hubs", "tags": [ "Box Hubs" ], "x-codeSamples": [ { "lang": "curl", "label": "Delete Box Hub", "source": "curl -i -X DELETE \"https://api.box.com/2.0/hubs/12345\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Delete Box Hub", "source": "await client.Hubs.DeleteHubByIdV2025R0Async(hubId: hubId);" }, { "lang": "swift", "label": "Delete Box Hub", "source": "try await client.hubs.deleteHubByIdV2025R0(hubId: hubId)" }, { "lang": "java", "label": "Delete Box Hub", "source": "client.getHubs().deleteHubByIdV2025R0(hubId)" }, { "lang": "node", "label": "Delete Box Hub", "source": "await client.hubs.deleteHubByIdV2025R0(hubId);" }, { "lang": "python", "label": "Delete Box Hub", "source": "client.hubs.delete_hub_by_id_v2025_r0(hub_id)" } ] } }, "/hubs/{hub_id}/copy": { "post": { "operationId": "post_hubs_id_copy_v2025.0", "summary": "Copy Box Hub", "description": "Creates a copy of a Box Hub.\n\nThe original Box Hub will not be modified.", "parameters": [ { "name": "hub_id", "in": "path", "description": "The unique identifier that represent a hub.\n\nThe ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubCopyRequest" } } } }, "responses": { "201": { "description": "Returns a new Hub object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Hub" } } } }, "403": { "description": "Returns an error when the user does not have the right permissions to create a Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hubs", "tags": [ "Box Hubs" ], "x-codeSamples": [ { "lang": "curl", "label": "Copy Box Hub", "source": "curl -i -X POST \"https://api.box.com/2.0/hubs/12345/copy\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"title\": \"Copied Hub Title\",\n \"description\": \"A copy of the original Box Hub.\"\n }'" }, { "lang": "dotnet", "label": "Copy Box Hub", "source": "await client.Hubs.CopyHubV2025R0Async(hubId: createdHub.Id, requestBody: new HubCopyRequestV2025R0() { Title = copiedHubTitle, Description = copiedHubDescription });" }, { "lang": "swift", "label": "Copy Box Hub", "source": "try await client.hubs.copyHubV2025R0(hubId: createdHub.id, requestBody: HubCopyRequestV2025R0(title: copiedHubTitle, description: copiedHubDescription))" }, { "lang": "java", "label": "Copy Box Hub", "source": "client.getHubs().copyHubV2025R0(createdHub.getId(), new HubCopyRequestV2025R0.Builder().title(copiedHubTitle).description(copiedHubDescription).build())" }, { "lang": "node", "label": "Copy Box Hub", "source": "await client.hubs.copyHubV2025R0(createdHub.id, {\n title: copiedHubTitle,\n description: copiedHubDescription,\n} satisfies HubCopyRequestV2025R0);" }, { "lang": "python", "label": "Copy Box Hub", "source": "client.hubs.copy_hub_v2025_r0(\n created_hub.id, title=copied_hub_title, description=copied_hub_description\n)" } ] } }, "/hub_collaborations": { "get": { "operationId": "get_hub_collaborations_v2025.0", "summary": "Get Box Hub collaborations", "description": "Retrieves all collaborations for a Box Hub.", "parameters": [ { "name": "hub_id", "in": "query", "description": "The unique identifier that represent a hub.\n\nThe ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Retrieves the collaborations associated with the specified Box Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubCollaborations" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the Box Hub is not found, or the user does not have access to the Box Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hub_collaborations", "tags": [ "Box Hub Collaborations" ], "x-codeSamples": [ { "lang": "curl", "label": "Get Box Hub collaborations", "source": "curl -i -X GET \"https://api.box.com/2.0/hub_collaborations?hub_id=12345\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Get Box Hub collaborations", "source": "await client.HubCollaborations.GetHubCollaborationsV2025R0Async(queryParams: new GetHubCollaborationsV2025R0QueryParams(hubId: hub.Id));" }, { "lang": "swift", "label": "Get Box Hub collaborations", "source": "try await client.hubCollaborations.getHubCollaborationsV2025R0(queryParams: GetHubCollaborationsV2025R0QueryParams(hubId: hub.id))" }, { "lang": "java", "label": "Get Box Hub collaborations", "source": "client.getHubCollaborations().getHubCollaborationsV2025R0(new GetHubCollaborationsV2025R0QueryParams(hub.getId()))" }, { "lang": "node", "label": "Get Box Hub collaborations", "source": "await client.hubCollaborations.getHubCollaborationsV2025R0({\n hubId: hub.id,\n} satisfies GetHubCollaborationsV2025R0QueryParams);" }, { "lang": "python", "label": "Get Box Hub collaborations", "source": "client.hub_collaborations.get_hub_collaborations_v2025_r0(hub.id)" } ] }, "post": { "operationId": "post_hub_collaborations_v2025.0", "summary": "Create Box Hub collaboration", "description": "Adds a collaboration for a single user or a single group to a Box Hub.\n\nCollaborations can be created using email address, user IDs, or group IDs.", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubCollaborationCreateRequest" } } } }, "responses": { "201": { "description": "Returns a new Box Hub collaboration object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubCollaboration" } } } }, "403": { "description": "Returns an error when the user does not have the right permissions to create the collaboration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hub_collaborations", "tags": [ "Box Hub Collaborations" ], "x-codeSamples": [ { "lang": "curl", "label": "Create Box Hub collaboration", "source": "curl -i -X POST \"https://api.box.com/2.0/hub_collaborations\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"hub\": {\n \"type\": \"hubs\",\n \"id\": \"42037322\"\n },\n \"accessible_by\": {\n \"type\": \"user\",\n \"id\": \"23522323\"\n },\n \"role\": \"viewer\"\n }'" }, { "lang": "dotnet", "label": "Create Box Hub collaboration", "source": "await client.HubCollaborations.CreateHubCollaborationV2025R0Async(requestBody: new HubCollaborationCreateRequestV2025R0(hub: new HubCollaborationCreateRequestV2025R0HubField(id: hub.Id), accessibleBy: new HubCollaborationCreateRequestV2025R0AccessibleByField(type: \"user\") { Id = user.Id }, role: \"viewer\"));" }, { "lang": "swift", "label": "Create Box Hub collaboration", "source": "try await client.hubCollaborations.createHubCollaborationV2025R0(requestBody: HubCollaborationCreateRequestV2025R0(hub: HubCollaborationCreateRequestV2025R0HubField(id: hub.id), accessibleBy: HubCollaborationCreateRequestV2025R0AccessibleByField(type: \"user\", id: user.id), role: \"viewer\"))" }, { "lang": "java", "label": "Create Box Hub collaboration", "source": "client.getHubCollaborations().createHubCollaborationV2025R0(new HubCollaborationCreateRequestV2025R0(new HubCollaborationCreateRequestV2025R0HubField(hub.getId()), new HubCollaborationCreateRequestV2025R0AccessibleByField.Builder(\"user\").id(user.getId()).build(), \"viewer\"))" }, { "lang": "node", "label": "Create Box Hub collaboration", "source": "await client.hubCollaborations.createHubCollaborationV2025R0({\n hub: new HubCollaborationCreateRequestV2025R0HubField({ id: hub.id }),\n accessibleBy: {\n type: 'user',\n id: user.id,\n } satisfies HubCollaborationCreateRequestV2025R0AccessibleByField,\n role: 'viewer',\n} satisfies HubCollaborationCreateRequestV2025R0);" }, { "lang": "python", "label": "Create Box Hub collaboration", "source": "client.hub_collaborations.create_hub_collaboration_v2025_r0(\n CreateHubCollaborationV2025R0Hub(id=hub.id),\n CreateHubCollaborationV2025R0AccessibleBy(type=\"user\", id=user.id),\n \"viewer\",\n)" } ] } }, "/hub_collaborations/{hub_collaboration_id}": { "get": { "operationId": "get_hub_collaborations_id_v2025.0", "summary": "Get Box Hub collaboration by collaboration ID", "description": "Retrieves details for a Box Hub collaboration by collaboration ID.", "parameters": [ { "name": "hub_collaboration_id", "in": "path", "description": "The ID of the hub collaboration.", "required": true, "schema": { "type": "string" }, "example": "1234" }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns a Box Hub collaboration object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubCollaboration" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the Box Hub is not found, or the user does not have access to the Box Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hub_collaborations", "tags": [ "Box Hub Collaborations" ], "x-codeSamples": [ { "lang": "curl", "label": "Get Box Hub collaboration by collaboration ID", "source": "curl -i -X GET \"https://api.box.com/2.0/hub_collaborations/1234\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Get Box Hub collaboration by collaboration ID", "source": "await client.HubCollaborations.GetHubCollaborationByIdV2025R0Async(hubCollaborationId: createdCollaboration.Id);" }, { "lang": "swift", "label": "Get Box Hub collaboration by collaboration ID", "source": "try await client.hubCollaborations.getHubCollaborationByIdV2025R0(hubCollaborationId: createdCollaboration.id)" }, { "lang": "java", "label": "Get Box Hub collaboration by collaboration ID", "source": "client.getHubCollaborations().getHubCollaborationByIdV2025R0(createdCollaboration.getId())" }, { "lang": "node", "label": "Get Box Hub collaboration by collaboration ID", "source": "await client.hubCollaborations.getHubCollaborationByIdV2025R0(\n createdCollaboration.id,\n);" }, { "lang": "python", "label": "Get Box Hub collaboration by collaboration ID", "source": "client.hub_collaborations.get_hub_collaboration_by_id_v2025_r0(created_collaboration.id)" } ] }, "put": { "operationId": "put_hub_collaborations_id_v2025.0", "summary": "Update Box Hub collaboration", "description": "Updates a Box Hub collaboration. Can be used to change the Box Hub role.", "parameters": [ { "name": "hub_collaboration_id", "in": "path", "description": "The ID of the hub collaboration.", "required": true, "schema": { "type": "string" }, "example": "1234" }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubCollaborationUpdateRequest" } } } }, "responses": { "200": { "description": "Returns an updated Box Hub collaboration object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubCollaboration" } } } }, "403": { "description": "Returns an error if the authenticated user does not have the right permissions to update the collaboration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hub_collaborations", "tags": [ "Box Hub Collaborations" ], "x-codeSamples": [ { "lang": "curl", "label": "Update Box Hub collaboration", "source": "curl -i -X PUT \"https://api.box.com/2.0/hub_collaborations/1234\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"role\": \"editor\"\n }'" }, { "lang": "dotnet", "label": "Update Box Hub collaboration", "source": "await client.HubCollaborations.UpdateHubCollaborationByIdV2025R0Async(hubCollaborationId: createdCollaboration.Id, requestBody: new HubCollaborationUpdateRequestV2025R0() { Role = \"editor\" });" }, { "lang": "swift", "label": "Update Box Hub collaboration", "source": "try await client.hubCollaborations.updateHubCollaborationByIdV2025R0(hubCollaborationId: createdCollaboration.id, requestBody: HubCollaborationUpdateRequestV2025R0(role: \"editor\"))" }, { "lang": "java", "label": "Update Box Hub collaboration", "source": "client.getHubCollaborations().updateHubCollaborationByIdV2025R0(createdCollaboration.getId(), new HubCollaborationUpdateRequestV2025R0.Builder().role(\"editor\").build())" }, { "lang": "node", "label": "Update Box Hub collaboration", "source": "await client.hubCollaborations.updateHubCollaborationByIdV2025R0(\n createdCollaboration.id,\n { role: 'editor' } satisfies HubCollaborationUpdateRequestV2025R0,\n);" }, { "lang": "python", "label": "Update Box Hub collaboration", "source": "client.hub_collaborations.update_hub_collaboration_by_id_v2025_r0(\n created_collaboration.id, role=\"editor\"\n)" } ] }, "delete": { "operationId": "delete_hub_collaborations_id_v2025.0", "summary": "Remove Box Hub collaboration", "description": "Deletes a single Box Hub collaboration.", "parameters": [ { "name": "hub_collaboration_id", "in": "path", "description": "The ID of the hub collaboration.", "required": true, "schema": { "type": "string" }, "example": "1234" }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "204": { "description": "A blank response is returned if the Box Hub collaboration was successfully deleted." }, "404": { "description": "Returns an error if the Box Hub collaboration could not be found, or the authenticated user does not have access to the Box Hub collaboration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hub_collaborations", "tags": [ "Box Hub Collaborations" ], "x-codeSamples": [ { "lang": "curl", "label": "Remove Box Hub collaboration", "source": "curl -i -X DELETE \"https://api.box.com/2.0/hub_collaborations/1234\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Remove Box Hub collaboration", "source": "await client.HubCollaborations.DeleteHubCollaborationByIdV2025R0Async(hubCollaborationId: createdCollaboration.Id);" }, { "lang": "swift", "label": "Remove Box Hub collaboration", "source": "try await client.hubCollaborations.deleteHubCollaborationByIdV2025R0(hubCollaborationId: createdCollaboration.id)" }, { "lang": "java", "label": "Remove Box Hub collaboration", "source": "client.getHubCollaborations().deleteHubCollaborationByIdV2025R0(createdCollaboration.getId())" }, { "lang": "node", "label": "Remove Box Hub collaboration", "source": "await client.hubCollaborations.deleteHubCollaborationByIdV2025R0(\n createdCollaboration.id,\n);" }, { "lang": "python", "label": "Remove Box Hub collaboration", "source": "client.hub_collaborations.delete_hub_collaboration_by_id_v2025_r0(\n created_collaboration.id\n)" } ] } }, "/hub_items": { "get": { "operationId": "get_hub_items_v2025.0", "summary": "Get Box Hub items", "description": "Retrieves all items associated with a Box Hub.", "parameters": [ { "name": "hub_id", "in": "query", "description": "The unique identifier that represent a hub.\n\nThe ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "parent_id", "in": "query", "description": "The unique identifier of an item list block within the Box Hub.\n\nWhen provided, the response will only include items that belong to the specified item list, allowing you to filter results to items on a specific page or section.", "required": false, "schema": { "type": "string" }, "example": "721d97d7-ac8a-4e5e-adb6-ef11af4e6d9e" }, { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Retrieves the items associated with the specified Box Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubItems" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the Box Hub is not found, or the user does not have access to the Box Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hub_items", "tags": [ "Box Hub Items" ], "x-codeSamples": [ { "lang": "curl", "label": "Get Box Hub items", "source": "curl -i -X GET \"https://api.box.com/2.0/hub_items?hub_id=12345\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Get Box Hub items", "source": "await client.HubItems.GetHubItemsV2025R0Async(queryParams: new GetHubItemsV2025R0QueryParams(hubId: createdHub.Id));" }, { "lang": "swift", "label": "Get Box Hub items", "source": "try await client.hubItems.getHubItemsV2025R0(queryParams: GetHubItemsV2025R0QueryParams(hubId: createdHub.id))" }, { "lang": "java", "label": "Get Box Hub items", "source": "client.getHubItems().getHubItemsV2025R0(new GetHubItemsV2025R0QueryParams(createdHub.getId()))" }, { "lang": "node", "label": "Get Box Hub items", "source": "await client.hubItems.getHubItemsV2025R0({\n hubId: createdHub.id,\n} satisfies GetHubItemsV2025R0QueryParams);" }, { "lang": "python", "label": "Get Box Hub items", "source": "client.hub_items.get_hub_items_v2025_r0(created_hub.id)" } ] } }, "/hubs/{hub_id}/manage_items": { "post": { "operationId": "post_hubs_id_manage_items_v2025.0", "summary": "Manage Box Hub items", "description": "Adds and/or removes Box Hub items from a Box Hub.", "parameters": [ { "name": "hub_id", "in": "path", "description": "The unique identifier that represent a hub.\n\nThe ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubItemsManageRequest" } } } }, "responses": { "207": { "description": "Retrieves the status of all the operations.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubItemsManageResponse" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the Box Hub is not found, or the user does not have access to the Box Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hub_items", "tags": [ "Box Hub Items" ], "x-codeSamples": [ { "lang": "curl", "label": "Manage Box Hub items", "source": "curl -i -X POST \"https://api.box.com/2.0/hubs/12345/manage_items\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"operations\": [\n {\n \"action\": \"add\",\n \"item\": {\n \"type\": \"folder\",\n \"id\": \"123456789\"\n }\n }\n ]\n }'" }, { "lang": "dotnet", "label": "Manage Box Hub items", "source": "await client.HubItems.ManageHubItemsV2025R0Async(hubId: createdHub.Id, requestBody: new HubItemsManageRequestV2025R0() { Operations = Array.AsReadOnly(new [] {new HubItemOperationV2025R0(action: HubItemOperationV2025R0ActionField.Add, item: new FolderReferenceV2025R0(id: folder.Id))}) });" }, { "lang": "java", "label": "Manage Box Hub items", "source": "client.getHubItems().manageHubItemsV2025R0(createdHub.getId(), new HubItemsManageRequestV2025R0.Builder().operations(Arrays.asList(new HubItemOperationV2025R0(HubItemOperationV2025R0ActionField.ADD, new FolderReferenceV2025R0(folder.getId())))).build())" }, { "lang": "node", "label": "Manage Box Hub items", "source": "await client.hubItems.manageHubItemsV2025R0(createdHub.id, {\n operations: [\n {\n action: 'add' as HubItemOperationV2025R0ActionField,\n item: new FolderReferenceV2025R0({ id: folder.id }),\n } satisfies HubItemOperationV2025R0,\n ],\n} satisfies HubItemsManageRequestV2025R0);" }, { "lang": "python", "label": "Manage Box Hub items", "source": "client.hub_items.manage_hub_items_v2025_r0(\n created_hub.id,\n operations=[\n HubItemOperationV2025R0(\n action=HubItemOperationV2025R0ActionField.ADD,\n item=FolderReferenceV2025R0(id=folder.id),\n )\n ],\n)" } ] } }, "/hub_document_pages": { "get": { "operationId": "get_hub_document_pages_v2025.0", "summary": "List Hub Document Pages", "description": "Retrieves a list of Hub Document Pages for the specified hub. Includes both root-level pages and sub pages.", "parameters": [ { "name": "hub_id", "in": "query", "description": "The unique identifier that represent a hub.\n\nThe ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns a Hub Document Pages response whose `entries` array contains root-level pages and sub pages. Includes pagination when more results are available.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubDocumentPages" }, "examples": { "pages": { "summary": "Pages (root and sub pages)", "value": { "entries": [ { "id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f", "type": "page", "title_fragment": "This is the home page title !!" }, { "id": "df6be226-6a40-429e-afd3-0e9ea73f1990", "type": "page", "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f", "title_fragment": "This is the second page title !!" } ], "type": "document_pages", "limit": 1000, "next_marker": null } }, "with_pagination": { "summary": "With next page marker", "value": { "entries": [ { "id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f", "type": "page", "title_fragment": "This is the home page title !!" } ], "type": "document_pages", "limit": 1, "next_marker": "df6be226-6a40-429e-afd3-0e9ea73f1990" } } } } } }, "401": { "description": "Returned when the access token provided in the Authorization header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the Box Hub is not found, or the user does not have access to the Box Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hub_document", "tags": [ "Box Hub Document" ], "x-codeSamples": [ { "lang": "curl", "label": "List Hub Document Pages", "source": "curl -i -X GET \"https://api.box.com/2.0/hub_document_pages?hub_id=12345\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "List Hub Document Pages", "source": "await client.HubDocument.GetHubDocumentPagesV2025R0Async(queryParams: new GetHubDocumentPagesV2025R0QueryParams(hubId: hubId));" }, { "lang": "swift", "label": "List Hub Document Pages", "source": "try await client.hubDocument.getHubDocumentPagesV2025R0(queryParams: GetHubDocumentPagesV2025R0QueryParams(hubId: hubId))" }, { "lang": "java", "label": "List Hub Document Pages", "source": "client.getHubDocument().getHubDocumentPagesV2025R0(new GetHubDocumentPagesV2025R0QueryParams(hubId))" }, { "lang": "node", "label": "List Hub Document Pages", "source": "await client.hubDocument.getHubDocumentPagesV2025R0({\n hubId: hubId,\n} satisfies GetHubDocumentPagesV2025R0QueryParams);" }, { "lang": "python", "label": "List Hub Document Pages", "source": "client.hub_document.get_hub_document_pages_v2025_r0(hub_id)" } ] } }, "/hub_document_blocks": { "get": { "operationId": "get_hub_document_blocks_v2025.0", "summary": "List Hub Document blocks for page", "description": "Retrieves a sorted list of all Hub Document Blocks on a specified page in the hub document, excluding items. Blocks are hierarchically organized by their `parent_id`. Blocks are sorted in order based on user specification in the user interface. The response will only include content blocks that belong to the specified page. This will not include sub pages or sub page content blocks.", "parameters": [ { "name": "hub_id", "in": "query", "description": "The unique identifier that represent a hub.\n\nThe ID for any hub can be determined by visiting this hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "page_id", "in": "query", "description": "The unique identifier of a page within the Box Hub.", "required": true, "schema": { "type": "string" }, "example": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f" }, { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns a Hub Document Blocks response whose `entries` array contains all content blocks of the specified page, except for items. To retrieve items, use the `GET /hub_items` endpoint.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HubDocumentBlocks" }, "examples": { "blocks": { "summary": "Blocks for a page", "value": { "entries": [ { "id": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd", "type": "section_title", "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f", "fragment": "This is the section title" }, { "id": "721d97d7-ac8a-4e5e-adb6-ef11af4e6d9e", "type": "item_list", "parent_id": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f" } ], "type": "document_blocks", "limit": 1000, "next_marker": null } } } } } }, "401": { "description": "Returned when the access token provided in the Authorization header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned if the hub or page is not found, or the user does not have access to the Box Hub.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "hub_document", "tags": [ "Box Hub Document" ], "x-codeSamples": [ { "lang": "curl", "label": "List Hub Document blocks for page", "source": "curl -i -X GET \"https://api.box.com/2.0/hub_document_blocks?hub_id=12345&page_id=d97f7c26-0d9b-42a1-a00d-6e6db9619e0f\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "List Hub Document blocks for page", "source": "await client.HubDocument.GetHubDocumentBlocksV2025R0Async(queryParams: new GetHubDocumentBlocksV2025R0QueryParams(hubId: hubId, pageId: pageId));" }, { "lang": "swift", "label": "List Hub Document blocks for page", "source": "try await client.hubDocument.getHubDocumentBlocksV2025R0(queryParams: GetHubDocumentBlocksV2025R0QueryParams(hubId: hubId, pageId: pageId))" }, { "lang": "java", "label": "List Hub Document blocks for page", "source": "client.getHubDocument().getHubDocumentBlocksV2025R0(new GetHubDocumentBlocksV2025R0QueryParams(hubId, pageId))" }, { "lang": "node", "label": "List Hub Document blocks for page", "source": "await client.hubDocument.getHubDocumentBlocksV2025R0({\n hubId: hubId,\n pageId: pageId,\n} satisfies GetHubDocumentBlocksV2025R0QueryParams);" }, { "lang": "python", "label": "List Hub Document blocks for page", "source": "client.hub_document.get_hub_document_blocks_v2025_r0(hub_id, page_id)" } ] } }, "/shield_lists": { "get": { "operationId": "get_shield_lists_v2025.0", "summary": "Get all shield lists in enterprise", "description": "Retrieves all shield lists in the enterprise.", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" } ], "responses": { "200": { "description": "Returns the list of shield list objects.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldLists" } } } } }, "x-box-tag": "shield_lists", "tags": [ "Shield lists" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Get all shield lists in enterprise", "source": "curl -i -X GET \"https://api.box.com/2.0/shield_lists\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Get all shield lists in enterprise", "source": "await client.ShieldLists.GetShieldListsV2025R0Async();" }, { "lang": "java", "label": "Get all shield lists in enterprise", "source": "client.getShieldLists().getShieldListsV2025R0()" }, { "lang": "node", "label": "Get all shield lists in enterprise", "source": "await client.shieldLists.getShieldListsV2025R0();" }, { "lang": "python", "label": "Get all shield lists in enterprise", "source": "client.shield_lists.get_shield_lists_v2025_r0()" } ] }, "post": { "operationId": "post_shield_lists_v2025.0", "summary": "Create shield list", "description": "Creates a shield list.", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldListsCreate" } } } }, "responses": { "200": { "description": "Returns the shield list object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldList" } } } }, "409": { "description": "The shield list with this name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_lists", "tags": [ "Shield lists" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Create shield list", "source": "curl -i -X POST \"https://api.box.com/2.0/shield_lists\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"name\": \"My Shield List\",\n \"description\": \"A list of things that are shielded\",\n \"content\": {\n \"type\": \"country\",\n \"country_codes\": [\"US\", \"PL\"]\n }\n }'" }, { "lang": "dotnet", "label": "Create shield list", "source": "await client.ShieldLists.CreateShieldListV2025R0Async(requestBody: new ShieldListsCreateV2025R0(name: shieldListCountryName, content: new ShieldListContentCountryV2025R0(type: ShieldListContentCountryV2025R0TypeField.Country, countryCodes: Array.AsReadOnly(new [] {\"US\",\"PL\"}))) { Description = \"A list of things that are shielded\" });" }, { "lang": "java", "label": "Create shield list", "source": "client.getShieldLists().createShieldListV2025R0(new ShieldListsCreateV2025R0.Builder(shieldListCountryName, new ShieldListContentCountryV2025R0.Builder(Arrays.asList(\"US\", \"PL\")).type(ShieldListContentCountryV2025R0TypeField.COUNTRY).build()).description(\"A list of things that are shielded\").build())" }, { "lang": "node", "label": "Create shield list", "source": "await client.shieldLists.createShieldListV2025R0({\n name: shieldListCountryName,\n description: 'A list of things that are shielded',\n content: new ShieldListContentCountryV2025R0({\n type: 'country' as ShieldListContentCountryV2025R0TypeField,\n countryCodes: ['US', 'PL'],\n }),\n} satisfies ShieldListsCreateV2025R0);" }, { "lang": "python", "label": "Create shield list", "source": "client.shield_lists.create_shield_list_v2025_r0(\n shield_list_country_name,\n ShieldListContentCountryV2025R0(\n type=ShieldListContentCountryV2025R0TypeField.COUNTRY,\n country_codes=[\"US\", \"PL\"],\n ),\n description=\"A list of things that are shielded\",\n)" } ] } }, "/shield_lists/{shield_list_id}": { "get": { "operationId": "get_shield_lists_id_v2025.0", "summary": "Get single shield list by shield list id", "description": "Retrieves a single shield list by its ID.", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" }, { "name": "shield_list_id", "in": "path", "description": "The unique identifier that represents a shield list. The ID for any Shield List can be determined by the response from the endpoint fetching all shield lists for the enterprise.", "required": true, "schema": { "type": "string" }, "example": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 " } ], "responses": { "200": { "description": "Returns the shield list object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldList" } } } }, "404": { "description": "The shield list was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_lists", "tags": [ "Shield lists" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Get single shield list by shield list id", "source": "curl -i -X GET \"https://api.box.com/2.0/shield_lists/90fb0e17-c332-40ed-b4f9-fa8908fbbb24\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Get single shield list by shield list id", "source": "await client.ShieldLists.GetShieldListByIdV2025R0Async(shieldListId: shieldListCountry.Id);" }, { "lang": "java", "label": "Get single shield list by shield list id", "source": "client.getShieldLists().getShieldListByIdV2025R0(shieldListCountry.getId())" }, { "lang": "node", "label": "Get single shield list by shield list id", "source": "await client.shieldLists.getShieldListByIdV2025R0(shieldListCountry.id);" }, { "lang": "python", "label": "Get single shield list by shield list id", "source": "client.shield_lists.get_shield_list_by_id_v2025_r0(shield_list_country.id)" } ] }, "delete": { "operationId": "delete_shield_lists_id_v2025.0", "summary": "Delete single shield list by shield list id", "description": "Delete a single shield list by its ID.", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" }, { "name": "shield_list_id", "in": "path", "description": "The unique identifier that represents a shield list. The ID for any Shield List can be determined by the response from the endpoint fetching all shield lists for the enterprise.", "required": true, "schema": { "type": "string" }, "example": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 " } ], "responses": { "204": { "description": "Shield List correctly removed. No content in response." }, "400": { "description": "The shield list is assigned to some rules and cannot be removed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "The shield list was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_lists", "tags": [ "Shield lists" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Delete single shield list by shield list id", "source": "curl -i -X DELETE \"https://api.box.com/2.0/shield_lists/90fb0e17-c332-40ed-b4f9-fa8908fbbb24\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Delete single shield list by shield list id", "source": "await client.ShieldLists.DeleteShieldListByIdV2025R0Async(shieldListId: shieldListCountry.Id);" }, { "lang": "java", "label": "Delete single shield list by shield list id", "source": "client.getShieldLists().deleteShieldListByIdV2025R0(shieldListCountry.getId())" }, { "lang": "node", "label": "Delete single shield list by shield list id", "source": "await client.shieldLists.deleteShieldListByIdV2025R0(shieldListCountry.id);" }, { "lang": "python", "label": "Delete single shield list by shield list id", "source": "client.shield_lists.delete_shield_list_by_id_v2025_r0(shield_list_country.id)" } ] }, "put": { "operationId": "put_shield_lists_id_v2025.0", "summary": "Update shield list", "description": "Updates a shield list.", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" }, { "name": "shield_list_id", "in": "path", "description": "The unique identifier that represents a shield list. The ID for any Shield List can be determined by the response from the endpoint fetching all shield lists for the enterprise.", "required": true, "schema": { "type": "string" }, "example": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24 " } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldListsUpdate" } } } }, "responses": { "200": { "description": "Returns the shield list object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShieldList" } } } }, "404": { "description": "The shield list was not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "The shield list with this name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "shield_lists", "tags": [ "Shield lists" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Update shield list", "source": "curl -i -X PUT \"https://api.box.com/2.0/shield_lists/90fb0e17-c332-40ed-b4f9-fa8908fbbb24\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"name\": \"My Shield List\",\n \"description\": \"Updated description\",\n \"content\": {\n \"type\": \"country\",\n \"country_codes\": [\"US\"]\n }\n }'" }, { "lang": "dotnet", "label": "Update shield list", "source": "await client.ShieldLists.UpdateShieldListByIdV2025R0Async(shieldListId: shieldListCountry.Id, requestBody: new ShieldListsUpdateV2025R0(name: shieldListCountryName, content: new ShieldListContentCountryV2025R0(type: ShieldListContentCountryV2025R0TypeField.Country, countryCodes: Array.AsReadOnly(new [] {\"US\"}))) { Description = \"Updated description\" });" }, { "lang": "java", "label": "Update shield list", "source": "client.getShieldLists().updateShieldListByIdV2025R0(shieldListCountry.getId(), new ShieldListsUpdateV2025R0.Builder(shieldListCountryName, new ShieldListContentCountryV2025R0.Builder(Arrays.asList(\"US\")).type(ShieldListContentCountryV2025R0TypeField.COUNTRY).build()).description(\"Updated description\").build())" }, { "lang": "node", "label": "Update shield list", "source": "await client.shieldLists.updateShieldListByIdV2025R0(shieldListCountry.id, {\n name: shieldListCountryName,\n description: 'Updated description',\n content: new ShieldListContentCountryV2025R0({\n type: 'country' as ShieldListContentCountryV2025R0TypeField,\n countryCodes: ['US'],\n }),\n} satisfies ShieldListsUpdateV2025R0);" }, { "lang": "python", "label": "Update shield list", "source": "client.shield_lists.update_shield_list_by_id_v2025_r0(\n shield_list_country.id,\n shield_list_country_name,\n ShieldListContentCountryV2025R0(\n type=ShieldListContentCountryV2025R0TypeField.COUNTRY, country_codes=[\"US\"]\n ),\n description=\"Updated description\",\n)" } ] } }, "/archives": { "get": { "operationId": "get_archives_v2025.0", "summary": "List archives", "description": "Retrieves archives for an enterprise.\n\nTo learn more about the archive APIs, see the [Archive API Guide](/guides/archives).", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" }, { "name": "limit", "in": "query", "description": "The maximum number of items to return per page.", "required": false, "schema": { "type": "integer", "format": "int64", "maximum": 1000 }, "example": 1000 }, { "name": "marker", "in": "query", "description": "Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.", "required": false, "schema": { "type": "string" }, "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii" } ], "responses": { "200": { "description": "Returns a list of archives in the enterprise.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Archives" } } } }, "400": { "description": "Returned when some of the parameters are missing or not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "Returned when the authenticated user does not have the right permissions to list archives.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "Returned when an unexpected server error occurs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "Returned when an unexpected client error occurs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "archives", "tags": [ "Archives" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "List archives", "source": "curl -i -X GET \"https://api.box.com/2.0/archives\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "List archives", "source": "await client.Archives.GetArchivesV2025R0Async(queryParams: new GetArchivesV2025R0QueryParams() { Limit = 100L });" }, { "lang": "swift", "label": "List archives", "source": "try await client.archives.getArchivesV2025R0(queryParams: GetArchivesV2025R0QueryParams(limit: Int64(100)))" }, { "lang": "java", "label": "List archives", "source": "client.getArchives().getArchivesV2025R0(new GetArchivesV2025R0QueryParams.Builder().limit(100L).build())" }, { "lang": "node", "label": "List archives", "source": "await client.archives.getArchivesV2025R0({\n limit: 100,\n} satisfies GetArchivesV2025R0QueryParams);" }, { "lang": "python", "label": "List archives", "source": "client.archives.get_archives_v2025_r0(limit=100)" } ] }, "post": { "operationId": "post_archives_v2025.0", "summary": "Create archive", "description": "Creates an archive.\n\nTo learn more about the archive APIs, see the [Archive API Guide](/guides/archives).", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "The name of the archive.", "type": "string", "example": "Some Archive" }, "description": { "description": "The description of the archive.", "type": "string", "example": "This is an archive for important documents." }, "storage_policy_id": { "description": "The ID of the storage policy that the archive is assigned to.", "type": "string", "example": "100001" } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "Returns a new archive object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Archive" } } } }, "400": { "description": "Returned when some of the parameters are missing or not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "Returned when the authenticated user does not have the right permissions to create an archive.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "Returned when an archive with the given name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "Returned when an unexpected server error occurs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "Returned when an unexpected client error occurs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "archives", "tags": [ "Archives" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Create archive", "source": "curl -i -X POST \"https://api.box.com/2.0/archives\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"name\": \"Some Archive Name\",\n \"description\": \"Some Archive Description\"\n }'" }, { "lang": "dotnet", "label": "Create archive", "source": "await client.Archives.CreateArchiveV2025R0Async(requestBody: new CreateArchiveV2025R0RequestBody(name: archiveName) { Description = archiveDescription });" }, { "lang": "swift", "label": "Create archive", "source": "try await client.archives.createArchiveV2025R0(requestBody: CreateArchiveV2025R0RequestBody(name: archiveName, description: archiveDescription))" }, { "lang": "java", "label": "Create archive", "source": "client.getArchives().createArchiveV2025R0(new CreateArchiveV2025R0RequestBody.Builder(archiveName).description(archiveDescription).build())" }, { "lang": "node", "label": "Create archive", "source": "await client.archives.createArchiveV2025R0({\n name: archiveName,\n description: archiveDescription,\n} satisfies CreateArchiveV2025R0RequestBody);" }, { "lang": "python", "label": "Create archive", "source": "client.archives.create_archive_v2025_r0(archive_name, description=archive_description)" } ] } }, "/archives/{archive_id}": { "delete": { "operationId": "delete_archives_id_v2025.0", "summary": "Delete archive", "description": "Permanently deletes an archive.\n\nTo learn more about the archive APIs, see the [Archive API Guide](/guides/archives).\n\n\nThis endpoint is currently unavailable. Please contact support for assistance.\n", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" }, { "name": "archive_id", "in": "path", "description": "The ID of the archive.", "required": true, "schema": { "type": "string" }, "example": "982312" } ], "responses": { "204": { "description": "Returns an empty response when the archive has been deleted." }, "400": { "description": "Returns an error if the archive is not empty.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "Returns an error if the user does not have the right permissions to delete the archive.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returns an error if the archive is not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "An unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "archives", "tags": [ "Archives" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Delete archive", "source": "curl -i -X DELETE \"https://api.box.com/2.0/archives/12345\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \"" }, { "lang": "dotnet", "label": "Delete archive", "source": "await client.Archives.DeleteArchiveByIdV2025R0Async(archiveId: archive.Id);" }, { "lang": "swift", "label": "Delete archive", "source": "try await client.archives.deleteArchiveByIdV2025R0(archiveId: archive.id)" }, { "lang": "java", "label": "Delete archive", "source": "client.getArchives().deleteArchiveByIdV2025R0(archive.getId())" }, { "lang": "node", "label": "Delete archive", "source": "await client.archives.deleteArchiveByIdV2025R0(archive.id);" }, { "lang": "python", "label": "Delete archive", "source": "client.archives.delete_archive_by_id_v2025_r0(archive.id)" } ] }, "put": { "operationId": "put_archives_id_v2025.0", "summary": "Update archive", "description": "Updates an archive.\n\nTo learn more about the archive APIs, see the [Archive API Guide](/guides/archives).", "parameters": [ { "name": "archive_id", "in": "path", "description": "The ID of the archive.", "required": true, "schema": { "type": "string" }, "example": "982312" }, { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "description": "The name of the archive.", "type": "string", "example": "Some Archive" }, "description": { "description": "The description of the archive.", "type": "string", "example": "This is an archive for important documents." } } } } } }, "responses": { "200": { "description": "Returns the updated archive object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Archive" } } } }, "400": { "description": "Returned when some of the parameters are not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "401": { "description": "Returned when the access token provided in the `Authorization` header is not recognized or not provided.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "403": { "description": "Returned when the authenticated user does not have the right permissions to update the archive.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "404": { "description": "Returned when the archive is not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "409": { "description": "Returned when an archive with the given name already exists.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "500": { "description": "Returned when an unexpected server error occurs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "Returned when an unexpected client error occurs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "archives", "tags": [ "Archives" ], "x-box-unsupported-on-free-developer": true, "x-codeSamples": [ { "lang": "curl", "label": "Update archive", "source": "curl -i -X PUT \"https://api.box.com/2.0/archives/12345\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"name\": \"Some Archive Name\",\n \"description\": \"Some Archive Description\"\n }'" }, { "lang": "dotnet", "label": "Update archive", "source": "await client.Archives.UpdateArchiveByIdV2025R0Async(archiveId: archive.Id, requestBody: new UpdateArchiveByIdV2025R0RequestBody() { Name = newArchiveName, Description = newArchiveDescription });" }, { "lang": "swift", "label": "Update archive", "source": "try await client.archives.updateArchiveByIdV2025R0(archiveId: archive.id, requestBody: UpdateArchiveByIdV2025R0RequestBody(name: newArchiveName, description: newArchiveDescription))" }, { "lang": "java", "label": "Update archive", "source": "client.getArchives().updateArchiveByIdV2025R0(archive.getId(), new UpdateArchiveByIdV2025R0RequestBody.Builder().name(newArchiveName).description(newArchiveDescription).build())" }, { "lang": "node", "label": "Update archive", "source": "await client.archives.updateArchiveByIdV2025R0(archive.id, {\n requestBody: {\n name: newArchiveName,\n description: newArchiveDescription,\n } satisfies UpdateArchiveByIdV2025R0RequestBody,\n} satisfies UpdateArchiveByIdV2025R0OptionalsInput);" }, { "lang": "python", "label": "Update archive", "source": "client.archives.update_archive_by_id_v2025_r0(\n archive.id, name=new_archive_name, description=new_archive_description\n)" } ] } }, "/external_users/submit_delete_job": { "post": { "operationId": "post_external_users_submit_delete_job_v2025.0", "summary": "Submit job to delete external users", "description": "Delete external users from current user enterprise. This will remove each external user from all invited collaborations within the current enterprise.", "parameters": [ { "$ref": "#/components/parameters/BoxVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUsersSubmitDeleteJobRequest" } } } }, "responses": { "207": { "description": "Multi-status response containing the result for each external user deletion request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUsersSubmitDeleteJobResponse" } } } }, "404": { "description": "Returns an error if the listed external users are not found, or the authenticated user does not have the right permissions to delete external users.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } }, "default": { "description": "An unexpected client error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClientError" } } } } }, "x-box-tag": "external_users", "tags": [ "External Users" ], "x-codeSamples": [ { "lang": "curl", "label": "Submit job to delete external users", "source": "curl -i -X POST \"https://api.box.com/2.0/external_users/submit_delete_job\" \\\n -H \"box-version: 2025.0\" \\\n -H \"authorization: Bearer \" \\\n -H \"content-type: application/json\" \\\n -d '{\n \"external_users\": [\n {\n \"type\": \"user\",\n \"id\": \"12345\"\n }\n ]\n }'" }, { "lang": "dotnet", "label": "Submit job to delete external users", "source": "await client.ExternalUsers.SubmitJobToDeleteExternalUsersV2025R0Async(requestBody: new ExternalUsersSubmitDeleteJobRequestV2025R0(externalUsers: Array.AsReadOnly(new [] {new UserReferenceV2025R0(id: Utils.GetEnvVar(name: \"BOX_EXTERNAL_USER_ID\"))})));" }, { "lang": "swift", "label": "Submit job to delete external users", "source": "try await client.externalUsers.submitJobToDeleteExternalUsersV2025R0(requestBody: ExternalUsersSubmitDeleteJobRequestV2025R0(externalUsers: [UserReferenceV2025R0(id: Utils.getEnvironmentVariable(name: \"BOX_EXTERNAL_USER_ID\"))]))" }, { "lang": "java", "label": "Submit job to delete external users", "source": "client.getExternalUsers().submitJobToDeleteExternalUsersV2025R0(new ExternalUsersSubmitDeleteJobRequestV2025R0(Arrays.asList(new UserReferenceV2025R0(getEnvVar(\"BOX_EXTERNAL_USER_ID\")))))" }, { "lang": "node", "label": "Submit job to delete external users", "source": "await client.externalUsers.submitJobToDeleteExternalUsersV2025R0({\n externalUsers: [\n new UserReferenceV2025R0({ id: getEnvVar('BOX_EXTERNAL_USER_ID') }),\n ],\n} satisfies ExternalUsersSubmitDeleteJobRequestV2025R0);" }, { "lang": "python", "label": "Submit job to delete external users", "source": "client.external_users.submit_job_to_delete_external_users_v2025_r0(\n [UserReferenceV2025R0(id=get_env_var(\"BOX_EXTERNAL_USER_ID\"))]\n)" } ] } } }, "components": { "parameters": { "BoxVersionHeader": { "name": "box-version", "in": "header", "description": "Version header.", "allowEmptyValue": false, "required": true, "schema": { "type": "string", "enum": [ "2025.0" ] }, "example": "2025.0" } }, "schemas": { "Archive": { "description": "An archive is a folder dedicated to storing content that is redundant, outdated, or trivial. Content in an archive is not accessible to its owner and collaborators. To use this feature, you must request GCM scope for your Box application.", "type": "object", "properties": { "id": { "description": "The unique identifier that represents an archive.", "type": "string", "example": "12345", "nullable": false }, "type": { "description": "The value is always `archive`.", "type": "string", "example": "archive", "enum": [ "archive" ], "nullable": false }, "name": { "description": "The name of the archive.\n\nThe following restrictions to the archive name apply: names containing non-printable ASCII characters, forward and backward slashes (`/`, `\\`), names with trailing spaces, and names `.` and `..` are not allowed.", "type": "string", "example": "Archive", "maxLength": 100, "minLength": 1, "nullable": false }, "size": { "description": "The size of the archive in bytes.", "type": "integer", "format": "int64", "example": 123456789, "nullable": false }, "description": { "description": "The description of the archive.", "type": "string", "example": "This is an archive for important documents.", "maxLength": 255, "minLength": 0, "nullable": true }, "owned_by": { "description": "The part of an archive API response that describes the user who owns the archive.", "type": "object", "example": { "id": "12345", "type": "user" }, "properties": { "id": { "description": "The unique identifier that represents a user who owns the archive.", "type": "string", "example": "12345", "nullable": false }, "type": { "description": "The value is always `user`.", "type": "string", "example": "user", "nullable": false } }, "required": [ "id", "type" ] } }, "required": [ "id", "type", "name", "size" ], "title": "Archive", "x-box-resource-id": "archive_v2025.0", "x-box-tag": "archives" }, "Archives": { "description": "A list of archives.", "type": "object", "allOf": [ { "properties": { "entries": { "description": "A list in which each entry represents an archive object.", "type": "array", "items": { "$ref": "#/components/schemas/Archive" } } } }, { "type": "object", "description": "The part of an API response that describes marker based pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "The marker for the start of the next page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true } } } ], "title": "Archives", "x-box-resource-id": "archives_v2025.0", "x-box-tag": "archives" }, "ClientError": { "description": "A generic error.", "type": "object", "properties": { "type": { "description": "The value will always be `error`.", "type": "string", "example": "error", "enum": [ "error" ], "nullable": false }, "status": { "description": "The HTTP status of the response.", "type": "integer", "format": "int32", "example": 400, "nullable": false }, "code": { "description": "A Box-specific error code.", "type": "string", "example": "item_name_invalid", "enum": [ "created", "accepted", "no_content", "redirect", "not_modified", "bad_request", "unauthorized", "forbidden", "not_found", "method_not_allowed", "conflict", "precondition_failed", "too_many_requests", "internal_server_error", "unavailable", "item_name_invalid", "insufficient_scope" ] }, "message": { "description": "A short message describing the error.", "type": "string", "example": "Method Not Allowed", "nullable": false }, "context_info": { "description": "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.", "type": "object", "example": { "message": "Something went wrong" }, "additionalProperties": {}, "nullable": true }, "help_url": { "description": "A URL that links to more information about why this error occurred.", "type": "string", "example": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/", "nullable": false }, "request_id": { "description": "A unique identifier for this response, which can be used when contacting Box support.", "type": "string", "example": "abcdef123456", "nullable": false } }, "title": "Client error", "x-box-resource-id": "client_error_v2025.0" }, "CollaborationPermissions": { "description": "The collaboration permissions.", "type": "object", "properties": { "is_co_owner_role_enabled": { "description": "The co-owner role is enabled for collaboration.", "type": "boolean", "example": true }, "is_editor_role_enabled": { "description": "The editor role is enabled for collaboration.", "type": "boolean", "example": true }, "is_previewer_role_enabled": { "description": "The previewer role is enabled for collaboration.", "type": "boolean", "example": true }, "is_previewer_uploader_role_enabled": { "description": "The previewer uploader role is enabled for collaboration.", "type": "boolean", "example": true }, "is_uploader_role_enabled": { "description": "The uploader role is enabled for collaboration.", "type": "boolean", "example": true }, "is_viewer_role_enabled": { "description": "The viewer role is enabled for collaboration.", "type": "boolean", "example": true }, "is_viewer_uploader_role_enabled": { "description": "The viewer uploader role is enabled for collaboration.", "type": "boolean", "example": true } }, "title": "Collaboration permissions" }, "CustomSessionDurationGroupItem": { "description": "A custom session duration group item.", "type": "object", "properties": { "id": { "description": "Group ID (numerical).", "type": "string", "example": "1234" }, "name": { "description": "Group Name.", "type": "string", "example": "Group Name" } }, "title": "Custom session duration group item" }, "DocGenBatch--Base": { "description": "The basic representation of a Box Doc Gen batch object. A Box Doc Gen batch contains one or more Box Doc Gen jobs.", "type": "object", "properties": { "id": { "description": "The unique identifier that represents a Box Doc Gen batch.", "type": "string", "example": "12345", "nullable": false }, "type": { "description": "The value will always be `docgen_batch`.", "type": "string", "example": "docgen_batch", "enum": [ "docgen_batch" ], "nullable": false } }, "required": [ "id", "type" ], "title": "Box Doc Gen batch (Base)", "x-box-resource-id": "docgen_batch_v2025.0--base", "x-box-tag": "docgen", "x-box-variant": "base", "x-box-variants": [ "base" ] }, "DocGenBatchCreateRequest": { "description": "The schema for creating a Box Doc Gen job batch request.", "type": "object", "properties": { "file": { "allOf": [ { "$ref": "#/components/schemas/FileReference" }, { "description": "A Box Doc Gen template that is used to generate the document." } ] }, "file_version": { "allOf": [ { "$ref": "#/components/schemas/FileVersion--Base" }, { "description": "File version of a template." } ] }, "input_source": { "description": "Source of input. The value has to be `api` for all the API-based document generation requests.", "type": "string", "example": "api" }, "destination_folder": { "allOf": [ { "title": "Folder reference", "type": "object", "description": "Folder reference.", "required": [ "type", "id" ], "properties": { "type": { "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ "folder" ], "nullable": false }, "id": { "description": "ID of the folder.", "type": "string", "example": "42037322" } } }, { "description": "Destination folder for the generated files." } ] }, "output_type": { "description": "Type of the output file.", "type": "string", "example": "docx" }, "document_generation_data": { "type": "array", "items": { "$ref": "#/components/schemas/DocGenDocumentGenerationData" } } }, "required": [ "file", "input_source", "destination_folder", "output_type", "document_generation_data" ], "title": "Create batch request" }, "DocGenDocumentGenerationData": { "description": "The schema for for creating a Box Doc Gen job request.", "type": "object", "properties": { "generated_file_name": { "description": "File name of the output file.", "type": "string", "example": "New_Template" }, "user_input": { "type": "object", "example": { "name": "Aaron Levie" }, "additionalProperties": {} } }, "required": [ "generated_file_name", "user_input" ], "title": "Document generation data" }, "DocGenJob": { "description": "A standard representation of a Box Doc Gen job.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/DocGenJob--Base" }, { "properties": { "batch": { "allOf": [ { "$ref": "#/components/schemas/DocGenBatch--Base" }, { "description": "Box Doc Gen batch that the job belongs to." } ] }, "template_file": { "allOf": [ { "$ref": "#/components/schemas/FileReference" }, { "description": "Box Doc Gen template used in the job." } ] }, "template_file_version": { "allOf": [ { "$ref": "#/components/schemas/FileVersion--Base" }, { "description": "File version of a template." } ] }, "output_file": { "allOf": [ { "oneOf": [ { "$ref": "#/components/schemas/FileReference" }, { "title": "OpenAPI 3.0 null schema type", "description": "The definition for a null schema type in OpenAPI `3.0`.", "type": "object", "nullable": true, "additionalProperties": false } ] }, { "description": "The output file of the job. This property is `null` until the job is completed." } ] }, "output_file_version": { "allOf": [ { "oneOf": [ { "$ref": "#/components/schemas/FileVersion--Base" }, { "title": "OpenAPI 3.0 null schema type", "description": "The definition for a null schema type in OpenAPI `3.0`.", "type": "object", "nullable": true, "additionalProperties": false } ] }, { "description": "File version of the output file. This property is `null` until the job is completed." } ] }, "status": { "description": "Status of the job.", "type": "string", "example": "completed", "enum": [ "submitted", "completed", "failed", "completed_with_error", "pending" ] }, "output_type": { "description": "Type of the generated file.", "type": "string", "example": "docx" }, "failures": { "description": "Errors and warnings that occurred during document generation.", "type": "object", "nullable": true, "properties": { "errors": { "description": "A list of errors that occurred during document generation.", "type": "array", "items": { "type": "string" }, "example": [ "The tag 'customer_name' was not provided in the input data." ] }, "warnings": { "description": "A list of warnings that occurred during document generation.", "type": "array", "items": { "type": "string" }, "example": [ "The tag 'optional_field' was provided but not used in the template." ] } }, "required": [ "errors", "warnings" ] } } } ], "required": [ "id", "batch", "template_file", "template_file_version", "status", "output_type" ], "title": "Box Doc Gen job", "x-box-resource-id": "docgen_job_v2025.0", "x-box-tag": "docgen", "x-box-variant": "standard", "x-box-variants": [ "base", "standard", "full" ] }, "DocGenJob--Base": { "description": "The basic representation of a Box Doc Gen job.", "type": "object", "properties": { "id": { "description": "The unique identifier that represent a Box Doc Gen job.", "type": "string", "example": "12345", "nullable": false }, "type": { "description": "The value will always be `docgen_job`.", "type": "string", "example": "docgen_job", "enum": [ "docgen_job" ], "nullable": false } }, "required": [ "id", "type" ], "title": "Box Doc Gen job (Base)", "x-box-resource-id": "docgen_job_v2025.0--base", "x-box-tag": "docgen", "x-box-variant": "base", "x-box-variants": [ "base", "standard", "full" ] }, "DocGenJob--Full": { "description": "A full representation of a Box Doc Gen job.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/DocGenJob" }, { "properties": { "created_at": { "description": "Time of job creation.", "type": "string", "example": "2022-05-11T10:56:11-07:00", "readOnly": true }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "description": "User who created the job." } ] }, "enterprise": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseReference" }, { "description": "ID of the enterprise." } ] }, "source": { "description": "Source of the request.", "type": "string", "example": "api", "readOnly": true } } } ], "required": [ "id", "batch", "created_by", "enterprise", "template_file", "template_file_version", "output_type", "source", "status" ], "title": "Box Doc Gen job (Full)", "x-box-resource-id": "docgen_job_v2025.0--full", "x-box-tag": "docgen", "x-box-variant": "full", "x-box-variants": [ "base", "standard", "full" ] }, "DocGenJobs": { "description": "A list of Box Doc Gen jobs with a standard set of parameters.", "type": "object", "allOf": [ { "type": "object", "description": "The part of an API response that describes marker based pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "The marker for the start of the next page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", "nullable": true } } }, { "properties": { "entries": { "description": "List of jobs.", "type": "array", "items": { "$ref": "#/components/schemas/DocGenJob" } } } } ], "title": "Box Doc Gen jobs", "x-box-resource-id": "docgen_jobs_v2025.0", "x-box-tag": "docgen", "x-box-variant": "base", "x-box-variants": [ "standard", "full" ] }, "DocGenJobs--Full": { "description": "A list of Box Doc Gen jobs with a full set of parameters.", "type": "object", "allOf": [ { "type": "object", "description": "The part of an API response that describes marker based pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "The marker for the start of the next page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", "nullable": true } } }, { "properties": { "entries": { "description": "List of jobs.", "type": "array", "items": { "$ref": "#/components/schemas/DocGenJob--Full" } } } } ], "title": "Box Doc Gen jobs (Full)", "x-box-resource-id": "docgen_jobs_v2025.0--full", "x-box-tag": "docgen", "x-box-variant": "full", "x-box-variants": [ "standard", "full" ] }, "DocGenTag": { "description": "A Box Doc Gen template tag object.", "type": "object", "properties": { "tag_content": { "description": "The content of the tag.", "type": "string", "example": "{{item.name}}", "readOnly": true }, "tag_type": { "description": "Type of the tag.", "type": "string", "example": "text", "enum": [ "text", "arithmetic", "conditional", "for-loop", "table-loop", "image" ], "readOnly": true }, "json_paths": { "description": "List of the paths.", "type": "array", "items": { "readOnly": true, "type": "string", "example": "products.name" }, "example": [ "products", "products.name" ], "readOnly": true } }, "required": [ "tag_content", "tag_type", "json_paths" ], "title": "Box Doc Gen template tag", "x-box-resource-id": "docgen_tag_v2025.0", "x-box-sanitized": true, "x-box-tag": "docgen_template" }, "DocGenTags": { "description": "A list of Box Doc Gen tags.", "type": "object", "allOf": [ { "type": "object", "description": "The part of an API response that describes marker based pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "The marker for the start of the next page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", "nullable": true } } }, { "properties": { "entries": { "description": "List of tags.", "type": "array", "items": { "$ref": "#/components/schemas/DocGenTag" } } } } ], "title": "Box Doc Gen tags", "x-box-resource-id": "docgen_tags_v2025.0", "x-box-tag": "docgen_template" }, "DocGenTagsProcessingMessage": { "description": "A message informing the user that document tags are still being processed.", "type": "object", "properties": { "message": { "description": "A message informing the user that document tags are still being processed.", "type": "string", "example": "Processing tags for this file.", "readOnly": true } }, "required": [ "message" ], "title": "Box Doc Gen tags processing message", "x-box-resource-id": "docgen_tags_processing_message_v2025.0", "x-box-tag": "docgen_template" }, "DocGenTemplate": { "description": "A Box Doc Gen template object.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/DocGenTemplate--Base" }, { "properties": { "file_name": { "description": "The name of the template.", "type": "string", "example": "Official contract", "nullable": true } } } ], "title": "Box Doc Gen template", "x-box-resource-id": "docgen_template_v2025.0", "x-box-tag": "docgen_template", "x-box-variant": "standard", "x-box-variants": [ "base", "standard" ] }, "DocGenTemplate--Base": { "description": "A base representation of a Box Doc Gen template, used when nested within another resource.", "type": "object", "properties": { "file": { "allOf": [ { "$ref": "#/components/schemas/FileReference" }, { "description": "Enable the file to generate a document from." } ] } }, "title": "Box Doc Gen template (Base)", "x-box-resource-id": "docgen_template_v2025.0--base", "x-box-variant": "base", "x-box-variants": [ "base", "standard" ] }, "DocGenTemplateCreateRequest": { "description": "The schema for marking document as Box Doc Gen template.", "type": "object", "properties": { "file": { "allOf": [ { "$ref": "#/components/schemas/FileReference" }, { "description": "Marks the file as a Box Doc Gen template to generate the document from." } ] } }, "required": [ "file" ], "title": "Mark file as Box Doc Gen template" }, "DocGenTemplates": { "description": "List of Box Doc Gen templates.", "type": "object", "allOf": [ { "type": "object", "description": "The part of an API response that describes marker based pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "The marker for the start of the next page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true }, "prev_marker": { "description": "The marker for the start of the previous page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih", "nullable": true } } }, { "properties": { "entries": { "description": "A list of templates.", "type": "array", "items": { "$ref": "#/components/schemas/DocGenTemplate" } } } } ], "title": "Box Doc Gen templates", "x-box-resource-id": "docgen_templates_v2025.0", "x-box-tag": "docgen_template" }, "EnterpriseConfiguration": { "description": "The enterprise configuration for a given enterprise.", "type": "object", "properties": { "id": { "description": "The identifier of the enterprise configuration which is the ID of the enterprise.", "type": "string", "example": "11446498" }, "type": { "description": "The value will always be `enterprise_configuration`.", "type": "string", "example": "enterprise_configuration", "enum": [ "enterprise_configuration" ] }, "security": { "allOf": [ { "oneOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationSecurity" }, { "title": "OpenAPI 3.0 null schema type", "description": "The definition for a null schema type in OpenAPI `3.0`.", "type": "object", "nullable": true, "additionalProperties": false } ] }, { "description": "The enterprise configurations for the security category." } ] }, "content_and_sharing": { "allOf": [ { "oneOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationContentAndSharing" }, { "title": "OpenAPI 3.0 null schema type", "description": "The definition for a null schema type in OpenAPI `3.0`.", "type": "object", "nullable": true, "additionalProperties": false } ] }, { "description": "The enterprise configurations for the content and sharing category." } ] }, "user_settings": { "allOf": [ { "oneOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationUserSettings" }, { "title": "OpenAPI 3.0 null schema type", "description": "The definition for a null schema type in OpenAPI `3.0`.", "type": "object", "nullable": true, "additionalProperties": false } ] }, { "description": "The enterprise configurations for the user settings category." } ] }, "shield": { "allOf": [ { "oneOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationShield" }, { "title": "OpenAPI 3.0 null schema type", "description": "The definition for a null schema type in OpenAPI `3.0`.", "type": "object", "nullable": true, "additionalProperties": false } ] }, { "description": "The enterprise configurations for the shield category. If shield is turned off for given enterprise, the response will be 404." } ] } }, "title": "Enterprise configuration", "x-box-resource-id": "enterprise_configuration_v2025.0", "x-box-tag": "enterprise_configurations" }, "EnterpriseConfigurationContentAndSharing": { "description": "The enterprise configuration for the content and sharing category.", "type": "object", "properties": { "enterprise_feature_settings": { "type": "array", "items": { "$ref": "#/components/schemas/EnterpriseFeatureSettingsItem" } }, "sharing_item_type": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "The selected option for the type of items that sharing is enable for." } ] }, "shared_link_company_definition": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "The definition of the company for shared links (such as `enterprise_id`, `users_with_email_domain`)." } ] }, "shared_link_access": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "The selected option for who has access to shared links." } ] }, "shared_link_default_access": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "The selected option for the access level of shared links." } ] }, "shared_link_default_permissions_selected": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "description": "The permissions selected for shared links for each type." }, { "properties": { "value": { "$ref": "#/components/schemas/SharedLinkPermissions" } } } ] }, "is_open_custom_urls_disabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Disables custom shared link URLs for public access." } ] }, "is_custom_domain_hidden_in_shared_link": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Hides the custom domain in shared links." } ] }, "collaboration_permissions": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "properties": { "value": { "$ref": "#/components/schemas/CollaborationPermissions" } } } ] }, "default_collaboration_role": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "The current default collaboration role." } ] }, "is_invite_privilege_restricted": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Restrict invites to only admin, folder owners, and co-owners." } ] }, "collaboration_restrictions": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "description": "The collaboration restrictions for the enterprise." }, { "properties": { "value": { "type": "array", "items": { "type": "string", "description": "The collaboration restriction. Possible values: `internal`, `external`.", "example": "internal" }, "example": [ "internal" ] } } } ] }, "is_collaborator_invite_links_disabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Disables users to invite collaborators using invite links." } ] }, "is_invite_group_collaborator_disabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Disables users to invite group collaborators." } ] }, "is_ownership_transfer_restricted": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Prevents ownership transfer to external users." } ] }, "external_collaboration_status": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "description": "The external collaboration status. Possible values: `enable_external_collaboration`, `limit_collaboration_to_allowlisted_domains`, `limit_collaboration_to_users_within_enterprise`." }, { "properties": { "value": { "description": "The external collaboration status.", "type": "string", "example": "enable_external_collaboration", "nullable": true } } } ] }, "external_collaboration_allowlist_users": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "description": "The external collaboration allowlist users." }, { "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ListUser" } } } } ] }, "is_watermarking_enterprise_feature_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables watermarking enterprise feature." } ] }, "is_root_content_creation_restricted": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Only admins can create and delete first-level folders, files, and bookmarks." } ] }, "is_tag_creation_restricted": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Only selected users can create tags." } ] }, "tag_creation_restriction": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "The selected option for tag creation restriction." } ] }, "is_email_uploads_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables email uploads." } ] }, "is_custom_settings_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables custom settings." } ] }, "is_forms_login_required": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Require uploaders to log in with a Box account for Forms." } ] }, "is_forms_branding_default_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Company brand color and logo defaults to Logo for use on Brand Color for Forms." } ] }, "is_cc_free_trial_active": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Indicates if the enterprise is on a free trial." } ] }, "is_file_request_editors_allowed": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Indicates if editors are allowed for file requests feature." } ] }, "is_file_request_branding_default_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Company brand color and logo defaults to Logo for use on Brand Color for File Requests." } ] }, "is_file_request_login_required": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Require uploaders to log in with a Box account for File Requests." } ] }, "is_shared_links_expiration_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables shared links expiration." } ] }, "shared_links_expiration_days": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "The expiration time for shared links." } ] }, "is_public_shared_links_expiration_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables public shared links expiration." } ] }, "public_shared_links_expiration_days": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "The expiration time for public shared links." } ] }, "shared_expiration_target": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "The selected option of types for applying shared link expiration." } ] }, "is_shared_links_expiration_notification_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables shared links expiration notification." } ] }, "shared_links_expiration_notification_days": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "The number of days before expiration to notify users." } ] }, "is_shared_links_expiration_notification_prevented": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Prevents users from disabling shared links expiration notification." } ] }, "is_auto_delete_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables auto delete." } ] }, "auto_delete_days": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "The number of days before auto delete." } ] }, "is_auto_delete_expiration_modification_prevented": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Prevents users from modifying auto delete expiration." } ] }, "auto_delete_target": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "The selected option of types for applying auto delete." } ] }, "is_collaboration_expiration_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables collaboration expiration." } ] }, "collaboration_expiration_days": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "The number of days before collaboration expiration." } ] }, "is_collaboration_expiration_modification_prevented": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Prevents users from modifying collaboration expiration." } ] }, "is_collaboration_expiration_notification_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables collaboration expiration notification." } ] }, "collaboration_expiration_target": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "The selected option of types for applying collaboration expiration." } ] }, "trash_auto_clear_time": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "The time before items are permanently deleted from the trash in seconds." } ] }, "permanent_deletion_access": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "The selected option for who can delete items from the trash." } ] }, "permanent_deletion_allowlist_users": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "description": "The allowlist users for permanently deleting items from the trash." }, { "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/ListUser" } } } } ] } }, "title": "Enterprise configuration content and sharing", "x-box-resource-id": "enterprise_configuration_content_and_sharing_v2025.0", "x-box-tag": "enterprise_configurations" }, "EnterpriseConfigurationItem": { "description": "The basic data included in each enterprise configuration response object.", "type": "object", "properties": { "is_used": { "description": "Indicates whether a configuration is used for a given enterprise.", "type": "boolean", "example": true } }, "title": "Enterprise configuration item" }, "EnterpriseConfigurationItemBoolean": { "description": "An enterprise configuration item with a boolean type value.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "properties": { "value": { "description": "The value of the enterprise configuration as a boolean.", "type": "boolean", "example": true, "nullable": true } } } ], "title": "Enterprise configuration item with boolean value" }, "EnterpriseConfigurationItemInteger": { "description": "An enterprise configuration item with a integer type value.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "properties": { "value": { "description": "The value of the enterprise configuration as an integer.", "type": "integer", "example": 1234, "nullable": true } } } ], "title": "Enterprise configuration item with integer value" }, "EnterpriseConfigurationItemString": { "description": "An enterprise configuration item with a string type value.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "properties": { "value": { "description": "The value of the enterprise configuration as a string.", "type": "string", "example": "value of configuration", "nullable": true } } } ], "title": "Enterprise configuration item with string value" }, "EnterpriseConfigurationSecurity": { "description": "The enterprise configuration for the security category.", "type": "object", "properties": { "is_managed_user_signup_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if users are allowed to sign up on their own." } ] }, "is_managed_user_signup_notification_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if users must sign up with your corporate email." } ] }, "is_managed_user_signup_corporate_email_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "When enabled, admin are emailed when new users are added." } ] }, "is_new_user_notification_daily_digest_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Depends on `is_managed_user_signup_corporate_email_enabled`. A true value represents `In daily summary emails`. A false value represents `Immediately`." } ] }, "is_managed_user_email_change_disabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "When enabled, prevents users from changing their primary email address." } ] }, "is_multi_factor_auth_required": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if multi-factor authentication is required for all managed users." } ] }, "is_weak_password_prevention_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "When enabled, prevents common words / email address to be used in a password." } ] }, "is_password_leak_detection_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables exposed password detection." } ] }, "last_password_reset_at": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "properties": { "value": { "description": "When an enterprise password reset was last applied.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true } } } ] }, "is_password_request_notification_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "When enabled, admins are notified when users request a forget password email." } ] }, "is_password_change_notification_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "When enabled, admins are notified when users change passwords in Settings." } ] }, "is_strong_password_for_ext_collab_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Requires strong passwords for External Collaborators." } ] }, "is_managed_user_migration_disabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Disables users from being migrated in or out of the enterprise." } ] }, "join_link": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "Join url for self sign up. Depends on `is_managed_user_signup_enabled`. Applies if `join_url` is not used." } ] }, "join_url": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "Join url for self sign up. Depends on `is_managed_user_signup_enabled`. Applies if `join_link` is not used." } ] }, "failed_login_attempts_to_trigger_admin_notification": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "Number of failed login attempts before the primary admin is notified." } ] }, "password_min_length": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "Minimum number of characters required for passwords." } ] }, "password_min_uppercase_characters": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "Minimum number of upper case characters required in passwords." } ] }, "password_min_numeric_characters": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "Minimum number of numbers required in passwords." } ] }, "password_min_special_characters": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "Minimum number of symbols required in passwords." } ] }, "password_reset_frequency": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "Determines if users must reset their passwords every specified time period." } ] }, "previous_password_reuse_limit": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "Number of previous passwords users are prevented from using." } ] }, "session_duration": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "Value indicating time from the last activity a user can remain logged in without activity before being logged out." } ] }, "external_collab_multi_factor_auth_settings": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "description": "External Collaborators multi-factor authentication settings." }, { "properties": { "value": { "allOf": [ { "oneOf": [ { "$ref": "#/components/schemas/ExternalCollabSecuritySettings" }, { "title": "OpenAPI 3.0 null schema type", "description": "The definition for a null schema type in OpenAPI `3.0`.", "type": "object", "nullable": true, "additionalProperties": false } ] }, { "description": "External collab security settings." } ] } } } ] }, "keysafe": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "properties": { "value": { "allOf": [ { "oneOf": [ { "$ref": "#/components/schemas/KeysafeSettings" }, { "title": "OpenAPI 3.0 null schema type", "description": "The definition for a null schema type in OpenAPI `3.0`.", "type": "object", "nullable": true, "additionalProperties": false } ] }, { "description": "Keysafe settings." } ] } } } ] }, "is_custom_session_duration_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Enables custom session duration for select users." } ] }, "custom_session_duration_value": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "Value indicating duration users from specified groups can remain logged in without activity before being logged out." } ] }, "custom_session_duration_groups": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "description": "Groups for custom session duration." }, { "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/CustomSessionDurationGroupItem" } } } } ] }, "multi_factor_auth_type": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "Managed Users multi-factor authentication requirement method type." } ] }, "enforced_mfa_frequency": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "description": "Managed Users multi-factor authentication frequency. The default authentication frequency is set to 30 days, with authentication time calculated from the most recent successful MFA login." }, { "properties": { "value": { "type": "object", "properties": { "days": { "type": "integer", "nullable": true, "description": "Number of days before the user is required to authenticate again.", "example": 30 }, "hours": { "type": "integer", "nullable": true, "description": "Number of hours before the user is required to authenticate again.", "example": 24 } } } } } ] } }, "title": "Enterprise configuration security", "x-box-resource-id": "enterprise_configuration_security_v2025.0", "x-box-tag": "enterprise_configurations" }, "EnterpriseConfigurationShield": { "description": "The enterprise configuration for the shield category.", "type": "object", "properties": { "shield_rules": { "description": "The shield rules configuration for the enterprise.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldRuleItem" } } }, "title": "Enterprise configuration shield", "x-box-resource-id": "enterprise_configuration_shield_v2025.0", "x-box-tag": "enterprise_configurations" }, "EnterpriseConfigurationUserSettings": { "description": "The enterprise configuration for the user settings category.", "type": "object", "properties": { "enterprise_feature_settings": { "type": "array", "items": { "$ref": "#/components/schemas/EnterpriseFeatureSettingsItem" } }, "user_invites_expiration_time_frame": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "Determines the time frame for any unaccepted invitation to your Box enterprise account to expire." }, { "example": { "is_used": true, "value": "7 days" } } ] }, "is_username_change_restricted": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if users are restricted from changing their username in Account Settings." } ] }, "is_box_sync_restricted_for_new_users": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if Box Sync is restricted for new users." } ] }, "is_view_all_users_enabled_for_new_users": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if new users can see all managed users in their contacts when inviting collaborators." } ] }, "is_device_limit_exemption_enabled_for_new_users": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if new users are exempt from the maximum number of devices specified in the Device Protection settings." } ] }, "is_external_collaboration_restricted_for_new_users": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if new users will not be allowed to create folders that can have external collaborators." } ] }, "is_unlimited_storage_enabled_for_new_users": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if new users are given unlimited storage." } ] }, "new_user_default_storage_limit": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "Determines the default storage limit for new users. Does not apply if `is_unlimited_storage_enabled_for_new_users` is true." } ] }, "new_user_default_timezone": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "Determines the default timezone for new users." }, { "example": { "is_used": true, "value": "GMT-05:00 America\\/Chicago CDT" } } ] }, "new_user_default_language": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemString" }, { "description": "Determines the default language for new users." }, { "example": { "is_used": true, "value": "English (US)" } } ] }, "is_enterprise_sso_required": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Value indicating if SSO is required for all users." } ] }, "is_enterprise_sso_in_testing": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Value indicating if SSO is in testing mode for all users." } ] }, "is_sso_auto_add_groups_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if any new groups received for a user upon login through SSO but not present in the enterprise will be auto added to the enterprise." } ] }, "is_sso_auto_add_user_to_groups_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if a user will be added to enterprise groups received upon user login through SSO." } ] }, "is_sso_auto_remove_user_from_groups_enabled": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if a user will be removed from enterprise groups upon user login through SSO." } ] }, "user_tracking_codes": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "description": "Properties that are assigned as additional values to users, like employee ID or region." }, { "properties": { "value": { "type": "array", "items": { "$ref": "#/components/schemas/UserTrackingCode" } } } } ] }, "number_of_user_tracking_codes_remaining": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemInteger" }, { "description": "The remaining number of `user_tracking_codes` that can be created." } ] }, "is_instant_login_restricted": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItemBoolean" }, { "description": "Determines if users are restricted from granting (limited) access for Box Support for troubleshooting." } ] } }, "title": "Enterprise configuration user settings", "x-box-resource-id": "enterprise_configuration_user_settings_v2025.0", "x-box-tag": "enterprise_configurations" }, "EnterpriseFeatureSetting": { "description": "An enterprise feature setting.", "type": "object", "properties": { "id": { "description": "The identifier of the enterprise feature setting.", "type": "string", "example": "eyJlbnRlcnByaXNlSWQiOiIxMTExNDQyNzY3IiwiZmVhdHVyZUlkIjoiY2FudmFzIn0=", "nullable": true }, "feature": { "description": "The feature.", "type": "object", "properties": { "id": { "description": "The identifier of the feature.", "type": "string", "example": "canvas", "nullable": true } } }, "state": { "description": "The state of the feature.", "type": "string", "example": "enabled", "nullable": true }, "can_configure": { "description": "Whether the feature can be configured.", "type": "boolean", "example": true, "nullable": true }, "is_configured": { "description": "Whether the feature is configured.", "type": "boolean", "example": true, "nullable": true }, "allowlist": { "description": "Enterprise feature setting is enabled for only this set of users and groups.", "type": "array", "items": { "$ref": "#/components/schemas/UserOrGroupReference" }, "nullable": true }, "denylist": { "description": "Enterprise feature setting is enabled for everyone except this set of users and groups.", "type": "array", "items": { "$ref": "#/components/schemas/UserOrGroupReference" }, "nullable": true } }, "title": "Enterprise feature setting" }, "EnterpriseFeatureSettingsItem": { "description": "An enterprise feature settings item.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/EnterpriseConfigurationItem" }, { "description": "The enterprise feature settings." }, { "properties": { "value": { "$ref": "#/components/schemas/EnterpriseFeatureSetting" } } } ], "title": "Enterprise feature settings item" }, "EnterpriseReference": { "description": "A reference to an enterprise, used when nested within another resource.", "type": "object", "properties": { "id": { "description": "The unique identifier for this enterprise.", "type": "string", "example": "1910967" }, "type": { "description": "The value will always be `enterprise`.", "type": "string", "example": "enterprise", "enum": [ "enterprise" ], "nullable": false } }, "title": "Enterprise reference" }, "ExternalCollabSecuritySettings": { "description": "External collaboration security settings.", "type": "object", "properties": { "denylist_domains": { "description": "List of domains that are not allowed for external collaboration. Applies if state is `denylist`.", "type": "array", "items": { "type": "string", "example": "example.com" }, "example": [ "example.com" ] }, "denylist_emails": { "description": "List of email addresses that are not allowed for external collaboration. Applies if state is `denylist`.", "type": "array", "items": { "type": "string", "example": "spam@example.com" }, "example": [ "spam@example.com" ] }, "allowlist_domains": { "description": "List of domains that are allowed for external collaboration. Applies if state is `allowlist`.", "type": "array", "items": { "type": "string", "example": "example.com" }, "example": [ "example.com" ] }, "allowlist_emails": { "description": "List of email addresses that are allowed for external collaboration. Applies if state is `allowlist`.", "type": "array", "items": { "type": "string", "example": "mail@example.com" }, "example": [ "mail@example.com" ] }, "state": { "description": "The state of the external collaboration security settings. Possible values include `enabled`, `disabled`, `allowlist`, and `denylist`.", "type": "string", "example": "enabled", "nullable": true }, "scheduled_status": { "description": "The status of the scheduling to apply external collaboration security settings. Possible values include `in_progress`, `scheduled`, `completed`, `failed`, and `scheduled_immediate`.", "type": "string", "example": "inprogress", "nullable": true }, "scheduled_at": { "description": "Scheduled at.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00", "nullable": true }, "factor_type_settings": { "description": "Factor type for the external collaborators authentication. Possible values include `totp`, `any`, or `unknown`.", "type": "string", "example": "totp", "nullable": true } }, "title": "External collab security settings" }, "ExternalUserDeletionResult": { "description": "Result of a single external user deletion request.", "type": "object", "properties": { "user_id": { "description": "The ID of the external user.", "type": "string", "example": "12345" }, "status": { "description": "HTTP status code for a specific user's deletion request.", "type": "integer", "example": 202 }, "detail": { "description": "Deletion request status details. This property is only present when the deletion request is not successful.", "type": "string" } }, "required": [ "user_id", "status" ], "title": "External User Deletion Result" }, "ExternalUsersSubmitDeleteJobRequest": { "description": "Request to submit a job to delete external users from the current enterprise.", "type": "object", "properties": { "external_users": { "description": "List of external users to delete.", "type": "array", "items": { "$ref": "#/components/schemas/UserReference" } } }, "required": [ "external_users" ], "title": "External Users Submit Delete Job Request" }, "ExternalUsersSubmitDeleteJobResponse": { "description": "Multi-status response containing the result for each external user deletion request.", "type": "object", "properties": { "entries": { "description": "Array of results of each external user deletion request.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalUserDeletionResult" } } }, "required": [ "entries" ], "title": "External Users Submit Delete Job Response", "x-box-resource-id": "external_users_submit_delete_job_response_v2025.0", "x-box-tag": "external_users" }, "FileReference": { "description": "File reference.", "type": "object", "properties": { "type": { "description": "The value will always be `file`.", "type": "string", "example": "file", "enum": [ "file" ], "nullable": false }, "id": { "description": "ID of the object.", "type": "string", "example": "42037322", "nullable": false } }, "required": [ "type", "id" ], "title": "File reference" }, "FileVersion--Base": { "description": "The bare basic representation of a file version, the minimal amount of fields returned when using the `fields` query parameter.", "type": "object", "properties": { "id": { "description": "The unique identifier that represent a file version.", "type": "string", "example": "12345", "nullable": false }, "type": { "description": "The value will always be `file_version`.", "type": "string", "example": "file_version", "enum": [ "file_version" ], "nullable": false } }, "required": [ "id", "type" ], "title": "File version (Base)" }, "FolderReference": { "description": "Folder reference.", "type": "object", "properties": { "type": { "description": "The value will always be `folder`.", "type": "string", "example": "folder", "enum": [ "folder" ], "nullable": false }, "id": { "description": "ID of the folder.", "type": "string", "example": "42037322" } }, "required": [ "type", "id" ], "title": "Folder reference" }, "Group--Base": { "description": "A base representation of a group.", "type": "object", "properties": { "id": { "description": "The unique identifier for this object.", "type": "string", "example": "11446498" }, "type": { "description": "The value will always be `group`.", "type": "string", "example": "group", "enum": [ "group" ] } }, "required": [ "id", "type" ], "title": "Group (Base)" }, "Group--Mini": { "description": "Mini representation of a group, including id and name of group.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Group--Base" }, { "properties": { "name": { "description": "The name of the group.", "type": "string", "example": "Support" }, "group_type": { "description": "The type of the group.", "type": "string", "example": "managed_group", "enum": [ "managed_group", "all_users_group" ] } } } ], "title": "Group (Mini)" }, "Hub": { "description": "A standard representation of a Box Hub, as returned from any Box Hubs API endpoints by default.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/Hub--Base" }, { "properties": { "title": { "description": "The title given to the Box Hub.", "type": "string", "example": "Contracts" }, "description": { "description": "The description of the Box Hub. First 200 characters are returned.", "type": "string", "example": "All the contracts for the company." }, "created_at": { "description": "The date and time when the folder was created. This value may be `null` for some folders such as the root folder or the trash folder.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43Z" }, "updated_at": { "description": "The date and time when the Box Hub was last updated.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43Z" }, "created_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "The user who created this Box Hub." } ] }, "updated_by": { "allOf": [ { "$ref": "#/components/schemas/User--Mini" }, { "description": "The user who last modified this Box Hub." } ] }, "view_count": { "description": "The number of views for the Box Hub.", "type": "integer", "format": "int32", "example": 506 }, "is_ai_enabled": { "description": "Indicates if AI features are enabled for the Box Hub.", "type": "boolean", "example": true }, "is_collaboration_restricted_to_enterprise": { "description": "Indicates if collaboration is restricted to the enterprise.", "type": "boolean", "example": true }, "can_non_owners_invite": { "description": "Indicates if non-owners can invite others to the Box Hub.", "type": "boolean", "example": true }, "can_shared_link_be_created": { "description": "Indicates if a shared link can be created for the Box Hub.", "type": "boolean", "example": true }, "can_public_shared_link_be_created": { "description": "Indicates if a public shared link can be created for the Box Hub.", "type": "boolean", "example": true }, "copy_hub_access": { "description": "Specifies who is allowed to copy the Box Hub.\n\n- `all` - Any user with access to the Hub can copy it.\n- `company` - Only users within the same enterprise as the Hub can copy it.\n- `none` - No one can copy the Hub.", "type": "string", "example": "company", "enum": [ "all", "company", "none" ] } } } ], "title": "Box Hub", "x-box-resource-id": "hub_v2025.0", "x-box-tag": "hubs", "x-box-variant": "standard" }, "Hub--Base": { "description": "The bare basic representation of a Box Hub.", "type": "object", "properties": { "id": { "description": "The unique identifier that represent a Box Hub.\n\nThe ID for any Box Hub can be determined by visiting a Box Hub in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/hubs/123` the `hub_id` is `123`.", "type": "string", "example": "12345" }, "type": { "description": "The value will always be `hubs`.", "type": "string", "example": "hubs", "enum": [ "hubs" ] } }, "required": [ "id", "type" ], "title": "Box Hub (Base)", "x-box-resource-id": "hub_v2025.0--base", "x-box-tag": "hubs", "x-box-variant": "base", "x-box-variants": [ "base", "standard" ] }, "HubAccessGrantee": { "description": "The user or group that is granted access.", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/HubCollaborationUser" }, { "$ref": "#/components/schemas/Group--Mini" } ], "title": "Box Hub Accessible By" }, "HubCalloutBoxTextBlock": { "description": "A callout box block in the Box Hub Document.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HubDocumentBlock" }, { "properties": { "type": { "description": "The type of this block. The value is always `callout_box`.", "type": "string", "example": "callout_box", "enum": [ "callout_box" ] }, "fragment": { "description": "Text content of the block. Includes rich text formatting.", "type": "string", "example": "This is the callout box" } } } ], "required": [ "id", "type", "fragment" ], "title": "Box Hub Callout Box Text Block", "x-box-resource-id": "hub_callout_box_text_block_v2025.0", "x-box-tag": "hub_document" }, "HubCollaboration": { "description": "A Box Hub collaboration object grants a user or group access to a Box Hub with permissions defined by a specific role.", "type": "object", "properties": { "id": { "description": "The unique identifier for this collaboration.", "type": "string", "example": "12345678" }, "type": { "description": "The value will always be `hub_collaboration`.", "type": "string", "example": "hub_collaboration", "enum": [ "hub_collaboration" ] }, "hub": { "$ref": "#/components/schemas/Hub--Base" }, "accessible_by": { "$ref": "#/components/schemas/HubAccessGrantee" }, "role": { "description": "The level of access granted to a Box Hub. Possible values are `editor`, `viewer`, and `co-owner`.", "type": "string", "example": "editor" }, "status": { "description": "The status of the collaboration invitation. If the status is `pending`, `login` and `name` return an empty string.", "type": "string", "example": "accepted", "enum": [ "accepted", "pending", "rejected" ] }, "acceptance_requirements_status": { "type": "object", "properties": { "terms_of_service_requirement": { "type": "object", "properties": { "is_accepted": { "description": "Whether or not the terms of service have been accepted. The field is `null` when there is no terms of service required.", "type": "boolean", "example": true, "nullable": true }, "terms_of_service": { "allOf": [ { "$ref": "#/components/schemas/TermsOfService--Base" }, { "description": "The terms of service that must be accepted before the collaboration can be accepted. The field is `null` when there is no terms of service required." } ] } } }, "strong_password_requirement": { "type": "object", "properties": { "enterprise_has_strong_password_required_for_external_users": { "description": "Whether or not the enterprise that owns the content requires a strong password to collaborate on the content, or enforces an exposed password detection for the external collaborators.", "type": "boolean", "example": true }, "user_has_strong_password": { "description": "Whether or not the user has a strong and not exposed password set for their account. The field is `null` when a strong password is not required.", "type": "boolean", "example": true, "nullable": true } } }, "two_factor_authentication_requirement": { "type": "object", "properties": { "enterprise_has_two_factor_auth_enabled": { "description": "Whether or not the enterprise that owns the content requires two-factor authentication to be enabled in order to collaborate on the content.", "type": "boolean", "example": true }, "user_has_two_factor_authentication_enabled": { "description": "Whether or not the user has two-factor authentication enabled. The field is `null` when two-factor authentication is not required.", "type": "boolean", "example": true, "nullable": true } } } } } }, "required": [ "id", "type" ], "title": "Box Hub Collaboration", "x-box-resource-id": "hub_collaboration_v2025.0", "x-box-tag": "hub_collaborations" }, "HubCollaborationCreateRequest": { "description": "Request body for creating a new Box Hub collaboration.", "type": "object", "properties": { "hub": { "description": "Box Hubs reference.", "type": "object", "properties": { "type": { "description": "The value will always be `hubs`.", "type": "string", "example": "hubs", "enum": [ "hubs" ] }, "id": { "description": "ID of the object.", "type": "string", "example": "42037322" } }, "required": [ "type", "id" ], "title": "Box Hubs reference" }, "accessible_by": { "description": "The user or group who gets access to the item.", "type": "object", "properties": { "type": { "description": "The type of collaborator to invite. Possible values are `user` or `group`.", "type": "string", "example": "user" }, "id": { "description": "The ID of the user or group.\n\nAlternatively, use `login` to specify a user by email address.", "type": "string", "example": "23522323" }, "login": { "description": "The email address of the user who gets access to the item.\n\nAlternatively, use `id` to specify a user by user ID.", "type": "string", "example": "john@example.com" } }, "required": [ "type" ] }, "role": { "description": "The level of access granted to a Box Hub. Possible values are `editor`, `viewer`, and `co-owner`.", "type": "string", "example": "editor" } }, "required": [ "hub", "accessible_by", "role" ], "title": "Box Hub Collaboration Create Request" }, "HubCollaborations": { "description": "A list of Box Hub collaborations.", "type": "object", "allOf": [ { "properties": { "entries": { "description": "A list of Box Hub collaborations.", "type": "array", "items": { "$ref": "#/components/schemas/HubCollaboration" } } } }, { "type": "object", "description": "The part of an API response that describes marker based pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "The marker for the start of the next page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true } } } ], "title": "Box Hub Collaborations", "x-box-resource-id": "hub_collaborations_v2025.0", "x-box-tag": "hub_collaborations" }, "HubCollaborationUpdateRequest": { "description": "Request body for updating an existing Box Hub collaboration.", "type": "object", "properties": { "role": { "description": "The level of access granted to a Box Hub. Possible values are `editor`, `viewer`, and `co-owner`.", "type": "string", "example": "editor" } }, "title": "Box Hub Collaboration Update Request" }, "HubCollaborationUser": { "description": "A mini representation of a user, can be returned only when the status is `pending`.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "properties": { "name": { "description": "The display name of this user. If the collaboration status is `pending`, an empty string is returned.", "type": "string", "example": "Aaron Levie", "maxLength": 50, "nullable": false }, "login": { "description": "The primary email address of this user. If the collaboration status is `pending`, an empty string is returned.", "type": "string", "format": "email", "example": "ceo@example.com", "nullable": false } } } ], "title": "Box Hub Collaboration User" }, "HubCopyRequest": { "description": "Request schema for copying a Box Hub.", "type": "object", "properties": { "title": { "description": "Title of the Box Hub. It cannot be empty and should be less than 50 characters.", "type": "string", "example": "Hub Title", "maxLength": 50 }, "description": { "description": "Description of the Box Hub.", "type": "string", "example": "This is a description of the Box Hub." }, "include_items": { "description": "If true, the items which the user has Editor or Owner access to in the original Box Hub will be copied to the new Box Hub. Defaults to false.", "type": "boolean", "example": true } }, "title": "Box Hub Copy Request" }, "HubCreateRequest": { "description": "Request schema for creating a new Box Hub.", "type": "object", "properties": { "title": { "description": "Title of the Box Hub. It cannot be empty and should be less than 50 characters.", "type": "string", "example": "Hub Title", "maxLength": 50 }, "description": { "description": "Description of the Box Hub.", "type": "string", "example": "This is a description of the Box Hub." } }, "required": [ "title" ], "title": "Box Hub Create Request" }, "HubDividerBlock": { "description": "A divider block in the Box Hub Document.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HubDocumentBlock" }, { "properties": { "type": { "description": "The type of this block. The value is always `divider`.", "type": "string", "example": "divider", "enum": [ "divider" ] } } } ], "required": [ "id", "type" ], "title": "Box Hub Divider Block", "x-box-resource-id": "hub_divider_block_v2025.0", "x-box-tag": "hub_document" }, "HubDocumentBlock": { "description": "Base block in the Box Hub Document.", "type": "object", "properties": { "id": { "description": "The unique identifier for this block.", "type": "string", "example": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd" }, "parent_id": { "description": "The unique identifier of the parent block. Null for direct children of the page.", "type": "string", "example": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f", "nullable": true } }, "required": [ "id" ], "title": "Box Hub Document Block", "x-box-tag": "hub_document" }, "HubDocumentBlockEntry": { "description": "A single block in a Hub Document Blocks list. Text-bearing block types (`paragraph`, `section_title`, `callout_box`) include a `fragment` property with rich text content.", "oneOf": [ { "$ref": "#/components/schemas/HubParagraphTextBlock" }, { "$ref": "#/components/schemas/HubSectionTitleTextBlock" }, { "$ref": "#/components/schemas/HubCalloutBoxTextBlock" }, { "$ref": "#/components/schemas/HubItemListBlock" }, { "$ref": "#/components/schemas/HubDividerBlock" } ], "title": "Box Hub Document Block Entry" }, "HubDocumentBlocks": { "description": "A list of Hub Document blocks.", "type": "object", "allOf": [ { "type": "object", "required": [ "entries", "type" ], "properties": { "entries": { "description": "Ordered list of blocks.", "type": "array", "items": { "$ref": "#/components/schemas/HubDocumentBlockEntry" } }, "type": { "description": "The value will always be `document_blocks`.", "type": "string", "example": "document_blocks", "enum": [ "document_blocks" ] } } }, { "type": "object", "description": "The part of an API response that describes marker based pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "The marker for the start of the next page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true } } } ], "title": "Box Hub Document Blocks", "x-box-resource-id": "hub_document_blocks_v2025.0", "x-box-tag": "hub_document" }, "HubDocumentPage": { "description": "A Page in the Box Hub Document.", "type": "object", "properties": { "id": { "description": "The unique identifier for this page.", "type": "string", "example": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f" }, "type": { "description": "The type of this resource. The value is always `page`.", "type": "string", "example": "page" }, "parent_id": { "description": "The unique identifier of the parent page. Null for root-level pages.", "type": "string", "example": "d97f7c26-0d9b-42a1-a00d-6e6db9619e0f", "nullable": true }, "title_fragment": { "description": "The title text of the page. Includes rich text formatting.", "type": "string", "example": "This is the home page title" } }, "required": [ "id", "type", "title_fragment" ], "title": "Box Hub Document Page", "x-box-resource-id": "hub_document_page_v2025.0", "x-box-tag": "hub_document" }, "HubDocumentPages": { "description": "A list of Hub Document Pages.", "type": "object", "allOf": [ { "type": "object", "required": [ "entries", "type" ], "properties": { "entries": { "description": "Ordered list of pages.", "type": "array", "items": { "$ref": "#/components/schemas/HubDocumentPage" } }, "type": { "description": "The value will always be `document_pages`.", "type": "string", "example": "document_pages", "enum": [ "document_pages" ] } } }, { "type": "object", "description": "The part of an API response that describes marker based pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "The marker for the start of the next page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true } } } ], "title": "Box Hub Document Pages", "x-box-resource-id": "hub_document_pages_v2025.0", "x-box-tag": "hub_document" }, "HubItem": { "description": "A Box Hub Item is a Box Item that is referenced in a Box Hub.", "type": "object", "properties": { "id": { "description": "The unique identifier for this item.", "type": "string", "example": "12345678" }, "type": { "description": "The type of the item.", "type": "string", "example": "file", "enum": [ "file", "folder", "web_link" ] }, "name": { "description": "The name of the item.", "type": "string", "example": "My File" } }, "required": [ "id", "type", "name" ], "title": "Box Hub Item", "x-box-resource-id": "hub_item_v2025.0", "x-box-tag": "hub_items" }, "HubItemListBlock": { "description": "An item list block in the Box Hub Document.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HubDocumentBlock" }, { "properties": { "type": { "description": "The type of this block. The value is always `item_list`.", "type": "string", "example": "item_list", "enum": [ "item_list" ] } } } ], "required": [ "id", "type" ], "title": "Box Hub Item List Block", "x-box-resource-id": "hub_item_list_block_v2025.0", "x-box-tag": "hub_document" }, "HubItemOperation": { "description": "An operation to perform on a Box Hub item.", "type": "object", "properties": { "action": { "description": "The action to perform on a Box Hub item.", "type": "string", "example": "add", "enum": [ "add", "remove" ], "nullable": false, "title": "Box Hub Action" }, "item": { "$ref": "#/components/schemas/HubItemReference" }, "parent_id": { "description": "The ID of the parent block to add the item to. Must be an Item List block. If not provided, the item will be added to the first page's first Item List block.", "type": "string", "example": "c9588f08-22d7-4d17-8ca9-f1e61c98c0bd" } }, "required": [ "action", "item" ], "title": "Box Hub Item Operation" }, "HubItemOperationResult": { "description": "Result of a Box Hub item operation.", "type": "object", "properties": { "action": { "description": "The action performed on the item.", "type": "string", "example": "add" }, "item": { "$ref": "#/components/schemas/HubItemReference" }, "parent_id": { "description": "The ID of the parent block the item was added to.", "type": "string", "example": "721d97d7-ac8a-4e5e-adb6-ef11af4e6d9e" }, "status": { "description": "The HTTP status code of the operation.", "type": "integer", "example": 200 }, "error": { "description": "Error message if the operation failed.", "type": "string", "example": "Item not found" } }, "title": "Box Hub Item Operation Result" }, "HubItemReference": { "description": "Reference to an item that can be added to a Box Hub.", "oneOf": [ { "$ref": "#/components/schemas/FileReference" }, { "$ref": "#/components/schemas/FolderReference" }, { "$ref": "#/components/schemas/WeblinkReference" } ], "title": "Box Hub Item Reference" }, "HubItems": { "description": "A list of Box Hub items.", "type": "object", "allOf": [ { "properties": { "entries": { "description": "A list of Box Hub items.", "type": "array", "items": { "$ref": "#/components/schemas/HubItem" } } } }, { "type": "object", "description": "The part of an API response that describes marker based pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "The marker for the start of the next page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true } } } ], "title": "Box Hub Items", "x-box-resource-id": "hub_items_v2025.0", "x-box-tag": "hub_items" }, "HubItemsManageRequest": { "description": "Request schema for managing Box Hub items.", "type": "object", "properties": { "operations": { "description": "List of operations to perform on Box Hub items.", "type": "array", "items": { "$ref": "#/components/schemas/HubItemOperation" } } }, "title": "Box Hub Items Manage Request" }, "HubItemsManageResponse": { "description": "Response schema for the status of Box Hub items management operations.", "type": "object", "properties": { "operations": { "description": "List of operations performed on Box Hub items.", "type": "array", "items": { "$ref": "#/components/schemas/HubItemOperationResult" } } }, "required": [ "operations" ], "title": "Box Hub Items Manage Response", "x-box-resource-id": "hub_items_manage_response_v2025.0", "x-box-tag": "hub_items" }, "HubParagraphTextBlock": { "description": "A paragraph block in the Box Hub Document.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HubDocumentBlock" }, { "properties": { "type": { "description": "The type of this block. The value is always `paragraph`.", "type": "string", "example": "paragraph", "enum": [ "paragraph" ] }, "fragment": { "description": "Text content of the block. Includes rich text formatting.", "type": "string", "example": "This is the paragraph" } } } ], "required": [ "id", "type", "fragment" ], "title": "Box Hub Paragraph Text Block", "x-box-resource-id": "hub_paragraph_text_block_v2025.0", "x-box-tag": "hub_document" }, "Hubs": { "description": "A paginated list of hubs.", "type": "object", "allOf": [ { "properties": { "entries": { "description": "A list of hubs.", "type": "array", "items": { "$ref": "#/components/schemas/Hub" } } } }, { "type": "object", "description": "The part of an API response that describes marker based pagination.", "properties": { "limit": { "description": "The limit that was used for these entries. This will be the same as the `limit` query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.", "type": "integer", "format": "int64", "example": 1000 }, "next_marker": { "description": "The marker for the start of the next page of results.", "type": "string", "example": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii", "nullable": true } } } ], "title": "Box Hubs", "x-box-resource-id": "hubs_v2025.0", "x-box-tag": "hubs" }, "HubSectionTitleTextBlock": { "description": "A section title block in the Box Hub Document.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/HubDocumentBlock" }, { "properties": { "type": { "description": "The type of this block. The value is always `section_title`.", "type": "string", "example": "section_title", "enum": [ "section_title" ] }, "fragment": { "description": "Text content of the block. Includes rich text formatting.", "type": "string", "example": "This is the section title" } } } ], "required": [ "id", "type", "fragment" ], "title": "Box Hub Section Title Text Block", "x-box-resource-id": "hub_section_title_text_block_v2025.0", "x-box-tag": "hub_document" }, "HubUpdateRequest": { "description": "Request schema for updating an existing Box Hub.", "type": "object", "properties": { "title": { "description": "Title of the Box Hub. It cannot be empty and should be less than 50 characters.", "type": "string", "example": "Hub Title", "maxLength": 50 }, "description": { "description": "Description of the Box Hub.", "type": "string", "example": "This is a description of the Box Hub." }, "is_ai_enabled": { "description": "Indicates if AI features are enabled for the Box Hub.", "type": "boolean", "example": true }, "is_collaboration_restricted_to_enterprise": { "description": "Indicates if collaboration is restricted to the enterprise.", "type": "boolean", "example": true }, "can_non_owners_invite": { "description": "Indicates if non-owners can invite others to the Box Hub.", "type": "boolean", "example": true }, "can_shared_link_be_created": { "description": "Indicates if a shared link can be created for the Box Hub.", "type": "boolean", "example": true }, "can_public_shared_link_be_created": { "description": "Indicates if a public shared link can be created for the Box Hub.", "type": "boolean", "example": true }, "copy_hub_access": { "description": "Specifies who is allowed to copy the Box Hub.\n\n- `all` - Any user with access to the Hub can copy it.\n- `company` - Only users within the same enterprise as the Hub can copy it.\n- `none` - No one can copy the Hub.", "type": "string", "example": "company", "enum": [ "all", "company", "none" ] } }, "title": "Box Hub Update Request" }, "KeysafeSettings": { "description": "The KeySafe settings.", "type": "object", "properties": { "keysafe_enabled": { "description": "Whether KeySafe addon is enabled for the enterprise.", "type": "boolean", "example": true }, "cloud_provider": { "description": "The cloud provider.", "type": "string", "example": "", "nullable": true }, "key_id": { "description": "The key ID.", "type": "string", "example": "1234", "nullable": true }, "account_id": { "description": "The account ID.", "type": "string", "example": "1234", "nullable": true }, "location_id": { "description": "The location ID.", "type": "string", "example": "1234", "nullable": true }, "project_id": { "description": "The project ID.", "type": "string", "example": "1234", "nullable": true }, "keyring_id": { "description": "The key ring ID.", "type": "string", "example": "1234", "nullable": true } }, "title": "KeySafe settings" }, "ListUser": { "description": "A user in allowlist or denylist.", "type": "object", "properties": { "id": { "description": "The ID of the user.", "type": "integer", "example": 1234, "nullable": true }, "name": { "description": "The name of the user.", "type": "string", "example": "John Doe", "nullable": true }, "email": { "description": "The email of the user.", "type": "string", "example": "johndoe@box.com", "nullable": true } }, "title": "List user" }, "SharedLinkPermissions": { "description": "The shared link permissions for the enterprise.", "type": "object", "properties": { "shared_links_option": { "description": "The selected option for shared links permissions.", "type": "string", "example": "settings_shared_link_preview", "nullable": true }, "default_shared_link_type": { "description": "The default shared link type.", "type": "string", "example": "settings_default_shared_link_preview", "nullable": true }, "notes_shared_link_option": { "description": "The selected option for notes shared links permissions.", "type": "string", "example": "settings_notes_option_to_edit", "nullable": true }, "default_notes_shared_link_type": { "description": "The default notes shared link type.", "type": "string", "example": "settings_default_notes_shared_link_to_edit", "nullable": true } }, "title": "Shared link permissions" }, "ShieldList": { "description": "A standard representation of a Shield List.", "type": "object", "properties": { "id": { "description": "Unique identifier for the shield list.", "type": "string", "example": "90fb0e17-c332-40ed-b4f9-fa8908fbbb24" }, "type": { "description": "Type of the object.", "type": "string", "example": "shield_list" }, "name": { "description": "Name of the shield list.", "type": "string", "example": "Shield List Name" }, "enterprise": { "allOf": [ { "$ref": "#/components/schemas/EnterpriseReference" }, { "description": "Enterprise for which this list belongs to." } ] }, "description": { "description": "Description of Shield List.", "type": "string", "example": "A list of things that are shielded" }, "created_at": { "description": "ISO date time string when this shield list object was created.", "type": "string", "format": "date-time", "example": "2025-01-13T15:31:01.896Z" }, "updated_at": { "description": "ISO date time string when this shield list object was updated.", "type": "string", "format": "date-time", "example": "2025-01-13T15:31:01.896Z" }, "content": { "allOf": [ { "$ref": "#/components/schemas/ShieldListContent" }, { "description": "Specifies the type of elements in this Shield List and includes the elements themselves." } ] } }, "required": [ "id", "type", "name", "content", "enterprise", "created_at", "updated_at" ], "title": "Shield List", "x-box-resource-id": "shield_list_v2025.0", "x-box-tag": "shield_lists" }, "ShieldList--Mini": { "description": "A mini representation of a Shield List.", "type": "object", "properties": { "id": { "description": "Unique global identifier for this list.", "type": "string", "example": "12345678-1234-1234-1234-123456789012" }, "type": { "description": "The type of object.", "type": "string", "example": "shield_list", "enum": [ "shield_list" ] }, "name": { "description": "Name of Shield List.", "type": "string", "example": "My Shield List" }, "content": { "properties": { "type": { "description": "The type of content in the shield list.", "type": "string", "example": "country_code" } }, "type": "object" } }, "required": [ "id", "type", "name", "content" ], "title": "Shield List (Mini)", "x-box-resource-id": "shield_list_v2025.0--mini", "x-box-tag": "shield_lists" }, "ShieldListContent": { "description": "Representation of content of a Shield List.", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ShieldListContentCountry" }, { "$ref": "#/components/schemas/ShieldListContentDomain" }, { "$ref": "#/components/schemas/ShieldListContentEmail" }, { "$ref": "#/components/schemas/ShieldListContentIp" }, { "$ref": "#/components/schemas/ShieldListContentIntegration" } ], "title": "Shield List Content" }, "ShieldListContentCountry": { "description": "Representation of content of a Shield List that contains countries data.", "type": "object", "properties": { "type": { "description": "The type of content in the shield list.", "type": "string", "example": "country", "enum": [ "country" ] }, "country_codes": { "description": "List of country codes values.", "type": "array", "items": { "type": "string" }, "example": [ "US", "PL" ], "maximum": 1000, "minimum": 1, "uniqueItems": true } }, "required": [ "type", "country_codes" ], "title": "Shield List Content (Country)", "x-box-resource-id": "shield_list_content__country_v2025.0", "x-box-tag": "shield_lists" }, "ShieldListContentDomain": { "description": "Representation of content of a Shield List that contains domains data.", "type": "object", "properties": { "type": { "description": "The type of content in the shield list.", "type": "string", "example": "domain", "enum": [ "domain" ] }, "domains": { "description": "List of domain.", "type": "array", "items": { "type": "string" }, "example": [ "box.com", "example.com" ], "maximum": 100000, "minimum": 1, "uniqueItems": true } }, "required": [ "type", "domains" ], "title": "Shield List Content (Domain)", "x-box-resource-id": "shield_list_content__domains_v2025.0", "x-box-tag": "shield_lists" }, "ShieldListContentEmail": { "description": "Representation of content of a Shield List that contains email addresses data.", "type": "object", "properties": { "type": { "description": "The type of content in the shield list.", "type": "string", "example": "email", "enum": [ "email" ] }, "email_addresses": { "description": "List of emails.", "type": "array", "items": { "type": "string" }, "example": [ "example1@box.com", "example2@gmail.com" ], "maximum": 100000, "minimum": 1, "uniqueItems": true } }, "required": [ "type", "email_addresses" ], "title": "Shield List Content (Email)", "x-box-resource-id": "shield_list_content__email_v2025.0", "x-box-tag": "shield_lists" }, "ShieldListContentIntegration": { "description": "Representation of content of a Shield List that contains integrations data.", "type": "object", "properties": { "type": { "description": "The type of content in the shield list.", "type": "string", "example": "integration", "enum": [ "integration" ] }, "integrations": { "description": "List of integration.", "type": "array", "items": { "type": "object", "properties": { "id": { "description": "The ID of the integration.", "type": "string", "example": "505e40b5-5d04-446a-9268-72a0ccc13669" } } }, "minimum": 1, "uniqueItems": true } }, "required": [ "type", "integrations" ], "title": "Shield List Content (Integration)", "x-box-resource-id": "shield_list_content__integration_v2025.0", "x-box-tag": "shield_lists" }, "ShieldListContentIp": { "description": "Representation of content of a Shield List that contains ip addresses data.", "type": "object", "properties": { "type": { "description": "The type of content in the shield list.", "type": "string", "example": "ip", "enum": [ "ip" ] }, "ip_addresses": { "description": "List of ip addresses and CIDRs.", "type": "array", "items": { "type": "string" }, "example": [ "127.0.0.1", "80.12.12.12/24" ], "maximum": 100000, "minimum": 1, "uniqueItems": true } }, "required": [ "type", "ip_addresses" ], "title": "Shield List Content (IP)", "x-box-resource-id": "shield_list_content__ip_v2025.0", "x-box-tag": "shield_lists" }, "ShieldListContentRequest": { "description": "Representation of content of a Shield List.", "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ShieldListContentCountry" }, { "$ref": "#/components/schemas/ShieldListContentDomain" }, { "$ref": "#/components/schemas/ShieldListContentEmail" }, { "$ref": "#/components/schemas/ShieldListContentIp" } ], "title": "Shield List Content for requests" }, "ShieldLists": { "description": "List of Shield List objects.", "type": "object", "allOf": [ { "properties": { "entries": { "description": "A list of shield list objects.", "type": "array", "items": { "$ref": "#/components/schemas/ShieldList--Mini" } } } } ], "title": "List of Shield Lists", "x-box-resource-id": "shield_lists_v2025.0", "x-box-tag": "shield_lists" }, "ShieldListsCreate": { "description": "The schema for Shield List create request.", "type": "object", "properties": { "name": { "description": "The name of the shield list.", "type": "string", "example": "My Shield List" }, "description": { "description": "Optional description of Shield List.", "type": "string", "example": "A list of things that are shielded" }, "content": { "allOf": [ { "$ref": "#/components/schemas/ShieldListContentRequest" }, { "description": "Specifies the type of elements in this Shield List and includes the elements themselves. It is not possible to update Integration Shield Lists by Public API." } ] } }, "required": [ "name", "content" ], "title": "Create Shield List create request", "x-box-tag": "shield_lists" }, "ShieldListsUpdate": { "description": "The schema for Shield List update request.", "type": "object", "properties": { "name": { "description": "The name of the shield list.", "type": "string", "example": "My Shield List" }, "description": { "description": "Optional description of Shield List.", "type": "string", "example": "A list of things that are shielded" }, "content": { "allOf": [ { "$ref": "#/components/schemas/ShieldListContentRequest" }, { "description": "Specifies the type of elements in this Shield List and includes the elements themselves. It is not possible to update Integration Shield Lists by Public API." } ] } }, "required": [ "name", "content" ], "title": "Create Shield List update request", "x-box-tag": "shield_lists" }, "ShieldRuleItem": { "description": "A Shield rule item.", "type": "object", "properties": { "id": { "description": "The identifier of the shield rule.", "type": "string", "example": "1234567890" }, "type": { "description": "The value will always be `shield_rule`.", "type": "string", "example": "shield_rule", "enum": [ "shield_rule" ] }, "rule_category": { "description": "The category of the shield rule.", "type": "string", "example": "Malicious Content" }, "name": { "description": "The name of the shield rule.", "type": "string", "example": "Block malicious files" }, "description": { "description": "The description of the shield rule.", "type": "string", "example": "Blocks files identified as malicious content" }, "priority": { "description": "The priority level of the shield rule.", "type": "string", "example": "high", "enum": [ "informational", "low", "medium", "high", "critical" ] }, "created_at": { "description": "The date and time when the shield rule was created.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" }, "modified_at": { "description": "The date and time when the shield rule was last modified.", "type": "string", "format": "date-time", "example": "2012-12-12T10:53:43-08:00" } }, "title": "Shield rule item" }, "TermsOfService--Base": { "description": "The root-level record that is supposed to represent a single Terms of Service.", "type": "object", "properties": { "id": { "description": "The unique identifier for this terms of service.", "type": "string", "example": "11446498" }, "type": { "description": "The value will always be `terms_of_service`.", "type": "string", "example": "terms_of_service", "enum": [ "terms_of_service" ] } }, "required": [ "id", "type" ], "title": "Terms of service (Base)" }, "User--Base": { "description": "A mini representation of a user, used when nested within another resource.", "type": "object", "properties": { "id": { "description": "The unique identifier for this user.", "type": "string", "example": "11446498" }, "type": { "description": "The value will always be `user`.", "type": "string", "example": "user", "enum": [ "user" ], "nullable": false } }, "required": [ "type", "id" ], "title": "User (Base)" }, "User--Mini": { "description": "A mini representation of a user, as can be returned when nested within other resources.", "type": "object", "allOf": [ { "$ref": "#/components/schemas/User--Base" }, { "properties": { "name": { "description": "The display name of this user.", "type": "string", "example": "Aaron Levie", "maxLength": 50 }, "login": { "description": "The primary email address of this user.", "type": "string", "format": "email", "example": "ceo@example.com" } } } ], "title": "User (Mini)" }, "UserOrGroupReference": { "description": "A reference to a user or group.", "type": "object", "properties": { "type": { "description": "The type `user` or `group`.", "type": "string", "example": "user", "enum": [ "user", "group" ] }, "id": { "description": "The identifier of the user or group.", "type": "string", "example": "12345" } }, "title": "User or Group Reference" }, "UserReference": { "description": "User reference.", "type": "object", "properties": { "type": { "description": "The value is always `user`.", "type": "string", "example": "user", "enum": [ "user" ] }, "id": { "description": "The unique identifier for the user.", "type": "string", "example": "12345" } }, "required": [ "type", "id" ], "title": "User reference" }, "UserTrackingCode": { "description": "A user tracking code.", "type": "object", "properties": { "id": { "description": "The ID of the user tracking code.", "type": "integer", "format": "int64", "example": 1234, "nullable": true }, "name": { "description": "The name of the user tracking code.", "type": "string", "example": "Employee ID", "nullable": true } }, "title": "User tracking code" }, "WeblinkReference": { "description": "Web link reference.", "type": "object", "properties": { "type": { "description": "The value will always be `web_link`.", "type": "string", "example": "web_link", "enum": [ "web_link" ], "nullable": false }, "id": { "description": "ID of the web link.", "type": "string", "example": "42037322", "nullable": false } }, "required": [ "type", "id" ], "title": "Web link reference" } }, "securitySchemes": { "OAuth2Security": { "type": "oauth2", "description": "The access token received from the authorization server in the OAuth 2.0 flow.", "flows": { "authorizationCode": { "authorizationUrl": "https://account.box.com/api/oauth2/authorize", "tokenUrl": "https://api.box.com/oauth2/token", "scopes": { "root_readonly": "Read all files and folders stored in Box", "root_readwrite": "Read and write all files and folders stored in Box", "manage_app_users": "Provision and manage app users", "manage_managed_users": "Provision and manage managed users", "manage_groups": "Manage an enterprise's groups", "manage_webhook": "Create webhooks programmatically through the API", "manage_enterprise_properties": "Manage enterprise properties", "manage_data_retention": "Manage data retention polices", "manage_legal_hold": "Manage Legal Holds" } } } } } }, "security": [ { "OAuth2Security": [] } ], "tags": [ { "name": "Archives", "description": "A set of endpoints used to manage archives.", "x-box-tag": "archives" }, { "name": "Enterprise Configurations", "description": "Enterprise configurations admins interact with to drive Box product behavior.", "x-box-tag": "enterprise_configurations" }, { "name": "Box Doc Gen", "description": "Doc Gen is used to automatically generate documents.", "x-box-tag": "docgen" }, { "name": "Box Doc Gen templates", "description": "Doc Gen templates are used as input to generate documents.", "x-box-tag": "docgen_template" }, { "name": "External Users", "description": "External users are collaborators from outside of your enterprise.", "x-box-tag": "external_users" }, { "name": "Box Hubs", "description": "A set of endpoints used to manage Box Hubs.", "x-box-tag": "hubs" }, { "name": "Box Hub Collaborations", "description": "A set of endpoints used to manage collaborations within a Box Hub.", "x-box-tag": "hub_collaborations" }, { "name": "Box Hub Document", "description": "A set of endpoints used to retrieve Box Hub Document elements (pages and content blocks).", "x-box-tag": "hub_document" }, { "name": "Box Hub Items", "description": "A set of endpoints used to manage items within a Box Hub.", "x-box-tag": "hub_items" }, { "name": "Shield lists", "description": "Shield List allow an administrator to create a list which will be shared between different Shield Smart Access and Threat Detection rules.", "x-box-tag": "shield_lists" } ], "externalDocs": { "description": "Box Developer Documentation.", "url": "https://developer.box.com" }, "x-mint": { "mcp": { "enabled": true } } }