canonical: https://jentic.com/apis/apideck.com

# Apideck APIs

Apideck offers a set of Unified APIs that map one normalised schema onto many downstream SaaS platforms, so a single integration reaches every provider in a category. The Accounting, CRM, HRIS, ATS, File Storage, POS, Ecommerce, Customer Support, Lead, Issue Tracking, and SMS APIs each cover the day-to-day objects of their domain across dozens of connectors such as Xero, Salesforce, BambooHR, Greenhouse, Google Drive, Square, Shopify, Zendesk, Twilio, and Jira. The Vault API manages the OAuth connections and consumer records that authorise every call, while the Connector, Ecosystem, Proxy, and Webhook APIs cover connector discovery, embedded marketplace data, native pass-through requests, and event delivery.

## For AI agents

An agent can read and write records across accounting, CRM, HRIS, ATS, file storage, POS, ecommerce, support, lead, issue-tracking, and SMS platforms through one normalised schema, then use Vault to manage the OAuth connections behind each call and the Proxy API to reach any provider feature a Unified API does not cover.

## Scope

Use for: Reading and writing normalised records across accounting, CRM, HRIS, ATS, file storage, POS, ecommerce, support, lead, issue-tracking, and SMS platforms through one schema, plus managing the OAuth connections and events behind those calls

Not supported:
- payroll runs
- tax filing submissions
- voice or MMS
- checkout creation
- CI/CD pipelines
- real-time streaming

## APIs

| API | Category | Endpoints | Description |
| --- | --- | --- | --- |
| Accounting API | finance | 95 | Read and write invoices, bills, payments, customers, suppliers, and ledger accounts across Xero, QuickBooks, Sage, NetSuite, and other accounting platforms through one unified schema. |
| POS API | payments | 46 | Create orders, capture payments, and manage menu items, modifiers, and locations across Square, Clover, Lightspeed, Toast, and Shopify POS through one unified API. |
| CRM API | crm | 40 | Read and write companies, contacts, leads, opportunities, pipelines, activities, and notes across Salesforce, HubSpot, Pipedrive, Zoho, and other CRMs through one unified schema. |
| File storage API | storage | 33 | Upload, download, search, and organise files and folders across Google Drive, Dropbox, Box, OneDrive, and SharePoint through one unified API surface. |
| Vault API | identity-auth | 31 | Manage OAuth connections, consumers, custom field mappings, and request logs that authorise every other Apideck Unified API call. |
| HRIS API | hr-recruiting | 25 | Read and write employee, company, department, and time-off data across BambooHR, Gusto, Workday, ADP, Rippling, and other HRIS providers through one unified API. |
| Issue Tracking API | developer-tools | 15 | Create, update, and comment on tickets across Jira, Linear, GitHub Issues, GitLab Issues, Asana, and Trello through one unified API surface. |
| ATS API | hr-recruiting | 12 | Read jobs, applicants, applications, and offers across Greenhouse, Lever, Workable, and other ATS platforms through one unified schema. |
| Ecosystem API | developer-tools | 12 | Read Apideck-managed integration marketplace data - list ecosystems, categories, collections, products, and individual listings to render an embedded integrations directory. |
| Connector API | developer-tools | 10 | Inspect Apideck Unify's connector catalogue: list connectors, see which unified APIs each implements, read documentation, and fetch the schema for any resource. |
| Webhook API | developer-tools | 10 | Subscribe to events emitted by Apideck Unified APIs, replay deliveries, and inspect event logs across CRM, HRIS, accounting, and other connectors. |
| Ecommerce API | e-commerce | 7 | Read orders, products, customers, and store metadata across Shopify, WooCommerce, BigCommerce, and other storefronts through one unified schema. |
| Customer Support | crm | 5 | Read and write customer records across Zendesk, Freshdesk, Intercom, and other support platforms through one unified schema. |
| Lead API | crm | 5 | Create, list, update, and delete sales leads across Salesforce, HubSpot, Pipedrive, Zoho, and other CRMs through one unified API. |
| Proxy API | developer-tools | 5 | Forward arbitrary HTTP requests to any Apideck-connected provider's native API using the connection's stored OAuth token, when a Unified API does not cover the operation needed. |
| SMS API | communications | 5 | Send, list, retrieve, update, and delete SMS messages across Twilio, MessageBird, Vonage, and Plivo through one unified API. |

## Which API to use

| Need | API | Why |
| --- | --- | --- |
| Work with sales leads across CRMs | lead | The Lead API is a focused CRUD interface for the single lead resource across Salesforce, HubSpot, Pipedrive, and Zoho. |
| Work with full CRM records (contacts, companies, opportunities, pipelines) | crm | The CRM API covers companies, contacts, opportunities, pipelines, activities, and notes, not just the lead object. |
| Manage employees, departments, and time-off | hris | The HRIS API handles the employee lifecycle and time-off across BambooHR, Gusto, Workday, ADP, and Rippling. |
| Manage recruiting jobs, applicants, and offers | ats | The ATS API covers the recruiting hand-off (jobs, applicants, applications, offers) across Greenhouse, Lever, and Workable, separate from HRIS employee records. |
| Read orders and products from online storefronts | ecommerce | The Ecommerce API reads orders, products, and customers across Shopify, WooCommerce, and BigCommerce. |
| Take in-person orders and capture payments at a till | pos | The POS API handles in-person orders, payments, and merchant catalog across Square, Clover, Lightspeed, Toast, and Shopify POS, not online storefronts. |
| Call a provider feature no Unified API covers | proxy | The Proxy API forwards raw HTTP requests to a connector's native API using the stored OAuth token when a Unified API does not expose the operation. |

