Integration mapping (Mini)

A mini 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 mini variant are generally returned when the resource is nested within the response for another resource.

id string

example"12345"

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

box_item_id string

example"123124351"

ID of the Box item mapped to the object referenced in partner_item_id

box_item_type string

example"folder"

Type of the Box object referenced in box_item_id

Value is always folder

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

partner_item_id string

example"C12351346"

ID of the mapped partner item

partner_item_type string

example"channel"

Domain-specific type of the mapped partner item

Value is always channel

Response Example

{
  "id": "12345",
  "box_item_id": "123124351",
  "box_item_type": "folder",
  "integration_type": "slack",
  "partner_item_id": "C12351346",
  "partner_item_type": "channel"
}