apideck-python

Apideck Python SDK Skill

Overview

The Apideck Unified API provides a single integration layer to connect with 200+ third-party services across accounting, CRM, HRIS, file storage, ATS, e-commerce, and more. The official Python SDK (apideck-unify) provides typed clients for all unified APIs.

Installation

pip install apideck-unify

Requires Python 3.9+. Dependencies: httpx, pydantic.

IMPORTANT RULES

• ALWAYS use the apideck-unify SDK. DO NOT make raw httpx/requests calls to the Apideck API.
• ALWAYS pass api_key, app_id, and consumer_id when initializing the client.
• ALWAYS set the APIDECK_API_KEY environment variable rather than hardcoding API keys.
• USE service_id to specify which downstream connector to use (e.g., "salesforce", "quickbooks"). If a consumer has multiple connections for an API, service_id is required.
• USE context managers (with / async with) for client lifecycle management.
• USE the fields parameter to request only the columns you need.
• USE the filter_ parameter (note the trailing underscore) to narrow results server-side.
• ALWAYS handle errors with try/except using models.ApideckError as the base class.

Quick Start

from apideck_unify import Apideck
import os

with Apideck(
    api_key=os.getenv("APIDECK_API_KEY", ""),
    app_id="your-app-id",
    consumer_id="your-consumer-id",
) as apideck:
    res = apideck.crm.contacts.list(
        service_id="salesforce",
        limit=20,
        filter_={"email": "[email protected]"},
    )
    while res is not None:
        for contact in res.data:
            print(contact.name, contact.emails)
        res = res.next()

SDK Patterns

Client Setup

from apideck_unify import Apideck
import os

with Apideck(
    api_key=os.getenv("APIDECK_API_KEY", ""),
    app_id="your-app-id",
    consumer_id="your-consumer-id",
) as apideck:
    # Make API calls here
    pass

The consumer_id identifies the end-user whose connections are being used. In multi-tenant apps, set this per-request or per-user session.