← Coda

List Docs with Coda API

Pipedream makes it easy to connect APIs for Coda and 1000+ other apps remarkably fast.

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
List Docs with the Coda API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

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

  1. Configure the List Docs action
    1. Connect your Coda account
    2. Optional- Select a Doc ID
    3. Optional- Configure Workspace
    4. Optional- Configure Folder ID
    5. Optional- Configure Search Query
    6. Optional- Configure Is Owner Docs
    7. Optional- Configure Is Published Docs
    8. Optional- Configure Is Starred Docs
    9. Optional- Configure In Gallery Docs
    10. Optional- Configure Max Items
  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

List Docs with Coda API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Coda
 
Try it
List Docs with Coda API on New Item in Feed from RSS API
RSS + Coda
 
Try it
List Docs with Coda API on New Message from Discord API
Discord + Coda
 
Try it
List Docs with Coda API on New Message In Channels from Slack API
Slack + Coda
 
Try it
List Docs with Coda API on New Message in Channel from Discord Bot API
Discord Bot + Coda
 
Try it

Details

This is a pre-built, open source 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.

List Docs on Coda
Description:Returns a list of docs accessible by the user. These are returned in the same order as on the docs page: reverse chronological by the latest event relevant to the user (last viewed, edited, or shared). [See docs](https://coda.io/developers/apis/v1#operation/listDocs)
Version:0.0.1
Key:coda-list-docs

Code

import coda from "../../coda.app.mjs";

export default {
  key: "coda-list-docs",
  name: "List Docs",
  description: "Returns a list of docs accessible by the user. These are returned in the same order as on the docs page: reverse chronological by the latest event relevant to the user (last viewed, edited, or shared). [See docs](https://coda.io/developers/apis/v1#operation/listDocs)",
  version: "0.0.1",
  type: "action",
  props: {
    coda,
    docId: {
      propDefinition: [
        coda,
        "docId",
      ],
      description: "Show only docs copied from the specified doc",
      optional: true,
    },
    workspaceId: {
      type: "string",
      label: "Workspace",
      description: "Show only docs belonging to the given workspace",
      optional: true,
    },
    folderId: {
      propDefinition: [
        coda,
        "folderId",
      ],
      description: "Show only docs belonging to the given folder",
    },
    query: {
      propDefinition: [
        coda,
        "query",
      ],
    },
    isOwner: {
      type: "boolean",
      label: "Is Owner Docs",
      description: "Show only docs owned by the user",
      optional: true,
    },
    isPublished: {
      type: "boolean",
      label: "Is Published Docs",
      description: "Show only published docs",
      optional: true,
    },
    isStarred: {
      type: "boolean",
      label: "Is Starred Docs",
      description: "If true, returns docs that are starred. If false, returns docs that are not starred",
      optional: true,
    },
    inGallery: {
      type: "boolean",
      label: "In Gallery Docs",
      description: "Show only docs visible within the gallery",
      optional: true,
    },
    max: {
      propDefinition: [
        coda,
        "max",
      ],
      label: "Max Items",
    },
  },
  async run({ $ }) {
    let params = {
      sourceDoc: this.docId,
      workspaceId: this.workspaceId,
      folderId: this.folderId,
      query: this.query,
      isOwner: this.isOwner,
      isPublished: this.isPublished,
      isStarred: this.isStarred,
      inGallery: this.inGallery,
    };

    let items = [];
    let response;
    do {
      response = await this.coda.listDocs($, params);
      items.push(...response.items);
      params.pageToken = response.nextPageToken;
    } while (params.pageToken && items.length < this.max);

    if (items.length > this.max) items.length = this.max;

    $.export("$summary", `Retrieved ${items.length} doc(s)`);

    return items;
  },
};

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
CodacodaappThis component uses the Coda app.
Doc IDdocIdstringSelect a value from the drop down menu.
WorkspaceworkspaceIdstring

Show only docs belonging to the given workspace

Folder IDfolderIdstring

Show only docs belonging to the given folder

Search Queryquerystring

Search term used to filter down results

Is Owner DocsisOwnerboolean

Show only docs owned by the user

Is Published DocsisPublishedboolean

Show only published docs

Is Starred DocsisStarredboolean

If true, returns docs that are starred. If false, returns docs that are not starred

In Gallery DocsinGalleryboolean

Show only docs visible within the gallery

Max Itemsmaxinteger

Maximum number of results to return in this query

Authentication

Coda uses API keys for authentication. When you connect your Coda account, Pipedream securely stores the keys so you can easily authenticate to Coda APIs in both code and no-code steps.

Get your Coda API token in My account on Coda.

About Coda

A doc as powerful as an app.

More Ways to Use Coda

Actions

Copy Doc with the Coda API

Creates a copy of the specified doc. See docs

 
Try it
Create Doc with the Coda API

Creates a new doc. See docs

 
Try it
Create Rows with the Coda API

Insert a row in a selected table. See docs

 
Try it
Find Row with the Coda API

Searches for a row in the selected table using a column match search. See docs

 
Try it
List Columns with the Coda API

Lists columns in a table. See docs

 
Try it