Understanding Connector Coverage and Limitations

Edited

Not every connector supports every field and every operation. This is a fundamental reality of working with a Unified API - each downstream provider has a different data model and different capabilities. This article explains how to understand what's supported, what to expect, and how to handle gaps.


In this article

  • What "coverage" means

  • Connector statuses explained

  • How to check coverage for a specific connector

  • Why some fields are missing from responses

  • What to do when coverage doesn't meet your needs

  • Requesting new connectors or coverage


What "coverage" means

Coverage refers to the specific operations (list, get, create, update, delete) and fields that a connector supports for a given Unified API resource.

For example, within the Accounting Unified API, the Invoices resource might support all CRUD operations for QuickBooks but only read operations for a different connector. Similarly, a field like tracking_categories might be available from Xero but not from MYOB.

This reflects the underlying differences between providers, Apideck maps as much as each provider's API exposes, but can't return data that the provider doesn't make available.

Connector statuses explained

Both Unified APIs and individual connectors have statuses that indicate their maturity:

Status

What it means

Can you use it?

Live

Fully released and thoroughly tested.

Yes - production-ready.

Beta

Early-stage but functional. May have limited coverage.

Yes - usable in production, but expect some gaps.

Auth-only

Available in Vault and the Proxy API, but not mapped to a Unified API yet.

Only via Vault + Proxy API (direct provider calls).

Early Access

Available through an early-access program.

Contact the Apideck sales team for access.

Development

Currently being built.

Not yet available.

Considering

Requested but not yet added to the roadmap.

Not yet available.

Connectors with live or beta status are callable through the Unified API. If a connector you need is in auth-only status, you can still use it via the Proxy API - Apideck handles authentication, and you make direct calls to the provider's native API.

For more detail, see the Connector Statuses guide in the developer docs.

How to check coverage for a specific connector

Before building against a specific connector, always check its coverage.

Using the Coverage page

Visit the Coverage overview in the developer docs. You can select a Unified API (e.g., Accounting), see which connectors support which resources, and drill into a specific connector to see supported fields and operations.

For example, the Accounting coverage page shows exactly which fields are supported for Invoices on QuickBooks vs. Xero vs. NetSuite.

Using the Connector API

You can also check coverage programmatically using the Connector API. This is useful if you want to dynamically show your users which features are available for their specific integration.

Why some fields are missing from responses

When you call a Unified API endpoint, some fields in the response may be null even though you expected data. This is called a "sparse" response, and it usually means one of two things:

  1. The provider doesn't support that field. Apideck's unified data model includes fields that span all providers, but not every provider has an equivalent.

  2. The connector hasn't mapped that field yet. The provider may have the data, but the mapping hasn't been implemented - particularly for beta connectors.

You can verify which fields are supported per connector on the coverage page.

What to do when coverage doesn't meet your needs

If the Unified API doesn't cover a specific operation or field you need, you have three options, each covered in a dedicated section of this help center:

Field Mappings

Field Mappings let you extend the Unified API response with additional fields from the downstream provider. This is the best option when the provider has the data but Apideck's standard model doesn't include it.

See the Field Mappings section for setup guides, including how to add response fields and map custom fields.

Pass Through

The Pass Through feature lets you inject custom parameters into your Unified API requests, useful for sending provider-specific filters or fields alongside a standard call.

See the Pass Through developer guide.

Proxy API

For use cases that go beyond what the Unified API and Field Mappings can handle, the Proxy API lets you make direct calls to the provider's native API while using Apideck for authentication.

See the Proxy API section for guides and connector-specific examples (including SOAP requests for Sage Intacct and Workday, and SQL queries for NetSuite).

Requesting new connectors or coverage

If you need a connector that isn't available yet, or if an existing connector is missing coverage for a resource or field:

  • Visit the Connectors page and use the request feature.

  • Visit the Coverage page for your Unified API and request specific field or resource coverage.

Customers on our Scale and Enterprise plans can influence the roadmap and prioritize connector development. Reach out to our sales team to discuss your requirements.


Related resources:

Was this article helpful?

Sorry about that! Care to tell us more?

Thanks for the feedback!

There was an issue submitting your feedback
Please check your connection and try again.