Registry / crm / eloqua-rest-api

eloqua-rest-api

library1.0.18jsnpmunverified

A TypeScript client for Oracle Eloqua's REST API. Currently at v1.0.18, maintained actively with regular releases. Provides typed methods for contacts, accounts, emails, campaigns, and other Eloqua objects. Key differentiators include comprehensive TypeScript support, promise-based interface, and built-in retry/rate-limiting handling. Supports both CommonJS and ESM imports.

crm

npm install eloqua-rest-api

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · ELOQUA-REST-API

eloqua-rest-api

crmjavascriptv1.0.18

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

EloquaClient

✓ import { EloquaClient } from 'eloqua-rest-api'

✗ import EloquaClient from 'eloqua-rest-api'

Named export, not default. TypeScript types included.

Contact

✓ import { Contact } from 'eloqua-rest-api'

✗ const { Contact } = require('eloqua-rest-api')

Type import for TypeScript users.

EloquaConfig

✓ import { EloquaConfig } from 'eloqua-rest-api'

✗ const EloquaConfig = require('eloqua-rest-api').EloquaConfig

Configuration interface for initializing client.

Shows how to create a client, authenticate, and search for contacts using the Eloqua API.

import { EloquaClient } from 'eloqua-rest-api'; const client = new EloquaClient({ company: 'yourcompany', username: 'apiuser@company.com', password: process.env.ELOQUA_PASSWORD ?? '' }); async function main() { try { const contacts = await client.contacts.search({ email: 'test@example.com' }); console.log('Found contacts:', contacts); } catch (error) { console.error('API call failed:', error); } } main();

Debug

Known issues

gotchaThe client uses basic authentication over HTTPS; credentials are sent in every request. Do not expose credentials client-side.

fix

Always keep credentials in environment variables or a secure vault.

affects: >=1.0.0

deprecatedThe 'bulk' methods are deprecated in v1.0.15+ in favor of the standard CRUD methods.

fix

Use client.contacts.create, .update, .delete instead of client.bulk.contacts.*

affects: >=1.0.15

breakingResponse format changed in v1.0.10: 'totalResults' is now under 'meta' object rather than at root.

fix

Access response.meta.totalResults instead of response.totalResults.

affects: >=1.0.10 <1.1.0

gotchaRate limiting: Eloqua imposes API rate limits; the client will retry automatically on 429 but may cause delays.

fix

Consider implementing your own queueing for high-volume calls.

affects: >=1.0.0

deprecatedNode.js 10 support dropped in v1.0.14. Requires Node >= 12.

fix

Upgrade Node.js to version 12 or later.

affects: >=1.0.14

Errors

Common errors & fixes

Error: getaddrinfo ENOTFOUND api.eloqua.com

DNS resolution failure for Eloqua API domain

fix

Check network connectivity and ensure api.eloqua.com resolves correctly.

TypeError: Cannot read property 'data' of undefined

The client threw a network error but caught it; response object is undefined

fix

Wrap calls in try/catch and check network issues or API availability.

Error: Request failed with status code 401

Invalid credentials or expired password

fix

Verify company name, username, and password. Ensure API user has appropriate permissions.

TypeError: client.contacts.search is not a function

Using incorrect version of the library where the method name changed or is not exposed

fix

Update to latest version (npm install eloqua-rest-api@latest) and check documentation for current methods.

Upgrade

Version history

1.0.18latest on npm

Audit

Dependencies

axiosrequiredHTTP client used for API requests

Agent activity

37 hits · last 30 days

node

OpenAI (training)

Resources

githubhttps://github.com/themehrdad/eloqua-rest-api ↗

packageeloqua-rest-api ↗

homepagehttps://github.com/themehrdad/eloqua-rest-api#readme ↗