Skip to content
DataSquaresDocs

REST API

REST API is generally available in the DataSquares connection wizard. Pull a JSON endpoint into a table — headers supported for auth.

  1. In DataSquares, open Data Sources and choose Add data source.

  2. Pick REST API in the connector picker (search or browse by category).

  3. Fill in the connection details below, then test the connection and save.

Connection details

Section titled “Connection details”
Field What to enter
Endpoint URL The HTTP(S) endpoint that returns JSON.
Headers Optional request headers — use these for auth (e.g. Authorization: Bearer …).
Records path Where the array of records lives in the response (e.g. data.items).

The response is pulled into a staged table; re-sync the source to refresh it.

Authentication

Section titled “Authentication”

Auth goes in the headers field. The common patterns:

Authorization: Bearer <token>
X-API-Key: <key>

Basic auth works as a header too: Authorization: Basic <base64 user:pass>.

Pointing at the records

Section titled “Pointing at the records”

If the endpoint returns the array directly ([ {...}, {...} ]), leave the records path empty. If the array is nested, give its dot path:

{ "data": { "items": [ … ] } }   →   records path: data.items

Each record is flattened into a row; nested objects become dotted columns.

Refresh model

Section titled “Refresh model”

The endpoint is pulled when you create the source and again on each re-sync — it’s a snapshot between syncs, not a live proxy. Paginated APIs: the initial version fetches the endpoint as given — point it at a page size large enough for your data, or expose a bulk/export endpoint.

Test outside first

Section titled “Test outside first”

curl the exact URL with the same headers before wiring it in — it separates API-side problems (auth, path) from configuration typos immediately.

Section titled “Related”
© 2026 DataSquares