## Cross-API use cases

### Authorise a connection, then act on it

Use Vault to create or confirm a customer's OAuth connection, then read or write records through the matching Unified API without ever handling the downstream credential.

Example prompt: Create a Vault session for the consumer, confirm the CRM connection is authorised, then list contacts and open opportunities through the CRM API.

### Reconcile orders to invoices across platforms

Read completed orders from the storefronts a merchant runs, then create or match invoices and payments in their accounting platform through one schema each side.

Example prompt: List recent orders through the Ecommerce API, then create matching invoices and record payments through the Accounting API for the connected ledger.

### Hire-to-onboard hand-off

Read accepted offers from the applicant tracking system, then create the corresponding employee and time-off records in the HRIS.

Example prompt: Read accepted offers through the ATS API, then create the new employee record and initial time-off balance through the HRIS API.

### Notify on new tickets over SMS

Subscribe to issue-tracking events, then send an outbound SMS through the connected provider when a matching ticket is created.

Example prompt: Poll or subscribe to new tickets through the Issue Tracking API, then send a notification through the SMS API to the on-call number.

## Why Jentic

- **Setup:** Wiring Apideck by hand means configuring the Authorization, app-id, and consumer-id headers, learning each Unified API's schema, and managing Vault connections yourself. Through Jentic you install Jentic One once, import the Apideck APIs you need from the Jentic directory, store the key once, and your agent calls any of them.
- **Permission scoping:** Each Apideck API exposes distinct read and write operations, so your own rules in Jentic One scope the agent to exactly the operations you list, such as listing invoices or reading a CRM pipeline while leaving out writes. The agent only calls what you allow, whether that is one API or several across the portfolio.
- **Credential handling:** Your single Apideck key is stored once, encrypted, by your own Jentic One instance and injected at execution time across every Apideck API. It never enters the agent's prompt, logs, or context, and the downstream OAuth tokens stay inside Apideck Vault.
- **Discovery method:** Agents search the Jentic directory by intent such as 'list open invoices' or 'authorise a CRM connection', and Jentic returns the matching Apideck operation with its input schema, so the agent picks the right API and endpoint without browsing the reference docs.

## Related vendors

- **Merge** — Also offers unified APIs across HRIS, ATS, CRM, accounting, and ticketing categories.
- **Nango** — Provides managed OAuth and unified integration access to many SaaS APIs, overlapping the Vault connection model.
- **Finch** — Unified API focused on HRIS and payroll systems, adjacent to the Apideck HRIS and ATS APIs.
- **Plaid** — Aggregates many financial institutions behind one API, a comparable pattern in the finance category.

## FAQ

### What does Apideck provide across its APIs?

Apideck provides Unified APIs that map one normalised schema onto many SaaS platforms in a category. Instead of integrating Xero, QuickBooks, and NetSuite separately, an app calls the Accounting API once; the same pattern applies to CRM, HRIS, ATS, file storage, POS, ecommerce, support, leads, issue tracking, and SMS.

### Do all Apideck APIs share one credential?

Yes. Every Unified API uses the same Apideck Authorization bearer key plus an app-id and consumer-id header. The per-customer OAuth connection to the downstream platform is managed in Vault, so one Apideck credential works across the whole portfolio.

### How does an agent authorise access to a customer's downstream platform?

Authorisation runs through the Vault API, which creates connection sessions, imports or refreshes OAuth tokens, and tracks which consumer a connection belongs to. Every other Unified API call is routed against a Vault connection, so the calling agent never sees the platform's own credentials.

### What if a Unified API does not cover the operation I need?

Use the Proxy API. It forwards a raw HTTP request to the connector's native API using the OAuth token Vault already holds, so an agent can reach a provider-specific feature that the normalised schema does not expose.

### How does an agent know which connectors and resources are available?

The Connector API lists every connector, the Unified APIs each one implements, and the schema for any resource, and the Ecosystem API exposes read-only marketplace listings and categories. Together they let an agent check coverage before prompting a customer to authorise.

### Can an agent be notified when data changes?

Yes. The Webhook API manages subscriptions to events emitted by the Unified APIs, replays deliveries, and exposes event logs, so an agent can react to changes across CRM, HRIS, accounting, and other connectors.

### Which API should I use for leads versus full CRM records?

The Lead API is a focused CRUD interface for the single lead resource across CRMs. For companies, contacts, opportunities, pipelines, and activities, use the broader CRM API instead.