Integration mapping

A standard representation of an integration mapping object.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

id string

example"12345"

A unique identifier of a folder mapping (part of a composite key together with integration_type)

type string

example"integration_mapping"

Mapping type

Value is always integration_mapping

box_itemFolder (Mini) object

The Box folder, to which the object from the partner app domain (referenced in partner_item_id) is mapped

created_at string / date-time

example"2012-12-12T10:53:43-08:00"

When the integration mapping object was created

created_byUser (Integration Mappings) object

An object representing the user who created the integration mapping

integration_type string

example"slack"

Identifies the Box partner app, with which the mapping is associated. Currently only supports Slack. (part of the composite key together with id)

Value is always slack

is_manually_created boolean

exampletrue

Identifies whether the mapping has been manually set (as opposed to being automatically created)

modified_at string / date-time

example"2012-12-12T10:53:43-08:00"

When the integration mapping object was last modified

modified_byUser (Integration Mappings) object

The user who last modified the integration mapping

options object

example{}

Integration mapping options for Slack

partner_item object

Mapped item object for Slack

Response Example

{
  "id": "12345",
  "type": "integration_mapping",
  "box_item": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "integration_type": "slack",
  "is_manually_created": true,
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "options": {},
  "partner_item": {
    "id": "C12378991223",
    "type": "channel",
    "slack_org_id": "E1234567",
    "slack_workspace_id": "T12352314"
  }
}