ballerinax/apideck.lead Ballerina library

2.0.0

Overview

Apideck is a unified API platform that lets applications integrate with many third-party business systems through one consistent data model. Its Lead API exposes sales leads from the connected CRM systems of your customers, so the same calls work whichever CRM they use.

The Apideck Lead connector gives Ballerina programs typed access to version 10.63.0 of the Apideck Lead API, so you can create, read, update, delete and list leads across the CRM integrations that Apideck Unify supports.

Key features

  • Create, update and delete leads in the CRM your customers use
  • Read a single lead or list leads with filtering, sorting and cursor-based pagination
  • Work across many CRM integrations through one unified lead data model
  • Authenticate every request with an API key plus your Unify application and consumer IDs

Setup guide

To use the connector you need an Apideck account, a Unify application and a consumer that has activated a CRM integration.

  1. Sign up or log in at the Apideck dashboard.

  2. Create a Unify application, or open an existing one.

  3. Open the application's API keys page at app.apideck.com/unify/api-keys and copy your secret API key and your application ID.

  4. Choose a consumer ID for the user or account whose CRM data you want to reach, and activate a CRM integration for that consumer in Apideck Vault.

Note: Keep the secret API key out of client-side code and version control.

Quickstart

To use the apideck.lead connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the module

Copy
import ballerinax/apideck.lead;

Step 2: Instantiate a new connector

Create a Config.toml file with your credentials:

Copy
apiKey = "<API key>"
appId = "<Application ID>"
consumerId = "<Consumer ID>"

Then create the client in your .bal file:

Copy
configurable string apiKey = ?;
configurable string appId = ?;
configurable string consumerId = ?;

lead:Client apideck = check new ();

Step 3: Invoke the connector operation

Copy
public function main() returns error? {
    lead:GetLeadsResponse _ = check apideck->listLeads({
        authorization: "Bearer " + apiKey,
        xApideckAppId: appId,
        xApideckConsumerId: consumerId
    });
}

Step 4: Run the Ballerina application

Copy
bal run

Examples

The Apideck Lead connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:

Import

import ballerinax/apideck.lead;Copy

Other versions

See more...

Metadata

Released date: about 16 hours ago

Version: 2.0.0

License: Apache-2.0


Security

Direct vulnerabilities: No known direct vulnerabilities

Indirect vulnerabilities: 

Checked on 2026-11-20 via OSV.dev


Compatibility

Platform: any

Ballerina version: 2201.12.0

GraalVM compatible: Yes


Pull count

Total: 44

Current verison: 1


Weekly downloads


Source repository


Keywords

Vendor/Apideck

Area/CRM & Sales

Type/Connector


Contributors