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

ActiveCampaign Segments API

The Segments API from ActiveCampaign — 8 operation(s) for creating, retrieving, updating and deleting segments (segmentsV2), reading a segment as it existed at a point in time, reverting a segment to a historic definition, and listing saved segment summaries (audiences).

ActiveCampaign Segments API is one of 43 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Segments and Contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.

This API exposes 8 operations across 5 paths, organized into 2 resource areas, and defines 18 schemas. It is described by OpenAPI 3.1.1, at version 2.0.0.

Requests are made against a single base URL, https://{yourAccountName}.api-us1.com/api/3.

8 operations 5 paths 18 schemas 1 DELETE4 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.1
API Version
2.0.0
Base URL
https://{yourAccountName}.api-us1.com/api/3
Authentication
API Key
Resource Areas
2

Authentication & Security 1

ActiveCampaign Segments API declares 1 security scheme for authenticating requests. An API key is passed in the header as Api-Token (Api_Key). By default, every request must be authenticated.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 1 POST, 2 PUT. They span 2 resource areas: Segments, Saved Segment Summaries. Each is listed below with its method, path, parameters, and response codes.

Segments 6

Segment JSON structure is extremely flexible. Only segments that are supported by the segment-builder are guaranteed to work as expected. Specific Conditions types only support a…

POST
/segmentsV2
Create a Segment
create_segment body → 200400401403404
GET
/segmentsV2/{segmentId}
Retrieve a Segment
retrieve_segment 1 param → 200401403404
PUT
/segmentsV2/{segmentId}
Update a Segment
update_segment 1 param body → 200400401403404
DELETE
/segmentsV2/{segmentId}
Delete a Segment by SegmentId including its historic versions
delete_segment 1 param → 200401403
GET
/segmentsV2/{segmentId}/createdDate/{timestamp}
Retrieve a Segment's Historic Definition
get_segment_historic 2 params → 200401403404
PUT
/segmentsV2/{segmentId}/createdDate/{timestamp}
Revert a Segment to a Historic Definition
segment_revert_to_history 2 params → 200400401403404
Saved Segment Summaries 2

Saved Segments have a name and are visible on the app/segments page. Saved Segments have Summaries

GET
/audiences
List Summaries for Saved Segments
get_saved_segment_summaries 4 params → 200400401403404
GET
/audiences/{segmentId}
Retrieve a Saved Segment's Summary
get_saved_segment_summaries_by_id 1 param → 200400401403404

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are SegmentDO (11 properties), AggregateDO (7 properties), ConditionDO (7 properties), SegmentSummaryDO (7 properties). Each schema is shown below with its type and property counts.

AggregateDO
object
(Optional) AggregateDO allows for requiring a count of discrete matches against the simple (non-aggregate part of a) condition before the entire condition is c…
7 properties
ConditionDO
object
7 properties 3 required
SegmentDataDO
object
3 properties
ErrorDetailDO
object
5 properties
ErrorSourceDO
object
1 property
FieldDO
object
5 properties 4 required
AggFieldDO
object
Required if the aggregate objects is using the "mostrecent" operator. This AggFieldDO defines the query logic that the most recent object must satisfy. When th…
4 properties 4 required
ConditionGroupDO
object
3 properties
ConditionGroupFieldDO
object
2 properties 1 required
RootSuccessDO
object
1 property
RootErrorDO
object
1 property
SegmentDO
object
11 properties 3 required
SegmentSummarySuccessRootDO
object
1 property
SegmentSummaryErrorRootDO
object
1 property
SegmentSummaryDataDO
object
3 properties
SegmentSummaryDO
object
7 properties
SegmentSummaryCountsDO
object
2 properties
SegmentSummaryCountDO
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-segments-api-openapi.json Raw ↑

Other APIs ActiveCampaign publishes across the network.

ActiveCampaign Accounts API
ActiveCampaign Addresses API
ActiveCampaign AI API
ActiveCampaign Automations API
ActiveCampaign Branding API
ActiveCampaign Broadcasts API
ActiveCampaign Bulk Import API
ActiveCampaign Calendars API
ActiveCampaign Campaigns API
ActiveCampaign Contacts API
ActiveCampaign Credits API
ActiveCampaign Custom Objects API
Where this information came from

This is an independent, third-party profile of ActiveCampaign Segments 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.