---
slug: rest-api
title: REST API
section: Reference
description: What programmatic access OrcaSheets exposes and what remains UI-only.
listed: false
---
# REST API

**OrcaSheets does not expose its individual features (filters, Pivot Tables, joins, Charts, Dashboards) as a REST API. The only supported programmatic access is a custom Recipe built for Enterprise customers.**

If you are looking for a way to call OrcaSheets from code, for example:

- "Give me the Pivot Table output as JSON."
- "Trigger a join and return the joined dataset."
- "Run a Chart export via an endpoint."
- "Run AI Chat via an API."

...that is **not** something OrcaSheets provides as a standard, documented product capability.

## What this means in practice

- **No generic "OrcaSheets APIs"** exist that you can build integrations against.
- **Do not assume endpoints** exist for Pivot Table, filter, export, or Dashboard refresh.
- **If you have seen something API-like** in a specific environment, treat it as custom and deployment-specific.

## The only programmatic access we offer (Enterprise-only)

OrcaSheets can offer programmatic workflows **only** in one narrow case:

- **Custom Recipes**, built as a **custom development** engagement.
- Available **only for Enterprise customers**.
- Designed around your specific workflow (inputs, transformations, outputs).

In other words: programmatic access is not "feature-by-feature APIs". It is "a custom workflow we build for your Enterprise deployment, if and when needed".

## If something API-like has been built for you

If your OrcaSheets deployment includes any programmatic trigger or automation capability, it was built specifically for your organisation. In that case:

1. This page documents the standard product.
2. **Refer to the deployment-specific documentation** provided to your team for:
   - The exact endpoints (if any).
   - Authentication requirements.
   - Payload formats.
   - Limits, retries, and timeouts.
   - Supported actions and failure modes.
3. If you are missing that documentation, reach out to your OrcaSheets enterprise contact.

## What to do instead

- **Produce results in-app** using filters, Pivot Tables, and Dashboards.
- **Export and integrate downstream**: [Exporting Data](/docs/exporting-data).
- **For recurring automation**, discuss whether your workflow should be implemented as a **custom Recipe**.

For the authoritative "what is supported" view, see the [Overview](/docs/overview).

## Related pages

- [JavaScript SDK](/docs/javascript-sdk)
- [Python SDK](/docs/python-sdk)
- [Webhook Integration](/docs/webhook-integration)
- [Recipes](/docs/recipes)