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

Conga Object Definition API

The Object Definition API from Conga — 6 operation(s) for object definition.

Conga Object Definition API is one of 347 APIs that Conga publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Object Definition. The published artifact set on APIs.io includes an OpenAPI specification, authentication docs, and rate-limit docs.

This API exposes 8 operations across 6 paths, and defines 35 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://rls.congacloud.com, https://preview-rls09.congacloud.com.

8 operations 6 paths 35 schemas 2 GET1 PATCH3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://rls.congacloud.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Conga Object Definition API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 8

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

Object Definition 8
GET
/api/schema/v1/objects
List all object names
6 params → 200400500
POST
/api/schema/v1/objects
Define a new object schema
body → 201400500
POST
/api/schema/v1/objects/customschema/import
Import custom schema
body → 201400500
POST
/api/schema/v1/objects/{lookupObjectName}/lookup-criteria/validate
Validate lookup criteria
1 param body → 202400500
GET
/api/schema/v1/objects/{objectName}
Get a translated schema definition
2 params → 200400404500
PUT
/api/schema/v1/objects/{objectName}
Update a schema definition
1 param body → 200400404500
PATCH
/api/schema/v1/objects/{objectName}/deprecate
Deprecate an object
1 param → 200400500
PUT
/api/schema/v1/objects/{objectName}/shared/{isShared}
Set an object's shared status
2 params → 200400500

Schemas 35

The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are FieldMetadata (40 properties), FieldMetadataCreateRequest (30 properties), ObjectMetadata (26 properties), ObjectMetadataCreateRequest (11 properties). Each schema is shown below with its type and property counts.

Attributes
object
3 properties
ControllingDependentPicklistEntryCreateRequest
object
Controlling dependent picklist entry
2 properties
AttributesCreateRequest
object
2 properties
DataType
string
IdentifierType
string
ObjectInfo
object
7 properties
FieldMetadataCreateRequest
object
30 properties
PicklistMetadata
object
4 properties
AliasFieldMetadata
object
2 properties
PicklistMetadataCreateRequest
object
3 properties
StringStringDictionaryAPIResponse
object
10 properties
ComplexFieldMetadataCreateRequest
object
2 properties
ComplexFieldMetadata
object
2 properties
ObjectTypeFilter
string
DependentPicklistMetadata
object
5 properties
ObjectMetadataCreateRequest
object
Object's metadata create request
11 properties
ComplexFieldMetadataEntryCreateModel
object
8 properties
IndexMetadata
object
2 properties
TtlFieldMetadata
object
TTL (Time To Live) field metadata class that defines the properties related to the TTL field used for data expiration in the data store.
2 properties
PicklistEntryCreateRequest
object
3 properties
SortDirection
string
ErrorDetail
object
1 property
ObjectMetadataUpdateRequest
object
7 properties
ObjectType
string
ControllingAndDependentPicklistEntry
object
2 properties
ObjectMetadata
object
Object's metadata
26 properties
FieldMetadata
object
40 properties
AliasFieldDefinitionDetail
object
3 properties
IndexMetadataDetail
object
1 property
LookupObject
object
2 properties
ObjectMetadataAPIResponse
object
10 properties
PicklistEntry
object
4 properties
ObjectInfoListAPIResponse
object
10 properties
DependentPicklistMetadataRequest
object
4 properties
HttpStatusCode
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

conga-object-definition-api-openapi.yml Raw ↑

Other APIs Conga publishes across the network.

Conga Advantage Platform MCP Server
Conga GraphQL API
Conga 2. Order Actions API
Conga 3. Order Line Items API
Conga Account API
Conga Account Attachments Blacklist API
Conga Account Attachments Whitelist API
Conga Account Designer Settings API
Conga Account Email Reminder Settings API
Conga Account Feature Settings API
Conga Account Package Settings API
Conga Account Roles API
Where this information came from

This is an independent, third-party profile of Conga Object Definition 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.