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

# Apideck Connector API

The Apideck Connector API is the meta-API that describes the integrations Apideck Unify supports. It exposes the list of connectors (Salesforce, HubSpot, Xero, Greenhouse, Slack, etc.), the unified APIs each connector implements (CRM, ATS, Accounting, and so on), the documentation pages, and the schema and example payload for any resource. Builders use it to render in-app integration catalogues, check coverage before they prompt a customer to authorise, and inspect the schema for an operation at runtime.

## For AI agents

Inspect Apideck Unify's connector catalogue: list connectors, see which unified APIs each implements, read documentation, and fetch the schema for any resource.

## Scope

Does not perform business operations on connected systems - use for inspecting the Apideck Unify connector catalogue, schemas, and coverage only.

## Capabilities

- List the connectors Apideck Unify supports along with logo, status, and supported unified APIs
- Read the unified APIs (CRM, ATS, Accounting, etc.) and which connectors expose each one
- Inspect the resource list for a connector or unified API to see what is supported
- Fetch the documentation Markdown for a specific connector
- Read the JSON schema for any resource on a specific connector
- Read example payloads for a resource on a specific connector

## Use cases

### In-App Integration Catalogue

Render a live integration catalogue inside an application without hard-coding the connector list. /connector/connectors returns logos, names, statuses, and supported unified APIs, so the in-app picker shows whatever Apideck currently supports, including new connectors added since the build. Common pattern for SaaS apps that want to advertise depth of integration without a content-update release for each new connector.

Example prompt: GET /connector/connectors and render each connector with logo, name, and the unified APIs it implements

### Pre-Auth Coverage Check

Before prompting a customer to authorise a connector, check whether the connector implements the resources you actually need. /connector/apis/{id}/resources/{resource_id}/coverage returns the connector list that supports a resource, so an app can warn the customer that, for example, NetSuite supports Invoices but not Aged Debtors before they grant access.

Example prompt: GET /connector/apis/accounting/resources/aged-debtors/coverage to see which accounting connectors support the Aged Debtors report

### Runtime Schema Inspection

Before serializing a request body, fetch the live schema for the resource and connector pair. /connector/connectors/{id}/resources/{resource_id}/unified_api/{api_id}/schema returns the JSON schema, and /example returns a sample payload so a code generator or LLM tool can validate input shape against the actual connector definition rather than a stale local copy.

Example prompt: GET /connector/connectors/hubspot/resources/contact/unified_api/crm/schema to fetch the live HubSpot contact schema

### AI Agent Capability Discovery

Give an AI agent a tool to ask 'which connectors can do X?' before it picks a unified API. Through Jentic, the agent searches for an intent like 'list crm connectors' and gets the matching Connector API operation. The agent uses the response to recommend the right connector to the user before authorisation.

Example prompt: Search Jentic for 'list connectors that support crm', load the /connector/apis/{id} schema with id=crm, and execute to return the supporting connector list

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /connector/connectors | List all connectors Apideck supports |
| GET | /connector/connectors/{id} | Read a single connector by id |
| GET | /connector/connectors/{id}/docs/{doc_id} | Read the documentation page for a connector |
| GET | /connector/connectors/{id}/resources/{resource_id}/unified_api/{api_id}/schema | Fetch the JSON schema for a resource on a connector |
| GET | /connector/connectors/{id}/resources/{resource_id}/unified_api/{api_id}/example | Fetch an example payload for a resource on a connector |
| GET | /connector/apis | List Apideck unified APIs |
| GET | /connector/apis/{id}/resources/{resource_id}/coverage | Show connector coverage for a resource of a unified API |

## Key resources

- **Connectors** — List and inspect the connectors Apideck Unify supports
- **APIs** — List the unified APIs (CRM, ATS, Accounting, and so on) and which connectors implement each
- **Connector Resources** — List the resources a connector exposes under each unified API
- **API Resources** — List the resources a unified API defines and connector coverage per resource
- **Connector Docs** — Read the Markdown documentation for a connector
- **Connector Resource Schema** — Fetch the JSON schema for a connector resource

## Why Jentic

- **Setup:** Wiring the Apideck Connector API by hand means setting up its API key headers, learning the connector, resource, and schema shapes, and paging the catalogue yourself. Through Jentic you install once, import Apideck Connector from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** The Apideck Connector API puts the connector id in the URL path (/connector/connectors/{id}/...), so a rule can pin your agent to one connector: it can read that connector's docs and schemas and nothing else. This API is inspection-only, so no business operations run against connected systems regardless of the operations you allow.
- **Credential handling:** Your Apideck API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'inspect a connector's schema' or 'check API coverage for a resource', and Jentic returns the matching Apideck Connector operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Apideck CRM API** — Apideck CRM unified API consumed via the connectors discovered through this meta-API
- **Apideck Accounting API** — Apideck Accounting unified API consumed via the connectors listed by this meta-API
- **Apideck ATS API** — Apideck ATS unified API consumed via the connectors listed by this meta-API

## FAQ

### What authentication does the Apideck Connector API use?

Apideck requires Authorization with a bearer API key and x-apideck-app-id with your Unify application id. The x-apideck-consumer-id header is required by most Apideck calls but is not needed for the Connector meta-API since it describes integrations, not customer data. Through Jentic all values are stored encrypted in the vault and injected at execution time.

### Which integrations are listed by the Apideck Connector API?

Every connector that Apideck Unify supports across CRM, ATS, Accounting, HRIS, Customer Support, Ecommerce, File Storage, Issue Tracking, Lead, POS, SMS, and Webhook unified APIs. GET /connector/connectors returns the live list with logo URL, status (live, beta, deprecated), and the unified APIs each connector implements.

### Can I fetch the schema for a connector resource at runtime?

Yes. GET /connector/connectors/{id}/resources/{resource_id}/unified_api/{api_id}/schema returns the JSON schema for that resource on that connector. Pair it with the matching /example endpoint to get a sample payload for validation or LLM prompt context.

### What are the rate limits for the Apideck Connector API?

The Connector meta-API enforces standard Apideck Unify rate limits and returns HTTP 429 on throttling. The endpoints are read-only and cacheable, so most apps cache responses for an hour to reduce request volume.

### How do I check connector coverage through Jentic?

Search Jentic for 'check apideck connector coverage', load the /connector/apis/{id}/resources/{resource_id}/coverage schema, and execute with the unified API id (crm, ats, accounting, etc.) and the resource id to see the supporting connector list.

### Is the Apideck Connector API free?

The Connector meta-API is included with any Apideck Unify plan, including the free tier. See https://www.apideck.com/pricing for the current tiers and per-consumer pricing for the data-plane unified APIs.

### Can I limit what my agent is allowed to do with the Apideck Connector API?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use. Since this API carries the connector id in the URL path (/connector/connectors/{id}/...), you can pin the agent to a single connector so it only reads that connector's docs and schemas and nothing else. The Connector API is inspection-only, so even with every operation allowed it never runs a business operation against your connected systems.