Box Invites API

openapi: 3.2.0
info:
  title: Box Platform Invites 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: Invites
  description: Invites are used to invite the user to an enterprise.
  x-box-tag: invites
paths:
  /invites:
    post:
      operationId: post_invites
      summary: Create user invite
      description: 'Invites an existing external user to join an enterprise.


        The existing user can not be part of another enterprise and must already have a Box account. Once invited, the user will receive an email and are prompted to accept the invitation within the Box web application.


        This method requires the "Manage An Enterprise" scope enabled for the application, which can be enabled within the developer console.'
      parameters:
      - name: fields
        in: query
        description: 'A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.


          Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.'
        required: false
        schema:
          type: array
          items:
            type: string
        example:
        - id
        - type
        - name
        explode: false
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                enterprise:
                  description: The enterprise to invite the user to.
                  type: object
                  properties:
                    id:
                      description: The ID of the enterprise.
                      type: string
                      example: '1232234'
                  required:
                  - id
                actionable_by:
                  description: The user to invite.
                  type: object
                  properties:
                    login:
                      description: The login of the invited user.
                      type: string
                      example: john@example.com
                  required:
                  - id
              required:
              - enterprise
              - actionable_by
      responses:
        '200':
          description: Returns a new invite object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invite'
        '404':
          description: Returns `not_found` when user was not found.
          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: invites
      tags:
      - Invites
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Create user invite
        source: "curl -i -X POST \"https://api.box.com/2.0/invites\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\" \\\n     -H \"content-type: application/json\" \\\n     -d '{\n       \"enterprise\": {\n         \"id\": \"1232234\"\n       },\n       \"actionable_by\": {\n         \"login\" : \"freeuser@box.com\"\n       }\n     }'"
      - lang: dotnet
        label: Create user invite
        source: 'await client.Invites.CreateInviteAsync(requestBody: new CreateInviteRequestBody(enterprise: new CreateInviteRequestBodyEnterpriseField(id: NullableUtils.Unwrap(NullableUtils.Unwrap(currentUser.Enterprise).Id)), actionableBy: new CreateInviteRequestBodyActionableByField() { Login = email }));'
      - lang: swift
        label: Create user invite
        source: 'try await client.invites.createInvite(requestBody: CreateInviteRequestBody(enterprise: CreateInviteRequestBodyEnterpriseField(id: currentUser.enterprise!.id!), actionableBy: CreateInviteRequestBodyActionableByField(login: email)))'
      - lang: java
        label: Create user invite
        source: client.getInvites().createInvite(new CreateInviteRequestBody(new CreateInviteRequestBodyEnterpriseField(currentUser.getEnterprise().getId()), new CreateInviteRequestBodyActionableByField.Builder().login(email).build()))
      - lang: node
        label: Create user invite
        source: "await client.invites.createInvite({\n  enterprise: {\n    id: currentUser.enterprise!.id!,\n  } satisfies CreateInviteRequestBodyEnterpriseField,\n  actionableBy: {\n    login: email,\n  } satisfies CreateInviteRequestBodyActionableByField,\n} satisfies CreateInviteRequestBody);"
      - lang: python
        label: Create user invite
        source: "client.invites.create_invite(\n    CreateInviteEnterprise(id=current_user.enterprise.id),\n    CreateInviteActionableBy(login=email),\n)"
  /invites/{invite_id}:
    get:
      operationId: get_invites_id
      summary: Get user invite status
      description: Returns the status of a user invite.
      parameters:
      - name: invite_id
        in: path
        description: The ID of an invite.
        required: true
        schema:
          type: string
        example: '213723'
      - name: fields
        in: query
        description: 'A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.


          Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.'
        required: false
        schema:
          type: array
          items:
            type: string
        example:
        - id
        - type
        - name
        explode: false
      responses:
        '200':
          description: Returns an invite object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Invite'
        default:
          description: An unexpected client error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClientError'
      x-box-tag: invites
      tags:
      - Invites
      x-box-unsupported-on-free-developer: true
      x-codeSamples:
      - lang: curl
        label: Get user invite status
        source: "curl -i -X GET \"https://api.box.com/2.0/invites/213723\" \\\n     -H \"authorization: Bearer <ACCESS_TOKEN>\""
      - lang: dotnet
        label: Get user invite status
        source: 'await client.Invites.GetInviteByIdAsync(inviteId: invitation.Id);'
      - lang: swift
        label: Get user invite status
        source: 'try await client.invites.getInviteById(inviteId: invitation.id)'
      - lang: java
        label: Get user invite status
        source: client.getInvites().getInviteById(invitation.getId())
      - lang: node
        label: Get user invite status
        source: await client.invites.getInviteById(invitation.id);
      - lang: python
        label: Get user invite status
        source: client.invites.get_invite_by_id(invitation.id)
components:
  schemas:
    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)
      x-box-resource-id: user--mini
      x-box-tag: users
      x-box-variant: mini
    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
      required:
      - type
      - id
      title: User (Base)
      x-box-resource-id: user--base
      x-box-tag: users
      x-box-variant: base
      x-box-variants:
      - base
      - mini
      - standard
      - full
    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
    Invite:
      description: An invite for a user to an enterprise.
      type: object
      properties:
        id:
          description: The unique identifier for this invite.
          type: string
          example: '11446498'
        type:
          description: The value will always be `invite`.
          type: string
          example: invite
          enum:
          - invite
        invited_to:
          description: A representation of a Box enterprise.
          type: object
          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.
          title: Enterprise
        actionable_by:
          $ref: '#/components/schemas/User--Mini'
        invited_by:
          $ref: '#/components/schemas/User--Mini'
        status:
          description: The status of the invite.
          type: string
          example: pending
        created_at:
          description: When the invite was created.
          type: string
          format: date-time
          example: '2012-12-12T10:53:43-08:00'
        modified_at:
          description: When the invite was modified.
          type: string
          format: date-time
          example: '2012-12-12T10:53:43-08:00'
      required:
      - id
      - type
      title: Invite
      x-box-resource-id: invite
      x-box-tag: invites
  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)