Segments API endpoints. Learn more about segments.
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-application-1-0-contact-segments-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 Application/1.0/Contact segments 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: Application/1.0/Contact segments
description: 'Segments API endpoints.
<a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAA/index.html#CSHID=Segments''>Learn more about segments</a>.'
paths:
/api/rest/1.0/assets/contact/segment:
post:
operationId: CreateIndividualPOSTRest10
summary: Create a contact segment
description: Creates a contact segment that matches the criteria specified by the request body.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ContactSegmentRest10'
'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.
'500':
description: The service has encountered an 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.
tags:
- Application/1.0/Contact segments
x-internal-id: api-rest-1.0-assets-contact-segment-post
x-filename-id: api-rest-1.0-assets-contact-segment-post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactSegmentRest10'
description: The request body defines the details of the contact segment to be created.
required: true
/api/rest/1.0/assets/contact/segment/{id}:
get:
operationId: ReadIndividualGETRest10
parameters:
- name: id
in: path
description: Id of the contact segment.
required: true
schema:
type: integer
- name: depth
in: query
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
required: false
schema:
type: string
summary: Retrieve a contact segment
description: Retrieves the contact segment specified by the <code>id</code> parameter.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContactSegmentRest10'
'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.
'500':
description: The service has encountered an 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.
tags:
- Application/1.0/Contact segments
x-internal-id: api-rest-1.0-assets-contact-segment-{id}-get
x-filename-id: api-rest-1.0-assets-contact-segment-id-get
put:
operationId: UpdateIndividualPUTRest10
parameters:
- name: id
in: path
description: Id of the contact segment.
required: true
schema:
type: integer
summary: Update a contact segment
description: Updates the contact segment specified by the <code>id</code> parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContactSegmentRest10'
'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.
'500':
description: The service has encountered an 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.
tags:
- Application/1.0/Contact segments
x-internal-id: api-rest-1.0-assets-contact-segment-{id}-put
x-filename-id: api-rest-1.0-assets-contact-segment-id-put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactSegmentRest10'
description: The request body defines the details of the contact segment to be update.
required: true
delete:
operationId: DeleteIndividualDELETERest10
parameters:
- name: id
in: path
description: Id of the contact segment.
required: true
schema:
type: integer
summary: Delete a contact segment
description: Deletes the contact segment specified by the <code>id</code> parameter.
responses:
'200':
description: OK
'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.
'500':
description: The service has encountered an 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.
tags:
- Application/1.0/Contact segments
x-internal-id: api-rest-1.0-assets-contact-segment-{id}-delete
x-filename-id: api-rest-1.0-assets-contact-segment-id-delete
/api/rest/1.0/assets/contact/segments:
get:
operationId: SearchGETRest10
parameters:
- name: depth
in: query
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>minimal</code> by default.'
required: false
schema:
type: string
- name: count
in: query
description: Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
required: false
schema:
type: integer
- name: page
in: query
description: Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
required: false
schema:
type: integer
- name: search
in: query
description: Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
required: false
schema:
type: string
- name: orderBy
in: query
description: Specifies the field by which list results are ordered.
required: false
schema:
type: string
- name: lastUpdatedAt
in: query
description: Unix timestamp for the date and time the contact segment was last updated.
required: false
schema:
type: integer
summary: Retrieve a list of contact segments
description: Retrieves all contact segments that match the criteria specified by the request parameters.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResultSegmentRest10'
'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.
'500':
description: The service has encountered an 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.
tags:
- Application/1.0/Contact segments
x-internal-id: api-rest-1.0-assets-contact-segments-get
x-filename-id: api-rest-1.0-assets-contact-segments-get
components:
schemas:
ContactSegmentRest10:
title: ContactSegment
properties:
type:
type: string
description: 'The asset''s type in Eloqua. This is a read-only property. '
id:
type: string
readOnly: true
description: Id of the contact segment. This is a read-only property.
currentStatus:
type: string
description: The contact segment's current status. This is a read-only property.
name:
type: string
description: The contact segment's name.
description:
type: string
description: The description of the contact segment.
permissions:
type: string
description: The permissions for the contact segment granted to your current instance. This is a read-only property.
createdBy:
type: string
readOnly: true
description: The login id of the user who created the contact segment.
createdAt:
type: string
readOnly: true
description: The date and time the contact segment was created, expressed in Unix time.
updatedBy:
type: string
readOnly: true
description: The login id of the user that last updated the contact segment.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the contact segment was last updated.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
elements:
type: array
description: Array of contact segment elements.
items:
$ref: '#/components/schemas/SegmentElementRest10'
count:
type: string
description: The number of contacts in the contact segment. This is a read-only property.
lastCalculatedAt:
type: string
description: The date and time of the most recent calculation. This is a read-only property.
QueryResultSegmentRest10:
title: QueryResultSegment
properties:
type:
type: string
description: The asset's type in Eloqua.
elements:
type: array
description: Array of segment fields.
items:
$ref: '#/components/schemas/ContactSegmentRest10'
total:
type: integer
description: The total amount of results.
pageSize:
type: integer
description: The page size.
page:
type: integer
description: The specified page.
SegmentElementRest10:
title: SegmentElement
properties:
type:
type: string
description: The asset's type in Eloqua. This is a read-only property.
id:
type: string
readOnly: true
description: Id of the contact segment element. This is a read-only property.
currentStatus:
type: string
description: The contact segment element's current status. This is a read-only property.
name:
type: string
description: The name of the contact segment element. This is a read-only property.
description:
type: string
description: The description of the contact segment element.
permissions:
type: string
description: The permissions for the contact segment element granted to your current instance. This is a read-only property.
createdBy:
type: string
readOnly: true
description: The login id of the user who created the contact segment element.
createdAt:
type: string
readOnly: true
description: The date and time the contact segment element was created, expressed in Unix time.
updatedBy:
type: string
readOnly: true
description: The login id of the user that last updated the contact segment element.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the contact segment element was last updated.
depth:
type: string
readOnly: true
description: 'Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth''>Request depth</a>.'
isIncluded:
type: string
description: The total amount of contacts within the segment element.
count:
type: string
description: The number of contacts in the contact segment element. This is a read-only property.
lastCalculatedAt:
type: string
description: The date and time the contact segment element was last calculated. This is a read-only property.