Conga

Conga Custom Object API

The Custom Object API from Conga — 9 operation(s) for custom object.

Documentation GitHub OpenAPI

Operations 18

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /api/data/v1/custom-objects/query/parallel Run several custom object queries in parallel · Execute multiple queries #

Ask an LLM

“Can I send multiple custom object queries in one request and get each result back?”

“Is there a way to run queries against different custom objects at the same time?”

Tell an agent

Run these custom object queries in parallel and return each response.

Execute a batch of queries across my custom objects at once.

POST /api/data/v1/custom-objects/query/{objectName} Query a custom object's records · Execute single query #

Ask an LLM

“How do I query records of one custom object with criteria, sorting and grouping?”

“Can a custom object query also return the total record count?”

Tell an agent

Query {object_name} records matching {criteria}.

Select {select} from {object_name}, limit {limit}.

GET /api/data/v1/custom-objects/{objectName} List all records of a custom object · Get all custom object records #

Ask an LLM

“What records exist in a given custom object?”

“Can I page and sort through every record of a custom object?”

Tell an agent

List all records in custom object {object_name}.

Show {object_name} records page {page_number}, sorted by {sort_field}.

POST /api/data/v1/custom-objects/{objectName} Insert one custom object record · Insert a new custom object record #

Ask an LLM

“How do I add a single new record to a custom object?”

“Will inserting a record fail if it already exists?”

Tell an agent

Insert a new record into custom object {object_name}.

Add one {object_name} record and return its payload.

DELETE /api/data/v1/custom-objects/{objectName}/bulk Delete many custom object records · Delete custom object records #

Ask an LLM

“Can I remove a list of records from a custom object in one request?”

“Is there a way to choose the delete behaviour when bulk-removing records?”

Tell an agent destructive · confirm first

Bulk-delete the listed records from custom object {object_name}.

Remove many {object_name} records identified by field {delete_by_field}.

PATCH /api/data/v1/custom-objects/{objectName}/bulk Upsert custom object records · Upsert custom object records #

Ask an LLM

“Can I insert new records and update existing ones in a single call?”

“How does upsert decide between update and insert for a custom object?”

Tell an agent

Upsert these records into custom object {object_name}.

Insert or update {object_name} records keyed on {update_by_field}.

POST /api/data/v1/custom-objects/{objectName}/bulk Insert many custom object records · Insert custom object records #

Ask an LLM

“Can I create a batch of records in a custom object at once?”

“What's the bulk insert option for custom object data?”

Tell an agent

Bulk-insert these new records into custom object {object_name}.

Create many {object_name} records in one request.

PUT /api/data/v1/custom-objects/{objectName}/bulk Update many custom object records · Update custom object records #

Ask an LLM

“Can I update multiple records of a custom object in one call?”

“Is optimistic locking available when bulk-updating records?”

Tell an agent

Bulk-update the listed records in custom object {object_name}.

Update many {object_name} records matched by field {update_by_field}.

DELETE /api/data/v1/custom-objects/{objectName}/by-externalId/{externalId} Delete a custom object record by external ID · Delete a custom object record by externalId #

Ask an LLM

“Can I delete a custom object record using its external ID?”

“Which delete behaviours apply when removing a record by external ID?”

Tell an agent destructive · confirm first

Delete the {object_name} record with external ID {external_id}.

Remove external-ID record {external_id} from {object_name}.

GET /api/data/v1/custom-objects/{objectName}/by-externalId/{externalId} Get a custom object record by external ID · Get a custom object record using externalId #

Ask an LLM

“Can I look up a custom object record using its external ID instead of its record ID?”

“What comes back if a record with that external ID exists?”

Tell an agent

Get the {object_name} record with external ID {external_id}.

Find external ID {external_id} in custom object {object_name}.

PUT /api/data/v1/custom-objects/{objectName}/by-externalId/{externalId} Update a custom object record by external ID · Update a record by externalId #

Ask an LLM

“How do I update a record when I only know its external ID?”

“Can I enforce optimistic locking on an update by external ID?”

Tell an agent

Update the {object_name} record with external ID {external_id}.

Change fields on external-ID record {external_id} in {object_name}.

DELETE /api/data/v1/custom-objects/{objectName}/criteria/bulk Delete custom object records matching criteria · Delete custom object records as per the criteria #

Ask an LLM

“Can I delete all records in a custom object that meet a condition?”

“Is there a cap on how many records a criteria-based delete removes?”

Tell an agent destructive · confirm first

Delete all {object_name} records matching {criteria}.

Remove up to {count} {object_name} records that satisfy {criteria}.

PUT /api/data/v1/custom-objects/{objectName}/criteria/bulk Update custom object records matching criteria · Update custom object records as per the criteria #

Ask an LLM

“Can I update every record that meets a condition in a custom object?”

“How do I set the same values on all records matching a filter?”

Tell an agent

In {object_name}, set {values} on records matching {criteria}.

Update all {object_name} records that satisfy {criteria}.

GET /api/data/v1/custom-objects/{objectName}/recordtypes List record types of a custom object · Get all record types for the custom object #

Ask an LLM

“Which record types are defined for a custom object?”

“Can I see all record types available on one object?”

Tell an agent

List record types for custom object {object_name}.

Show the record types defined on {object_name}.

GET /api/data/v1/custom-objects/{objectName}/summary Get a custom object's record count and size · Get object record count and size on disk #

Ask an LLM

“How many records does a custom object hold and how much disk does it use?”

“Can I check the storage size of one object?”

Tell an agent

Show the record count and disk size of {object_name}.

Summarize storage usage for custom object {object_name}.

DELETE /api/data/v1/custom-objects/{objectName}/{id} Delete a custom object record by ID · Delete a custom object record #

Ask an LLM

“How do I delete one custom object record by its record ID?”

“Which delete behaviour options exist when removing one record by ID?”

Tell an agent destructive · confirm first

Delete record {record_id} from custom object {object_name}.

Remove the {object_name} record with ID {record_id}.

GET /api/data/v1/custom-objects/{objectName}/{id} Get a custom object record by ID · Get a custom object record using record ID #

Ask an LLM

“What does a single custom object record contain when I have its record ID?”

“Can I fetch one record from a custom object by ID?”

Tell an agent

Get record {record_id} from custom object {object_name}.

Show the {object_name} record with ID {record_id}.

PUT /api/data/v1/custom-objects/{objectName}/{id} Update a custom object record by ID · Update a custom object record #

Ask an LLM

“How do I change one custom object record identified by its record ID?”

“Can the updated payload be returned after editing one record?”

Tell an agent

Update record {record_id} in custom object {object_name}.

Edit the {object_name} record {record_id} and return the payload.

Conga Custom Object API

Operations 18

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification