How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Encharge Custom Objects API

The Custom Objects API from Encharge — 18 operation(s) for creating, reading, searching and associating custom objects and companies.

Encharge Custom Objects API is one of 15 APIs that Encharge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Objects and Customer Data. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 18 operations across 11 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.encharge.io/v1.

18 operations 11 paths 2 schemas 3 DELETE9 GET2 PATCH3 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.encharge.io/v1
Authentication
API Key, API Key, OAuth 2.0
Contact
License
MIT
Resource Areas
1

Authentication & Security 3

Encharge Custom Objects API declares 3 security schemes for authenticating requests. An API key is passed in the header as X-Encharge-Token (apiKeyHeader). An API key is passed in the query as token (apiKeyQuery). It supports OAuth 2.0 (oauth2) using the authorizationCode flow.

  • apiKeyHeader — You can use API key authentication if you are using the API for your Encharge account. If you are building an app for others to use, please use the OAuth2 auth…
  • apiKeyQuery — You can use API key authentication if you are using the API for your Encharge account. If you are building an app for others to use, please use the OAuth2 auth…
  • oauth2 — The Encharge API uses OAuth 2 with the authorization code flow. Get for your OAuth credentials (Client ID and Client Secret) by filling out [this form](https:/…

Paths & Operations 18

Across 11 paths, the API surfaces 18 operations — 3 DELETE, 9 GET, 2 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

CustomObjects 18
GET
/objects/{objectName}
Get multiple custom objects/companies.
GetCustomObjects 6 params → 200
POST
/objects/{objectName}
Create new custom objects/companies.
CreateCustomObjects 1 param body → 200
PUT
/objects/{objectName}
Create or Update (Upsert) a custom object/company.
CreateOrUpdateCustomObjects 1 param body → 200
GET
/objects/{objectName}/segments/{segmentId}
Get custom objects/companies in a segment.
GetCustomObjectsInSegment 7 params → 200
GET
/objects/{objectName}/count
Get custom objects/companies count.
GetCustomObjectsCount 1 param → 200
GET
/objects/{objectName}/segments/{segmentId}/count
Get count of custom objects/companies in a segment.
GetCustomObjectsInSegmentCount 2 params → 200
GET
/objects/{objectName}/search
Search custom objects/companies by their searchable fields
SearchCustomObjects 5 params → 200
GET
/objects/{objectName}/{id}
Get custom object/company by id
GetCustomObjectById 2 params → 200
PATCH
/objects/{objectName}/{id}
Update custom object/company.
UpdateCustomObject 2 params body → 200
DELETE
/objects/{objectName}/{id}
Remove custom object/company by Id
DeleteCustomObject 2 params → 204
GET
/objects/{objectName}/externalId/{externalId}
Get custom object/company by external ID
GetCustomObjectByExternalId 2 params → 200
PATCH
/objects/{objectName}/externalId/{externalId}
Update custom object/company by external ID
UpdateCustomObjectByExternalId 2 params body → 200
DELETE
/objects/{objectName}/externalId/{externalId}
Remove custom object/company by external Id
DeleteCustomObjectByExternalId 2 params → 204
GET
/objects/{objectName}/{id}/associations/{associationId}
Get objects by association with given custom object
GetObjectsByAssociation 8 params → 200
GET
/objects/{objectName}/{id}/associations
Retrieve all objects associated in any way with a given custom object
GetAllAssociatedObjects 3 params → 200
POST
/objects/{objectName}/{id}/associations/default/{targetObjectName}/{targetId}
Associate a custom object with another object, using the default association. If there is only one association between the objects (e.g. a contact and a company), you might use this endpoint to assoc…
AssociateObjectsByDefaultAssociation 4 params → 201
POST
/objects/{objectName}/{id}/associations/{associationId}/{targetId}
Associate an object with another object
AssociateCustomObjects 4 params → 201
DELETE
/objects/{objectName}/{id}/associations/{associationId}/{targetId}
Remove association between objects
RemoveCustomObjectsAssociation 4 params → 204

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed is ICustomObjectCreatable (2 properties). Each schema is shown below with its type and property counts.

CustomObject
This is the base unproxied enduser class. It shouldn't be used without a proxy as defined below.
ICustomObjectCreatable
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

encharge-customobjects-api-openapi.yml Raw ↑

Other APIs Encharge publishes across the network.

Encharge Transactional Email API
Encharge Ingest API
Encharge Account API
Encharge Broadcasts API
Encharge Custom Objects Schema API
Encharge Email Templates API
Encharge Folders API
Encharge People API
Encharge Person Fields API
Encharge Segments API
Encharge Email Domain Settings API
Encharge Tags API
Where this information came from

This is an independent, third-party profile of Encharge Custom Objects API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.