Cascade Library
  • Introduction
    • Welcome to Cascade
    • Workspaces
  • Getting Started
    • Build Your First Workflow
    • Build Your First Data App
  • Workflows
    • Overview
      • Navigating the Canvas
      • Setting Up
      • Drag and Drop
      • Tools
    • Dynamic Workflows
    • Global Variables
    • Data Locker
    • Scheduling
    • Webhooks
    • Run Logs
    • Workflow Deployment
  • Integrations
    • Connecting Cascade to your database
    • Amazon S3
    • Azure Blob Storage
    • BigQuery
    • Google Sheets
    • MySQL
    • Postgres
    • Redshift
    • SQL Server
    • Snowflake
    • Tableau Server
  • Tools
    • Import
      • Import File
      • Import from Data Locker
      • Import from API
      • Import Sample Data
      • New Table
    • Clean
      • Validate Schema
      • Find/Replace
      • Text to Columns
      • Flatten Json
      • Sample
      • Standardize
      • Validate
    • Transform
      • Edit Columns
      • Select Columns
      • Filter
      • Sort
      • Pivot
      • Unpivot
      • Deduplicate
    • Merge
      • Append
      • Join
      • Multi Join
      • Fuzzy Join
    • Predictive Modeling
      • Build Model
      • Apply Model
      • Correlate
      • ARIMA Forecast
    • Flow
      • Conditional
    • Code
      • Python
      • SQL
    • Visualize
      • Chart
        • Bar
        • Line
        • Combo
        • Scatter
        • Histogram
        • Box
        • Pie
        • Area
        • Funnel
    • Publish
      • Publish to Data Locker
      • Publish via Email
      • Publish to URL
      • Embed
  • Functions & Expressions
    • Functions
      • Aggregate Functions
        • AVERAGE
        • CORR
        • COUNT
        • COUNTD
        • COUNTBY
        • COUNTIF
        • COUNTIFS
        • COVAR
        • COVARP
        • COVARS
        • MAX
        • MEDIAN
        • MIN
        • MAXBY
        • MINBY
        • PERCENTILE
        • STDEV
        • STDEVP
        • STDEVS
        • SUM
        • SUMBY
        • SUMIF
        • VAR
        • VARP
        • VARS
        • RUNNINGTOTALBY
          • SIGN
          • SIN
          • SQRT
          • SQUARE
          • TAN
          • ZN
      • Conversion Functions
        • TIMESTAMPTODATE
        • TODATE
        • TODECIMAL
        • TOINT
      • Date/Time Functions
        • DATEADD
        • DATEDIF
        • DATENAME
        • DATENORMALIZE
        • DATEPART
        • DATETRUNC
        • DAY
        • DAYS
        • HOUR
        • ISDATE
        • ISOWEEKDAY
        • ISOWEEK
        • ISOQUARTER
        • ISOYEAR
        • MAKEDATE
        • MAKEDATETIME
        • MINUTE
        • MONTH
        • NOW
        • QUARTER
        • SECOND
        • TODAY
        • WEEK
        • WEEKDAY
        • YEAR
      • Logical Functions
        • AND
        • BETWEEN
        • CASE
        • CHOOSE
        • CONTAINSWITHIN
        • IF
        • IFS
        • IIF
        • IN
        • IFNULL
        • ISBOOLEAN
        • ISDECIMAL
        • ISDURATION
        • ISINTEGER
        • ISNULL
        • ISNUMBER
        • ISSTRING
        • ISUNIQUE
        • NOT
        • NULL
        • OR
        • SWITCH
        • ALL
          • TOSTRING
        • ANY
      • Math Functions
        • ABS
        • ACOS
        • ASIN
        • ATAN
        • ATAN2
        • CEILING
        • COS
        • COT
        • COSEC
        • DEGREES
        • DIV
        • EVEN
        • EXPONENTIAL
        • FILLINFINITY
        • FLOOR
        • HAVERSINE
        • LOG
        • LN
        • ODD
        • MODULO
        • PERCENTILEOFVALUE
        • PERCENTILEVALUE
        • PI
        • POWER
        • RADIANS
        • RANDOM
        • ROUND
        • SEC
      • Table Functions
        • ENCODE
        • INDEX
        • INDEXBY
        • FILLNULL
        • FIRSTBY
        • GENERATEUNIQUEID
        • LASTBY
        • LOOKUP
        • MATCH
        • NTH
        • OFFSET
        • OFFSETBY
        • PREVIOUSVALUE
        • RANK
        • RANKBY
        • RECORDID
        • ROLLINGAVERAGE
        • ROW
        • RUNNINGAVERAGE
        • RUNNINGMAX
        • RUNNINGMIN
        • RUNNINGSTDEV
        • RUNNINGTOTAL
        • WINDOWAVERAGE
        • WINDOWMAX
        • WINDOWMIN
        • WINDOWCOUNT
        • WINDOWSUM
        • SEQUENCE
        • WINDOWMEDIAN
        • WINDOWSTDEV
        • WINDOWSTDEVP
        • WINDOWSTDEVS
        • WINDOWVAR
        • WINDOWVARP
        • WINDOWVARS
        • WINDOWCORR
        • WINDOWCOVAR
        • WINDOWCOVARP
        • WINDOWCOVARS
        • SMOOTHEDAVERAGE
      • Text Functions
        • ASCII
        • CHAR
        • CONCAT
        • CONTAINS
        • ENDSWITH
        • FIND
        • FINDNTH
        • ISEMPTY
        • JSONPARSE
        • LEFT
        • LENGTH
        • LOWER
        • LTRIM
        • MID
        • PROPER
        • RIGHT
        • RTRIM
        • SPACE
        • SPLIT
        • STARTSWITH
        • TRIM
        • SUBSTITUTE
        • UPPER
    • Building Expressions
      • Expression Operators
      • Guide to Window Functions
  • Cascade FAQs
    • Best Practices
      • 💬How to add a total row to a table
      • 💬How to leave comments on a workflow
      • 💬How to add new columns in the Edit Columns tool
      • 💬Setting up a New Table tool
      • 💬How to rename a tool
    • Knowledge Based
      • 💬How to change Data Types in Cascade
      • 💬How to remove columns from a table in Cascade
      • 💬How to rename columns in Cascade
      • 💬Understanding the Join options in the Cascade Join tool
      • 💬How to connect tools to each other
    • Import
      • 💬How to Import an Excel File into Cascade
      • 💬How to Import a CSV File into Cascade
      • 💬How to import a CSV file into the Data Locker
    • Functions and Expressions
      • 💬How to write an IN() statement with multiple variables
      • 💬How to Remove null Records with a Filter tool
      • 💬How to write an IF Statement in Cascade
      • 💬How to replace null values with 0
    • Troubleshooting
      • ⚠️What does it mean if my workflow won’t load?
      • ⚠️Why can’t I connect my tool to other tools?
      • ⚠️Why are there duplicate records after my Join tool?
  • Change Log
