Box Developer Documentation

Join BoxWorks 2024 to discover what's possible with content and AI!

Register now!

List Slack integration mappings

get
https://api.box.com/2.0
/integration_mappings/slack

Lists Slack integration mappings in a users' enterprise.

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

Request

bearer [ACCESS_TOKEN]
application/json

Query Parameters

stringin queryoptional
12345

Box item ID, for which the mappings should be returned

stringin queryoptional
folder

Box item type, for which the mappings should be returned

Value is always folder

booleanin queryoptional
true

Whether the mapping has been manually created

integer (int64)in queryoptional
10001000

The maximum number of items to return per page.

stringin queryoptional
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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.

stringin queryoptional
12345

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

stringin queryoptional
channel

Mapped item type, for which the mapping should be returned

Value is always channel

Response

Returns a collection of integration mappings

application/jsonClient error

The server cannot or will not process the request due to an apparent client error.

application/jsonClient error

Returns a not_found error if the integration mapping could not be found.

application/jsonClient error

An unexpected client error.

get
List Slack integration mappings
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -X -L GET "https://api.box.com/2.0/integration_mappings/slack?partner_item_id=C987654321&box_item_id=123456789" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
TypeScript Gen
await userClient.integrationMappings.getSlackIntegrationMapping();
Python Gen
user_client.integration_mappings.get_slack_integration_mapping()
.NET Gen
await userClient.IntegrationMappings.GetSlackIntegrationMappingAsync();
Swift Gen (Beta)
try await userClient.integrationMappings.getSlackIntegrationMapping()
Node
const integrationMappings = await client.integrationMappings.getSlackIntegrationMappings();
console.log(`There are ${integrationMappings.entries.length} Slack integration mappings`);

Response Example

{
  "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": {
        "id": "C12378991223",
        "type": "channel",
        "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"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}