find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/box:box-terms-of-service-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Box Platform Terms of service API
  description: Box Platform provides functionality to provide access to content stored within Box. 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: '2024.0'
  x-box-commit-hash: 53bdced3cd
servers:
- url: https://api.box.com/2.0
  description: Box Platform API server.
security:
- OAuth2Security: []
tags:
- name: Terms of Service
  description: A set of endpoints used to manage terms of service agreements.
  x-box-tag: terms_of_services
paths:
  /terms_of_services:
    get:
      operationId: get_terms_of_services
      summary: List terms of services
      description: Returns the current terms of service text and settings for the enterprise.
      parameters:
      - name: tos_type
        in: query
        description: Limits the results to the terms of service of the given type.
        required: false
        schema:
          type: string
          enum:
          - external
          - managed
        example: managed
      responses:
        '200':
          description: Returns a collection of terms of service text and settings for the enterprise.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsOfServices'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: terms_of_services
      tags:
      - Terms of Service
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: List terms of services
        source: "curl -i -X GET \"https://api.box.com/2.0/terms_of_services\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: List terms of services
        source: await client.TermsOfServices.GetTermsOfServiceAsync();
      - lang: swift
        label: List terms of services
        source: try await client.termsOfServices.getTermsOfService()
      - lang: java
        label: List terms of services
        source: client.getTermsOfServices().getTermsOfService()
      - lang: node
        label: List terms of services
        source: await client.termsOfServices.getTermsOfService();
      - lang: python
        label: List terms of services
        source: client.terms_of_services.get_terms_of_service()
    post:
      operationId: post_terms_of_services
      summary: Create terms of service
      description: Creates a terms of service for a given enterprise and type of user.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  description: Whether this terms of service is active.
                  type: string
                  example: enabled
                  enum:
                  - enabled
                  - disabled
                tos_type:
                  description: The type of user to set the terms of service for.
                  type: string
                  example: managed
                  enum:
                  - external
                  - managed
                text:
                  description: 'The terms of service text to display to users.


                    The text can be set to empty if the `status` is set to `disabled`.'
                  type: string
                  example: By collaborating on this file you are accepting...
              required:
              - status
              - text
      responses:
        '200':
          description: Returns a new task object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsOfService'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: terms_of_services
      tags:
      - Terms of Service
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Create terms of service
        source: "curl -i -X POST \"https://api.box.com/2.0/terms_of_services\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"status\": \"enabled\",\n       \"text\": \"By collaborating on this file you are accepting...\"\n     }'"
      - lang: dotnet
        label: Create terms of service
        source: 'await client.TermsOfServices.CreateTermsOfServiceAsync(requestBody: new CreateTermsOfServiceRequestBody(status: CreateTermsOfServiceRequestBodyStatusField.Disabled, text: "Test TOS") { TosType = CreateTermsOfServiceRequestBodyTosTypeField.Managed });'
      - lang: swift
        label: Create terms of service
        source: 'try await client.termsOfServices.createTermsOfService(requestBody: CreateTermsOfServiceRequestBody(status: CreateTermsOfServiceRequestBodyStatusField.disabled, tosType: CreateTermsOfServiceRequestBodyTosTypeField.managed, text: "Test TOS"))'
      - lang: java
        label: Create terms of service
        source: client.getTermsOfServices().createTermsOfService(new CreateTermsOfServiceRequestBody.Builder(CreateTermsOfServiceRequestBodyStatusField.DISABLED, "Test TOS").tosType(CreateTermsOfServiceRequestBodyTosTypeField.MANAGED).build())
      - lang: node
        label: Create terms of service
        source: "await client.termsOfServices.createTermsOfService({\n  status: 'disabled' as CreateTermsOfServiceRequestBodyStatusField,\n  tosType: 'managed' as CreateTermsOfServiceRequestBodyTosTypeField,\n  text: 'Test TOS',\n} satisfies CreateTermsOfServiceRequestBody);"
      - lang: python
        label: Create terms of service
        source: "client.terms_of_services.create_terms_of_service(\n    CreateTermsOfServiceStatus.DISABLED,\n    \"Test TOS\",\n    tos_type=CreateTermsOfServiceTosType.MANAGED,\n)"
  /terms_of_services/{terms_of_service_id}:
    get:
      operationId: get_terms_of_services_id
      summary: Get terms of service
      description: Fetches a specific terms of service.
      parameters:
      - name: terms_of_service_id
        in: path
        description: The ID of the terms of service.
        required: true
        schema:
          type: string
        example: '324234'
      responses:
        '200':
          description: Returns a terms of service object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsOfService'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: terms_of_services
      tags:
      - Terms of Service
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Get terms of service
        source: "curl -i -X GET \"https://api.box.com/2.0/terms_of_services/324234\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
    put:
      operationId: put_terms_of_services_id
      summary: Update terms of service
      description: Updates a specific terms of service.
      parameters:
      - name: terms_of_service_id
        in: path
        description: The ID of the terms of service.
        required: true
        schema:
          type: string
        example: '324234'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  description: Whether this terms of service is active.
                  type: string
                  example: enabled
                  enum:
                  - enabled
                  - disabled
                text:
                  description: 'The terms of service text to display to users.


                    The text can be set to empty if the `status` is set to `disabled`.'
                  type: string
                  example: By collaborating on this file you are accepting...
              required:
              - status
              - text
      responses:
        '200':
          description: Returns an updated terms of service object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TermsOfService'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: terms_of_services
      tags:
      - Terms of Service
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Update terms of service
        source: "curl -i -X PUT \"https://api.box.com/2.0/terms_of_services/324234\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"status\": \"enabled\",\n       \"text\": \"By collaborating on this file you are accepting...\"\n     }'"
      - lang: dotnet
        label: Update terms of service
        source: 'await client.TermsOfServices.UpdateTermsOfServiceByIdAsync(termsOfServiceId: tos.Id, requestBody: new UpdateTermsOfServiceByIdRequestBody(status: UpdateTermsOfServiceByIdRequestBodyStatusField.Disabled, text: "TOS"));'
      - lang: swift
        label: Update terms of service
        source: 'try await client.termsOfServices.updateTermsOfServiceById(termsOfServiceId: tos.id, requestBody: UpdateTermsOfServiceByIdRequestBody(status: UpdateTermsOfServiceByIdRequestBodyStatusField.disabled, text: "TOS"))'
      - lang: java
        label: Update terms of service
        source: client.getTermsOfServices().updateTermsOfServiceById(tos.getId(), new UpdateTermsOfServiceByIdRequestBody(UpdateTermsOfServiceByIdRequestBodyStatusField.DISABLED, "TOS"))
      - lang: node
        label: Update terms of service
        source: "await client.termsOfServices.updateTermsOfServiceById(tos.id, {\n  status: 'disabled' as UpdateTermsOfServiceByIdRequestBodyStatusField,\n  text: 'TOS',\n} satisfies UpdateTermsOfServiceByIdRequestBody);"
      - lang: python
        label: Update terms of service
        source: "client.terms_of_services.update_terms_of_service_by_id(\n    tos.id, UpdateTermsOfServiceByIdStatus.DISABLED, \"TOS\"\n)"
