No logo available for Plangrid to DuckDB connector icon

Load Plangrid data to DuckDB

Build a Plangrid to DuckDB pipeline with your coding agent. One prompt scaffolds it with the dltHub AI harness, plus the Plangrid API base URL, auth, endpoints, and incremental loading.

SourcePlangridAPI DocumentationDestinationDuckDBIn-process analytical database. The default local destination for dlt pipelines.

PlanGrid is a construction software platform providing a REST API for accessing project data, issues, and construction documents. Everything needed to build a working Plangrid → DuckDB pipeline is on this page: the API's base URL, authentication, endpoints, pagination and incremental field — plus a prompt that hands the whole job to your coding agent.


Build your Plangrid to DuckDB pipeline

Paste this prompt into Claude, Codex, or Cursor. The agent does the rest.

Prompt
Run uvx dlthub-init@latest to build a pipeline from Plangrid to DuckDB and run it on dltHub

That scaffolds a dltHub workspace and installs the dltHub AI harness — the project rules, the secrets-management skill, and the dlt MCP server your agent needs to work safely. From there it reads the Plangrid API, proposes the endpoints to load, then writes, runs and validates the pipeline while you review rather than type. Credentials are inspected through MCP tools, so your agent never reads secrets.toml itself. How the LLM-native workflow works →

Prefer to write it yourself? Every fact the agent uses is below.


Plangrid API at a glance

Base URLhttps://io.plangrid.com
Example endpointGET projects
Records found atdata
Authenticationsupports OAuth 2.0 and HTTP Basic Auth — sent in the Authorization header, prefixed Bearer
Also requiredAccept
PaginationOffset-based via skip, page size via limit (default 50, max 50). The API uses offset-based pagination. 'skip' acts as the offset (default 0), and 'limit' acts as the page size (default and max 50). Responses include a 'next_page_url' field. Some documentation examples inconsistently refer to 'page' and 'per_page', but the definitive reference documentation specifies 'limit' and 'skip'.
API referencehttps://developer.plangrid.com/reference/authentication

These values come from the Plangrid API reference — the authoritative source if anything here looks out of date.


How do I authenticate with the Plangrid API?

Authentication is performed via OAuth 2.0 (using a Bearer token in the 'Authorization' header) or HTTP Basic Auth (using an API key as the username with a blank password). All requests must include an 'Accept' header with the value 'application/vnd.plangrid+json; version=1'.

1. Get your credentials

PlanGrid uses both OAuth 2.0 and API keys for authentication. To obtain credentials for OAuth 2.0, you must contact PlanGrid support to register your application. For simple API key authentication, consult your account settings or contact PlanGrid support to request an API key associated with your PlanGrid account. PlanGrid recommends OAuth 2.0 for most applications.

2. Add them to .dlt/secrets.toml

[sources.plangrid_source] plangrid_api_key = "your_api_key_here"

dlt reads this file automatically at runtime. With the harness, the setup-secrets skill prompts you for the values and never handles the raw credential in chat. For production, see setting up credentials with dlt.


What Plangrid data can I load into DuckDB?

These are the Plangrid endpoints dlt can load into DuckDB:

ResourceEndpointMethodData selectorDescription
projectsprojectsGETdataList all projects
commentsprojects/{projectUid}/commentsGETdataList comments for a project
usersprojects/{projectUid}/usersGETdataList users for a project
sheetsprojects/{projectUid}/sheetsGETdataList sheets for a project
attachmentsprojects/{projectUid}/attachmentsGETdataList attachments for a project

How do I load only new Plangrid records?

The Plangrid API reference does not document a timestamp or sequence field for these endpoints, so there is nothing to advertise here as verified. Pick a field from the endpoints table above that increases with every write, then set it as the cursor_path.

{"name": "projects", "endpoint": { "path": "projects", # Replace with a field that increases on every write. "incremental": {"cursor_path": "REPLACE_ME", "initial_value": "2024-01-01T00:00:00Z"}, }}

On the first run dlt loads everything from initial_value; on every run after that it requests only what changed and appends with write_disposition="merge" if you set a primary key. See incremental loading.


What does the generated Plangrid pipeline look like?

A standard dlt REST API pipeline — the same code you would write by hand, loading projects and issues from the Plangrid API into DuckDB:

import dlt from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources @dlt.source def plangrid_source(api_key=dlt.secrets.value): config: RESTAPIConfig = { "client": { "base_url": "https://io.plangrid.com", "auth": {"type": "bearer", "token": api_key}, }, "resources": [ {"name": "projects", "endpoint": {"path": "projects", "data_selector": "data"}}, {"name": "comments", "endpoint": {"path": "projects/{projectUid}/comments", "data_selector": "data"}} ], } yield from rest_api_resources(config) def load_plangrid_to_duckdb() -> None: pipeline = dlt.pipeline( pipeline_name="plangrid_pipeline", destination="duckdb", dataset_name="plangrid_data", ) load_info = pipeline.run(plangrid_source()) print(load_info) if __name__ == "__main__": load_plangrid_to_duckdb()

Run it with python plangrid_pipeline.py. The agent iterates on this until it loads cleanly — you review and approve, rather than write it from scratch.


How do I query Plangrid data in DuckDB?

dlt creates one table per resource. Query the loaded data with Python or SQL — or ask your agent to, through the MCP server's execute_sql_query tool.

Python (pandas DataFrame):

import dlt data = dlt.pipeline("plangrid_pipeline").dataset() df = data.projects.df() print(df.head())

SQL:

SELECT * FROM plangrid_data.projects LIMIT 10;

See querying your data with dataset and exploring it in marimo notebooks.


How do I deploy the Plangrid to DuckDB pipeline in production?

The pipeline runs locally, which is ideal for prototyping and one-off analysis. When you need it on a schedule, monitored on every load, and shared with your team, deploy the same dlt code on the dltHub platform — no infrastructure to maintain. The prompt above already ends with "run it on dltHub", so your agent can take it there directly.

  • Deploy & schedule — run the pipeline as a managed job with automatic retries.
  • Monitor — observable job queues, alerting, and load metrics for every run.
  • Transform — promote raw Plangrid loads into governed, documented models.
  • Visualize & share — explore data in notebooks and publish live dashboards instead of static screenshots.

Book a demo →


What other destinations can I load Plangrid data to?

dlt loads into any of these — only the destination argument changes:

DestinationExample value
PostgreSQL"postgres"
BigQuery"bigquery"
Snowflake"snowflake"
Redshift"redshift"
Databricks"databricks"
Filesystem (S3, GCS, Azure)"filesystem"

Set dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. On the dltHub platform the same pipeline runs against a managed Iceberg lakehouse. See the full destinations list.


Next steps

Was this page helpful?

Community Hub

Need more dlt context for Plangrid to DuckDB?

Request dlt skills, commands, AGENT.md files, and AI-native context.