On this page
  • Interpreting API Documentation
  • Main Configuration
  • Authentication
  • Pagination

Was this helpful?

  1. Tools
  2. Import

Import from API

Import data from an external service.

PreviousImport from Data LockerNextImport Sample Data

Last updated 2 years ago

Was this helpful?

This tool is currently in Beta and is still being tested. Want to learn more? Like to provide feedback? Please reach out to

Import from API allows data to be extracted from third-party services via REST APIs.

At this time, Import from API can only make GET requests and accepts only JSON responses.

Interpreting API Documentation

Before configuring the Import from API tool, it is important to understand how the API is intended to be used. To find out, you may need to search for documentation or reference material provided by the third party. Often this will be labeled "API Documentation" or "API Reference" or something similar under a "Developers" page. These pages often contain code snippets, sometimes in multiple programming languages.

Main Configuration

Option
Description

Endpoint URL

The URL to request data from.

Location of data from response (optional)

The JSONPath that contains the tabular data to extract. When blank, interprets the entire response as data.

Authentication

In many cases, an API request will need to be authenticated in order to validate authorization of the requested data. Cascade supports two different authentication methods: username / password (or basic authentication) and bearer token authentication.

Username / Password (Basic)

Option
Description

Username

The username that the request should authenticate with.

Typically this is the username a user will use to sign into the third-party service.

Password

The password that the request should authenticate with.

Typically this is the password a user will use to sign into the third-party service.

Bearer Token

Option
Description

Token

The token that should be used in the Authorization header of the request for authentication.

Typically this is an API token or API key.

Pagination

In many cases, the full results from an API request will be provided over multiple requests (or pages). Cascade supports three different pagination methods: page, offset / limit, and cursor pagination.

Page pagination

Option
Description

Page key

The name of the parameter used to reference which page number is being requested.

Typically, this is page.

First page number

The starting page number.

Typically, this is either 1 or 0.

Offset / limit pagination

Option
Description

Offset key

The name of the parameter used to reference how many items should be skipped when requesting a given page.

Often, this is offset, since, after, or a similar name.

Initial offset

The starting index of results returned by the API.

Typically, this is 0.

Limit key (optional)

The name of the parameter used to limit the number of items returned by the API per page.

Often, this is limit, max, or a similar name.

When omitted, requests will not specify an explicit limit.

Limit size (optional)

The number of items to request per page. When omitted (or when limit key is omitted), the size will be inferred from the number of items returned by the first request.

Cursor pagination

Option
Description

Cursor key (optional)

The name of the parameter used to reference the cursor in pagination.

Typically, this is cursor. When omitted, assumes the cursor path references a full URL rather than a token.

Cursor path

All pagination

Regardless of the pagination used, the following parameters may also be specified:

Option
Description

Max pages to request (optional)

The maximum number of pages to request when paginating.

Note that fewer requests may be made if the API returns no items before the maximum number of pages are requested.

If omitted, requests will be made until no items are returned by the API.

Max pages per minute (optional)

The maximum number of pages to request per minute when paginating. This option can be used to rate limit requests sent to the API. Each request will be spaced out evenly, so even if the max pages to request is less than the max pages per minute, this option will still have an effect. If omitted, requests will be made immediately after the previous one completes.

Note: Each time your workflow is re-run, the Import from API tool will re-run as well, incurring any charges that may be imposed from the API service. To avoid this, you can utilize the Lock Output feature which will retain the data from the latest Import from API run.

The possible JSONPaths to be selected are determined by inspecting the shape of the response. Learn more about .

The JSONPath to the token or URL for the next page. The possible JSONPaths to be selected are determined by inspecting the shape of the response. Learn more about .

support@cascade.io
JSONPaths here
JSONPaths here