components:
  schemas:
    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)
      x-box-resource-id: terms_of_service--base
      x-box-tag: terms_of_services
      x-box-variant: base
      x-box-variants:
      - base
      - standard
    TermsOfServices:
      description: A list of terms of services.
      type: object
      properties:
        total_count:
          description: The total number of objects.
          type: integer
          format: int64
          example: 2
        entries:
          description: A list of terms of service objects.
          type: array
          items:
            $ref: '#/components/schemas/TermsOfService'
      title: Terms of services
      x-box-resource-id: terms_of_services
      x-box-tag: terms_of_services
    TermsOfService:
      description: The root-level record that is supposed to represent a single Terms of Service.
      type: object
      allOf:
      - $ref: '#/components/schemas/TermsOfService--Base'
      - properties:
          status:
            description: Whether these terms are enabled or not.
            type: string
            example: enabled
            enum:
            - enabled
            - disabled
          enterprise:
            allOf:
            - title: Enterprise
              type: object
              description: A representation of a Box enterprise.
              properties:
                id:
                  description: The unique identifier for this enterprise.
                  type: string
                  example: '11446498'
                type:
                  description: The value will always be `enterprise`.
                  type: string
                  example: enterprise
                  enum:
                  - enterprise
                name:
                  description: The name of the enterprise.
                  type: string
                  example: Acme Inc.
            - description: The enterprise these terms apply to.
          tos_type:
            description: Whether to apply these terms to managed users or external users.
            type: string
            example: managed
            enum:
            - managed
            - external
          text:
            description: The text for your terms and conditions. This text could be empty if the `status` is set to `disabled`.
            type: string
            example: By using this service, you agree to ...
          created_at:
            description: When the legal item was created.
            type: string
            format: date-time
            example: '2012-12-12T10:53:43-08:00'
          modified_at:
            description: When the legal item was modified.
            type: string
            format: date-time
            example: '2012-12-12T10:53:43-08:00'
      title: Terms of service
      x-box-resource-id: terms_of_service
      x-box-tag: terms_of_services
      x-box-variant: standard
    ClientError:
      description: A generic error.
      type: object
      properties:
        type:
          description: The value will always be `error`.
          type: string
          example: error
          enum:
          - error
        status:
          description: The HTTP status of the response.
          type: integer
          format: int32
          example: 400
        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
          - unprocessable_entity
          - 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
        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
          - 'null'
          example:
            message: Something went wrong
          additionalProperties: {}
        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/
        request_id:
          description: A unique identifier for this response, which can be used when contacting Box support.
          type: string
          example: abcdef123456
      title: Client error
      x-box-resource-id: client_error
  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
externalDocs:
  description: Box Developer Documentation.
  url: https://developer.box.com
x-mint:
  mcp:
    enabled: true
x-provenance:
  method: harvested
  publisher: Box
  source: https://developer.box.com/box-openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)