The operations from the Bulk/2.0/customObjects category.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/eloqua-bulk-2-0-customobjects-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: REST API for Oracle Eloqua Marketing Cloud Service Bulk/2.0/custom Objects API
description: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers.
version: 2026.08.07
x-summary: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers.
tags:
- name: Bulk/2.0/customObjects
description: The operations from the Bulk/2.0/customObjects category.
paths:
/api/bulk/2.0/customObjects/{parentId}:
get:
tags:
- Bulk/2.0/customObjects
summary: Retrieve a custom object
description: Retrieves a custom object that matches the criteria specified in the URL parameters.
operationId: GetCustomObjectIndividual
parameters:
- name: parentId
in: path
description: The custom object's resource identification number.
required: true
schema:
type: integer
responses:
'200':
description: OK.
content:
application/json:
schema:
title: CustomObjectIndividualResponse
description: The response body contains information about the custom object definition.
properties:
createdAt:
format: date-time
title: createdAt
description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
type: string
createdBy:
title: createdBy
description: The login id of the user who created the entity. This is a read-only property.
type: string
displayNameFieldUri:
title: displayNameFieldUri
description: The relative uri used to reference the custom object field that represents the display field, for this custom object.
type: string
emailAddressFieldUri:
title: emailAddressFieldUri
description: The relative uri used to reference the custom object field that represents an email address, for this custom object.
type: string
name:
title: name
description: The name of the custom object definition.
type: string
uniqueFieldUri:
title: uniqueFieldUri
description: The relative uri used to reference the custom object field that has a uniqueness constraint on it, for this custom object.
type: string
updatedAt:
format: date-time
title: updatedAt
description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
type: string
updatedBy:
title: updatedBy
description: The login id of the user that last updated the entity. This is a read-only property.
type: string
uri:
title: uri
description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
type: string
'400':
description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'401':
description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'403':
description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'409':
description: There was a conflict. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'410':
description: The requested resource is no longer available. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'412':
description: The resource you are attempting to delete has dependencies, and cannot be deleted. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'413':
description: Storage space exceeded. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'500':
description: The service has encountered an internal server error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'503':
description: There was a timeout processing the request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
deprecated: false
x-internal-id: api-bulk-2.0-customObjects-{parentId}-get
x-filename-id: api-bulk-2.0-customobjects-parentid-get
/api/bulk/2.0/customObjects/{parentId}/exports:
get:
tags:
- Bulk/2.0/customObjects
summary: Retrieve a list of export definitions for a custom object
description: Retrieves the list of export definitions for the custom object with the specified id
operationId: GetCustomObjectExportSearch
parameters:
- name: parentId
in: path
description: The custom object's resource identification number.
required: true
schema:
type: integer
- name: limit
in: query
description: 'A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If not specified, the default is 1000. Example: <code>?limit=5</code>.'
schema:
type: integer
- name: links
in: query
description: The links section in a resource return all the links by default. The client side might be only interested in a particular link. To satisfy that requirement, a "links" query parameter might be supported. The value of this query parameter is a list of relations separated by comma ",". For example, ?links=canonical, next will only return the links with "rel" property be canonical or next.
schema:
type: string
- name: offset
in: query
description: 'Specifies an offset that allows you to retrieve the next batch of records. Any positive integer. For example, if your limit is 1000, specifying an offset of 1000 will return records 1000 through 2000. If not specified, the default is 0. Example: <code>?offset=1000</code>.'
schema:
type: integer
- name: orderBy
in: query
description: 'Specifies the name of the property to order the results by. The <code>orderBy</code> format is <code>term</code> ASC | DESC. Example: <code>?orderBy=name ASC</code>.'
schema:
type: string
- name: q
in: query
description: 'A URL parameter that specifies query criteria used to filter results. The <code>q</code> format is <code>term</code><code>operator</code><code>value</code>. Use "*" for wildcard values. Example: <code>?q="name=*Test*"</code> will find all the entities where the "name" field contains the string "Test".'
schema:
type: string
- name: totalResults
in: query
description: Whether or not the total results are shown, and factored into the <code>hasMore</code> property in the response. When set to <code>false</code>, the <code>totalResults</code> property will not be returned, and the <code>hasMore</code> property will be determined based on returned events that match the criteria specified in the URL parameters. If not specified, the default is <code>true</code>.
schema:
type: boolean
responses:
'200':
description: OK.
content:
application/json:
schema:
title: CustomObjectExportSearchResponse
description: The response body contains information about the custom object export definitions.
properties:
count:
title: count
description: Number of results returned in the request.
type: integer
hasMore:
title: hasMore
description: Indicates if there are more results.
type: boolean
items:
title: items
description: The collection of items that match the search.
type: array
items:
$ref: '#/components/schemas/Export'
limit:
title: limit
description: The maximum number of records returned. Set with the <code>limit</code> URL parameter, and defaults to 1000 if not specified.
type: integer
offset:
title: offset
description: The requested index from which records are returned. Set with the <code>offset</code> URL parameter, and defaults to 0 if not specified.
type: integer
totalResults:
format: int64
title: totalResults
description: Number of total results. Returned when the <code>totalResults</code> URL parameter is not set to <code>false</code>.
type: integer
'400':
description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'401':
description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'403':
description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'409':
description: There was a conflict. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'410':
description: The requested resource is no longer available. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'412':
description: The resource you are attempting to delete has dependencies, and cannot be deleted. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'413':
description: Storage space exceeded. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'500':
description: The service has encountered an internal server error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'503':
description: There was a timeout processing the request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
deprecated: false
x-internal-id: api-bulk-2.0-customObjects-{parentId}-exports-get
x-filename-id: api-bulk-2.0-customobjects-parentid-exports-get
post:
tags:
- Bulk/2.0/customObjects
summary: Create an export definition for a custom object
description: Creates a new export definition for the specified custom object. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkExport'>tutorial</a> for details on how to export data.
operationId: PostCustomObjectExportIndividual
parameters:
- name: parentId
in: path
description: The custom object's resource identification number.
required: true
schema:
type: integer
responses:
'201':
description: Success.
content:
application/json:
schema:
title: CustomObjectExportIndividualResponse
description: The response body includes information about the custom object export definition.
properties:
areSystemTimestampsInUTC:
title: areSystemTimestampsInUTC
description: Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
type: boolean
autoDeleteDuration:
title: autoDeleteDuration
description: Time until the definition will be deleted, expressed using the ISO-8601 standard.
type: string
createdAt:
format: date-time
title: createdAt
description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
type: string
createdBy:
title: createdBy
description: The login id of the user who created the entity. This is a read-only property.
type: string
crmAccountIdField:
title: crmAccountIdField
description: The ML statement for an existing contact field which addresses the CRM account ID.
type: string
dataRetentionDuration:
title: dataRetentionDuration
description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
type: string
externalSystemId:
title: externalSystemId
description: The external system ID is used when exporting data containing CRM fields.
type: integer
fields:
title: fields
description: List of fields to be included in the operation.
type: object
filter:
title: filter
description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
type: string
kbUsed:
format: int64
title: kbUsed
description: The amount of space used in kilobytes. This is a read-only property.
type: integer
maxRecords:
title: maxRecords
description: The maximum amount of records.
type: integer
name:
title: name
description: The name of the export definition.
type: string
productIdField:
title: productIdField
description: The ML statement for an existing campaign field which addresses the product ID.
type: string
syncActions:
title: syncActions
description: Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
type: array
items:
$ref: '#/components/schemas/SyncAction'
updatedAt:
format: date-time
title: updatedAt
description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
type: string
updatedBy:
title: updatedBy
description: The login id of the user that last updated the entity. This is a read-only property.
type: string
uri:
title: uri
description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
type: string
'400':
description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'401':
description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'403':
description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'409':
description: There was a conflict. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'410':
description: The requested resource is no longer available. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'412':
description: The resource you are attempting to delete has dependencies, and cannot be deleted. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'413':
description: Storage space exceeded. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'500':
description: The service has encountered an internal server error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'503':
description: There was a timeout processing the request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
deprecated: false
x-internal-id: api-bulk-2.0-customObjects-{parentId}-exports-post
x-filename-id: api-bulk-2.0-customobjects-parentid-exports-post
requestBody:
content:
application/json:
schema:
title: CustomObjectExportIndividual
description: The request body defines the details of the custom object export definition.
properties:
areSystemTimestampsInUTC:
title: areSystemTimestampsInUTC
description: Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
type: boolean
autoDeleteDuration:
title: autoDeleteDuration
description: Time until the definition will be deleted, expressed using the ISO-8601 standard.
type: string
createdAt:
format: date-time
title: createdAt
description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
type: string
createdBy:
title: createdBy
description: The login id of the user who created the entity. This is a read-only property.
type: string
crmAccountIdField:
title: crmAccountIdField
description: The ML statement for an existing contact field which addresses the CRM account ID.
type: string
dataRetentionDuration:
title: dataRetentionDuration
description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
type: string
externalSystemId:
title: externalSystemId
description: The external system ID is used when exporting data containing CRM fields.
type: integer
fields:
title: fields
description: List of fields to be included in the operation.
type: object
filter:
title: filter
description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
type: string
kbUsed:
format: int64
title: kbUsed
description: The amount of space used in kilobytes. This is a read-only property.
type: integer
maxRecords:
title: maxRecords
description: The maximum amount of records.
type: integer
name:
title: name
description: The name of the export definition.
type: string
productIdField:
title: productIdField
description: The ML statement for an existing campaign field which addresses the product ID.
type: string
syncActions:
title: syncActions
description: Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
type: array
items:
$ref: '#/components/schemas/SyncAction'
updatedAt:
format: date-time
title: updatedAt
description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
type: string
updatedBy:
title: updatedBy
description: The login id of the user that last updated the entity. This is a read-only property.
type: string
uri:
title: uri
description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
type: string
text/csv:
schema:
title: CustomObjectExportIndividual
description: The request body defines the details of the custom object export definition.
properties:
areSystemTimestampsInUTC:
title: areSystemTimestampsInUTC
description: Whether or not <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SystemTimestamps'>system timestamps</a> will be exported in UTC. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>Filtering tutorial</a> for an example of filtering when <code>areSystemTimestampsInUTC</code> is set to <code>true</code>.
type: boolean
autoDeleteDuration:
title: autoDeleteDuration
description: Time until the definition will be deleted, expressed using the ISO-8601 standard.
type: string
createdAt:
format: date-time
title: createdAt
description: The date and time the entity was created, expressed using the ISO-8601 standard. This is a read-only property.
type: string
createdBy:
title: createdBy
description: The login id of the user who created the entity. This is a read-only property.
type: string
crmAccountIdField:
title: crmAccountIdField
description: The ML statement for an existing contact field which addresses the CRM account ID.
type: string
dataRetentionDuration:
title: dataRetentionDuration
description: The length of time exported data should remain in the staging area. Bulk API 2.0 uses the ISO-8601 standard for specifying all durations. Valid values are anything from PT1H (1 hour) to P14D (2 weeks). This setting will default to PT12H (12 hours) if not explicitly set during export definition creation.
type: string
externalSystemId:
title: externalSystemId
description: The external system ID is used when exporting data containing CRM fields.
type: integer
fields:
title: fields
description: List of fields to be included in the operation.
type: object
filter:
title: filter
description: The filter parameter uses Eloqua Markup Language to only return certain results. Learn more about <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=BulkFiltering'>filters</a>.
type: string
kbUsed:
format: int64
title: kbUsed
description: The amount of space used in kilobytes. This is a read-only property.
type: integer
maxRecords:
title: maxRecords
description: The maximum amount of records.
type: integer
name:
title: name
description: The name of the export definition.
type: string
productIdField:
title: productIdField
description: The ML statement for an existing campaign field which addresses the product ID.
type: string
syncActions:
title: syncActions
description: Specifies operations to perform during the sync with a maximum of 10 actions. See <a href='http://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SyncActions'>Sync actions parameters</a> for a list of sync actions. For more information about this parameter, see the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=ImportExportParams'>Oracle Eloqua Developer Help Center</a>.
type: array
items:
$ref: '#/components/schemas/SyncAction'
updatedAt:
format: date-time
title: updatedAt
description: The date and time the entity was last updated, expressed using the ISO-8601 standard. This is a read-only property.
type: string
updatedBy:
title: updatedBy
description: The login id of the user that last updated the entity. This is a read-only property.
type: string
uri:
title: uri
description: System-generated unique resource identifier that defines the definition for future referencing. This is a read-only property.
type: string
description: The request body contains details of the custom object export definition.
required: true
/api/bulk/2.0/customObjects/{parentId}/fields:
get:
tags:
- Bulk/2.0/customObjects
summary: Retrieve a list of the fields for a custom object
description: Retrieves a custom object field definition for the custom object and field ids provided.
operationId: GetCustomObjectFieldSearch
parameters:
- name: parentId
in: path
description: The custom object's resource identification number.
required: true
schema:
type: integer
- name: limit
in: query
description: 'A URL parameter that specifies the maximum number of records to return. This can be any positive integer between 1 and 1000 inclusive. If
# --- truncated at 32 KB (253 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/eloqua/refs/heads/main/openapi/eloqua-bulk-2-0-customobjects-api-openapi.yml