BObox
Integration mappings

List Slack integration mappings

Changed on

Lists Slack integration mappings in a users' enterprise.

You need Admin or Co-Admin role to use this endpoint.

get/integration_mappings/slack

Request

  • Base URL
    https://api.box.com/2.0
  • URL
    https://api.box.com/2.0/integration_mappings/slack
  • Auth
    OAuth 2
    Authorization code: https://account.box.com/api/oauth2/authorize
    Token URL: https://api.box.com/oauth2/token

Query parameters

markerstring

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

limitinteger

The maximum number of items to return per page.

partner_item_type'channel'

Mapped item type, for which the mapping should be returned.

partner_item_idstring

ID of the mapped item, for which the mapping should be returned.

box_item_idstring

Box item ID, for which the mappings should be returned.

box_item_type'folder'

Box item type, for which the mappings should be returned.

is_manually_createdboolean

Whether the mapping has been manually created.

Response

Returns a collection of integration mappings.

limitinteger

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.

next_markerstring nullable

The marker for the start of the next page of results.

Example response

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

Changes

  • c4d5303fa5c3Revision changes
    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • warning

      added the new unprocessable_entity enum value to the response property for the response status

    • info

      added subschema #1 subschema #2 to the response body allOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body allOf list for the response status