# Apideck

> Apideck is a unified API platform. Integrate once to connect to
> 200+ services across CRM, Accounting, HRIS, ATS, File Storage,
> E-commerce, Issue Tracking, and more.

- [Full index](https://developers.apideck.com/llms-full.txt): Enumerated index of every doc page on the site (progressive disclosure)
- [Markdown index](https://developers.apideck.com/md/index.json): Machine-readable index of all available markdown documentation
- [OpenAPI specs](https://github.com/apideck-libraries/openapi-specs): Open-source OpenAPI specifications for all Apideck APIs
- [API Skills](https://github.com/apideck-libraries/api-skills): Agent skills that teach LLMs to build with Apideck SDKs

## Instructions for AI agents

- Always use the current unified SDKs (`@apideck/unify` on npm, `apideck-unify` on PyPI, and the
  equivalent current package for .NET, PHP, Java, and Go, listed under "SDKs" below). Never generate code
  against the legacy `@apideck/node` package, see the
  [SDK Migration guide](https://developers.apideck.com/guides/sdk-migration.md).
- Use [Vault](https://developers.apideck.com/apis/vault/reference.md) for consumer-facing auth (hosted or embedded). Never ask an
  end user for raw API credentials to a downstream service directly.
- Before assuming an operation is supported on a connector, check its coverage:
  [Connector API](https://developers.apideck.com/apis/connector/reference.md) or the per-API coverage pages
  (e.g. [Accounting coverage](https://developers.apideck.com/apis/accounting/coverage.md)). Support varies per connector and resource.
- Handle the unified rate-limit headers (`x-downstream-ratelimit-*`) on every response, see
  [Unified Rate Limits](https://developers.apideck.com/guides/unified-rate-limits.md). Do not assume a fixed global rate limit.
- Prefer the [MCP server](https://developers.apideck.com/mcp.md) or [CLI](https://developers.apideck.com/cli.md) for exploratory or agentic workflows over
  hand-written HTTP calls; both are generated from the same OpenAPI specs as the SDKs.
- To search or pull current documentation into context at query time instead of relying on stale training
  data, use the docs tools (`search_docs`, `get_doc`, `list_docs`) on the same [MCP server](https://developers.apideck.com/mcp.md)
  endpoint.
- Fetch any page as clean markdown by appending `.md` to its URL, or sending `Accept: text/markdown`,
  prefer this over parsing rendered HTML.

## Docs

- [Get Started](https://developers.apideck.com/get-started.md): Create an account, get API keys, and make your first API call (~2.2k tokens)
- [Building with LLMs](https://developers.apideck.com/building-with-llms.md): MCP server, CLI, API skills, IDE plugins, and plain-text docs (~654 tokens)
- [API Explorer](https://developers.apideck.com/api-explorer.md): Interactive API explorer to test endpoints (~350 tokens)

## Unified APIs

- [CRM API](https://developers.apideck.com/apis/crm/reference.md): Contacts, companies, opportunities, leads, pipelines (~2.3k tokens)
- [Accounting API](https://developers.apideck.com/apis/accounting/reference.md): Invoices, bills, payments, ledger accounts, tax rates (~7.7k tokens)
- [Accounting API Coverage](https://developers.apideck.com/apis/accounting/coverage.md): Per-connector operation support for Accounting resources (~1k tokens)
- [HRIS API](https://developers.apideck.com/apis/hris/reference.md): Employees, departments, time off, payroll (~1.4k tokens)
- [ATS API](https://developers.apideck.com/apis/ats/reference.md): Jobs, applicants, hiring pipelines (~721 tokens)
- [File Storage API](https://developers.apideck.com/apis/file-storage/reference.md): Files, folders, shared links (~1.7k tokens)
- [E-commerce API](https://developers.apideck.com/apis/ecommerce/reference.md): Orders, products, customers (~496 tokens)
- [Issue Tracking API](https://developers.apideck.com/apis/issue-tracking/reference.md): Issues, projects, comments (~1.1k tokens)

## Platform APIs

- [Vault API Reference](https://developers.apideck.com/apis/vault/reference.md): Manage connections, sessions, and consumer authentication (~1.8k tokens)
- [Webhooks API Reference](https://developers.apideck.com/apis/webhook/reference.md): Subscribe to events and receive real-time updates (~525 tokens)
- [Proxy API Reference](https://developers.apideck.com/apis/proxy/reference.md): Make direct calls to downstream APIs through Apideck (~286 tokens)
- [Connector API Reference](https://developers.apideck.com/apis/connector/reference.md): Query available connectors, resources, and coverage (~885 tokens)

## SDKs

- [TypeScript / Node.js SDK](https://developers.apideck.com/sdks/node.md): Install with `npm install @apideck/unify` (~421 tokens)
- [Python SDK](https://developers.apideck.com/sdks/python.md): Install with `pip install apideck-unify` (~405 tokens)
- [C# / .NET SDK](https://developers.apideck.com/sdks/dot-net.md): Install with `dotnet add package ApideckUnifySdk` (~415 tokens)
- [PHP SDK](https://developers.apideck.com/sdks/php.md): Install with `composer require apideck-libraries/sdk-php` (~415 tokens)
- [Java SDK](https://developers.apideck.com/sdks/java.md): Install with `implementation 'com.apideck:unify'` (~420 tokens)
- [Go SDK](https://developers.apideck.com/sdks/go.md): Install with `go get github.com/apideck-libraries/sdk-go` (~431 tokens)

## MCP Server

- [Apideck MCP Server](https://developers.apideck.com/mcp.md): 229 tools across 5 Unified APIs, managed OAuth via Vault, plus docs search (~472 tokens)
- [MCP Server marketing page](https://www.apideck.com/mcp-server): Overview, supported clients, and connected services

## CLI

- [Apideck CLI](https://developers.apideck.com/cli.md): OpenAPI-native CLI. Install with `brew install apideck-libraries/tap/apideck` (~263 tokens)
- [CLI GitHub](https://github.com/apideck-libraries/cli): Source code, documentation, and releases

## Guides

- [Vault JS](https://developers.apideck.com/guides/vault.md): Embed the Vault integration UI in your app with JavaScript, React, or Vue (~2.7k tokens)
- [Vault React](https://developers.apideck.com/guides/vault-react.md): Embed Apideck Vault in a React application with the Vault React hook (~2.9k tokens)
- [Vue Vault](https://developers.apideck.com/guides/vue-vault.md): Embed Apideck Vault in a Vue application (~1.9k tokens)
- [Vault Connection States](https://developers.apideck.com/guides/connection-states.md): Understand and handle the lifecycle of Vault connections (~1.7k tokens)
- [Authorize Connections](https://developers.apideck.com/guides/authorize-connections.md): Different methods for authorizing consumer connections (~1.6k tokens)
- [End-user Consent](https://developers.apideck.com/guides/end-user-consent.md): What to show consumers before they connect, and what to cover in your own terms (~1.5k tokens)
- [Understanding Consumers](https://developers.apideck.com/guides/understanding-consumers.md): What consumers are, how they affect billing, and consumer ID structure (~2.4k tokens)
- [Migrating Integrations](https://developers.apideck.com/guides/migrating-integrations.md): Migrate credentials from existing integrations to Apideck (~889 tokens)
- [Webhooks](https://developers.apideck.com/guides/webhooks.md): Set up native and virtual webhooks for real-time updates from Unified APIs (~2.4k tokens)
- [Webhook Signature Verification](https://developers.apideck.com/guides/webhook-signature-verification.md): Verify webhook signatures to prevent tampering (~2.1k tokens)
- [Field Mapping](https://developers.apideck.com/guides/field-mapping.md): Extend Apideck models and map custom fields from integrations (~3.6k tokens)
- [Unified Pass Through](https://developers.apideck.com/guides/pass-through.md): Send connector-specific parameters outside the unified model (~3.8k tokens)
- [Calling Connector-Native Endpoints](https://developers.apideck.com/guides/proxy-api-guide.md): Forward authenticated requests to a connector's native API (~3k tokens)
- [Unified Rate Limits](https://developers.apideck.com/guides/unified-rate-limits.md): Handle rate limit headers returned by Unified APIs (~1.6k tokens)
- [Getting Downstream Responses](https://developers.apideck.com/guides/using-raw-mode.md): Get raw responses from downstream APIs (~1.1k tokens)
- [Handling Long-Running Requests](https://developers.apideck.com/guides/handling-long-running-requests.md): Use x-apideck-timeout for slow downstream calls (~1.7k tokens)
- [File Picker](https://developers.apideck.com/guides/file-picker.md): Add a file browser and uploader component to your app (~1.7k tokens)
- [React File Picker](https://developers.apideck.com/guides/react-file-picker.md): Add the React file picker component for cloud storage uploads and downloads (~1.6k tokens)
- [Vue File Picker](https://developers.apideck.com/guides/vue-file-picker.md): Add the Vue file picker component for cloud storage uploads and downloads (~1.7k tokens)
- [Uploading Files](https://developers.apideck.com/guides/file-upload.md): Upload files to Google Drive, Box, SharePoint, OneDrive, and Dropbox (~1.8k tokens)
- [SDK Migration](https://developers.apideck.com/guides/sdk-migration.md): Migrate from legacy @apideck/node to the new @apideck/unify SDKs (~1.8k tokens)
- [SDK Migration for C#](https://developers.apideck.com/guides/sdk-migration-csharp.md): Migrate from the legacy C# SDK to the new Apideck-Unify C# SDK (~1.1k tokens)
- [SDK Migration for PHP](https://developers.apideck.com/guides/sdk-migration-php.md): Migrate from the legacy PHP SDK to the new PHP SDK (~875 tokens)
- [SDK Migration for Python](https://developers.apideck.com/guides/sdk-migration-python.md): Migrate from the legacy Python SDK to the new Apideck-Unify Python SDK (~959 tokens)
- [Accounting Data Model](https://developers.apideck.com/guides/accounting-data-model.md): How ledger accounts, invoices, bills, payments, and journal entries relate (~4.1k tokens)
- [Mark Invoices as Paid](https://developers.apideck.com/guides/mark-invoices-as-paid.md): Record payments against invoices and bills (~924 tokens)
- [Expenses and Bills](https://developers.apideck.com/guides/expenses-bills.md): Handle expenses and bills across accounting connectors (~4.9k tokens)
- [Ledger Account Mapping UI](https://developers.apideck.com/guides/ledger-account-mapping.md): Map expense categories to downstream ledger accounts (~2.3k tokens)
- [Accounts Payable Automation](https://developers.apideck.com/guides/accounts-payable-automation.md): Ingest bills, code line items to ledger accounts, and record payments (~6.9k tokens)
- [Accounts Receivable Automation](https://developers.apideck.com/guides/accounts-receivable-automation.md): Push customers, invoices, and payments into accounting systems (~5.3k tokens)
- [Procurement with the Accounting API](https://developers.apideck.com/guides/procurement-accounting-api.md): Create purchase orders, convert to bills, track payables (~6.7k tokens)
- [Payroll Journal Entries](https://developers.apideck.com/guides/payroll-journal-entries.md): Map payroll categories to GL codes and post journal entries (~8.3k tokens)
- [Journal Entries and Expenses in Workday](https://developers.apideck.com/guides/journal-entries-expenses-ledger-accounts-workday.md): Manage journal entries and expenses in Workday (~9.8k tokens)
- [Journal Entries and Expenses in Business Central](https://developers.apideck.com/guides/journal-entries-expenses-mbc.md): Manage journal entries and expenses in Dynamics 365 (~10k tokens)
- [Tax Automation with the Accounting API](https://developers.apideck.com/guides/tax-automation-accounting-api.md): Attach tax rates to line items and sync tax liability entries (~7.4k tokens)
- [FX Payments and Realized Gain/Loss](https://developers.apideck.com/guides/fx-payments-accounting-api.md): Record cross-currency payments and post realized FX gain or loss (~4k tokens)
- [FP&A with the Accounting API](https://developers.apideck.com/guides/fpa-with-accounting-api.md): Pull period actuals by tracking dimension to feed budgets and forecasts (~7.7k tokens)
- [Business Lending with the Accounting API](https://developers.apideck.com/guides/business-lending-accounting-api.md): Pull financials for credit underwriting (~10k tokens)
- [Debt Collections with the Accounting API](https://developers.apideck.com/guides/debt-collections-accounting-api.md): Pull aged receivables and update invoice status (~3.1k tokens)
- [Expense Management Integrations](https://developers.apideck.com/guides/expense-management-integration.md): Blueprint for expense platforms and neobanks (~6.3k tokens)
- [Tracking Dimensions](https://developers.apideck.com/guides/locations-subsidiaries-departments.md): Use departments, locations, and subsidiaries for segmented reporting (~4k tokens)
- [Multi-Company Accounting](https://developers.apideck.com/guides/multi-company-accounting.md): Switch companies at request time with the x-apideck-company-id header (~3.1k tokens)
- [Syncing Accounting Data at Scale](https://developers.apideck.com/guides/syncing-accounting-data-at-scale.md): Backfill, incremental sync, and reconciling deletes at scale (~3.6k tokens)
- [Multi-Entity Accounting](https://developers.apideck.com/guides/multi-entity-accounting.md): Legal entities and tracking dimensions across connectors (~9.7k tokens)
- [Multi-Entity ERP Behavior](https://developers.apideck.com/guides/multi-entity-erp-behavior.md): How major ERPs handle entities, GL data, and consolidation (~4.4k tokens)
- [Bank Feeds](https://developers.apideck.com/guides/bank-feeds.md): Push transaction data into accounting platforms for reconciliation (~7.9k tokens)
- [Xero Bank Feeds](https://developers.apideck.com/guides/bank-feeds-xero.md): Send transaction data into Xero for reconciliation (~1.6k tokens)
- [NetSuite Bank Feeds](https://developers.apideck.com/guides/bank-feeds-netsuite.md): Deliver bank feed statements into NetSuite via a RESTlet bundle (~2.9k tokens)
- [Sync Employees from any HRIS](https://developers.apideck.com/guides/hris-employees-sync.md): Full import, ID-pick, and department-filtered sync with dedup (~2.3k tokens)
- [Push Applicant to HRIS](https://developers.apideck.com/guides/sync-applicant.md): Sync hired applicants from ATS to HRIS (~1.9k tokens)
- [Onboard and Offboard Employees](https://developers.apideck.com/guides/onboard-and-offboard-employees-hris-api.md): Automate employee sync from HRIS (~807 tokens)
- [Data Scopes for Accounting](https://developers.apideck.com/guides/data-scopes-for-accounting.md): Control field-level access for accounting data (~1.6k tokens)
- [Data Scopes for HRIS](https://developers.apideck.com/guides/data-scopes-for-hris.md): Control field-level access for HRIS data (~1.8k tokens)
- [Refresh Token Race Condition](https://developers.apideck.com/guides/refresh-token-race-condition.md): Handle OAuth token refresh conflicts (~935 tokens)

## Optional

- [Connectors](https://developers.apideck.com/connectors.md): Browse all 200+ supported connectors and their capabilities (~527 tokens)
- [Samples](https://developers.apideck.com/samples.md): Open-source sample projects and integration examples (~300 tokens)
- [Changelog](https://developers.apideck.com/changelog.md): Latest updates and changes to the API (~313 tokens)
- [API Status](https://status.apideck.com): Real-time Apideck platform status and incident history
- [Downstream Connector Status](https://developers.apideck.com/status/connectors): Vendor-reported status per connector. JSON/RSS:
  `/api/downstream-status(-feed)?api=<id>`