← Box

Search Content with Box API

Pipedream makes it easy to connect APIs for Box and 2,200+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Search Content with the Box API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Search Content with the Box API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Search Content action
    1. Connect your Box account
    2. Optional- Select a Type
    3. Optional- Configure Query
    4. Optional- Configure Metadata Filters
    5. Optional- Configure Fields
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Search Content with Box API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Box
 
Try it
Search Content with Box API on New Message from Discord API
Discord + Box
 
Try it
Search Content with Box API on New Message in Channel from Discord Bot API
Discord Bot + Box
 
Try it
Search Content with Box API on New Submission from Typeform API
Typeform + Box
 
Try it
Search Content with Box API on Custom Events from Zoom API
Zoom + Box
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Search Content on Box
Description:Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. [See the documentation](https://developer.box.com/reference/get-search/).
Version:0.0.4
Key:box-search-content

Code

import app from "../../box.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import utils from "../../common/utils.mjs";

export default {
  name: "Search Content",
  description: "Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. [See the documentation](https://developer.box.com/reference/get-search/).",
  key: "box-search-content",
  version: "0.0.4",
  type: "action",
  props: {
    app,
    searchType: {
      propDefinition: [
        app,
        "searchType",
      ],
    },
    query: {
      propDefinition: [
        app,
        "query",
      ],
    },
    mdfilters: {
      propDefinition: [
        app,
        "mdfilters",
      ],
    },
    fields: {
      propDefinition: [
        app,
        "fields",
      ],
    },
  },
  async run({ $ }) {
    const results = [];
    if (!this.query && !this.mdfilters) {
      throw new ConfigurationError("At least one of `Query` and `Metadata Filters` props is needed.");
    }
    const resourcesStream = await utils.getResourcesStream({
      resourceFn: this.app.searchContent,
      resourceFnArgs: {
        $,
        params: {
          query: this.query,
          mdfilters: this.mdfilters,
          type: this.searchType,
          fields: this.fields,
        },
      },
    });
    for await (const resource of resourcesStream) {
      results.push(resource);
    }
    // eslint-disable-next-line multiline-ternary
    $.export("$summary", results.length ? `Successfully fetched ${results.length} search result${results.length === 1 ? "" : "s"}.` : "No search results.");
    return results;
  },
};

Configuration

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.
LabelPropTypeDescription
BoxappappThis component uses the Box app.
TypesearchTypestringSelect a value from the drop down menu:{ "label": "Files", "value": "file" }{ "label": "Folders", "value": "folder" }{ "label": "Web Links", "value": "web_link" }
Queryquerystring

The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types. Please see the docs

Metadata Filtersmdfiltersstring

A list of metadata templates to filter the search results by. e.g. [{"scope":"enterprise","templateKey":"contract","filters":{"category":"online"}}]. Please see the docs

Fieldsfieldsstring[]

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, e.g. id,type,name

Authentication

Box uses OAuth authentication. When you connect your Box account, Pipedream will open a popup window where you can sign into Box and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Box API.

Pipedream requests the following authorization scopes when you connect your account:

About Box

Platform for secure content management, workflow, and collaboration

More Ways to Use Box

Triggers

New Event from the Box API

Emit new event when an event with subscribed event source triggered on a target. See the documentation

 
Try it
New File Event from the Box API

Emit new event when a new file uploaded on a target. See the documentation

 
Try it
New Folder Event from the Box API

Emit new event when a new folder created on a target. See the documentation

 
Try it

Actions

Download File with the Box API

Downloads a file from Box to your workflow's /tmp directory. See the documentation

 
Try it
Get Comments with the Box API

Fetches comments for a file. See the documentation.

 
Try it
Upload a File with the Box API

Uploads a small file to Box. See the documentation.

 
Try it
Upload File Version with the Box API

Update a file's content. See the documentation.

 
Try it

Explore Other Apps

1
-
24
of
2,200+
apps by most popular

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Premium
ServiceNow
ServiceNow
The smarter way to workflow
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.