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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ActiveCampaign

ActiveCampaign Segment Matching API

The Segment Matching API from ActiveCampaign — 8 operation(s) for asynchronous match-all and match-some segment evaluation. A match request returns a runId; result sets are cached against that runId with a 24-hour TTL and polled until is_ready is true. Also carries segment count history.

Documentation Provider Profile APIs.io OpenAPI GitHub

ActiveCampaign Segment Matching 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 8 paths, organized into 3 resource areas, and defines 22 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.

8 operations 8 paths 22 schemas 6 GET2 POST

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
Contact
ActiveCampaign Support
Resource Areas
3

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 6 GET, 2 POST. They span 3 resource areas: Match All, Most Recent Count History, Count History. Each is listed below with its method, path, parameters, and response codes.

Match All 5

Return all Contact id's that match the given Segment and provided Additional Criteria

POST
/api/3/segmentMatchAll
Create a Match All Request for a new Segment
create_match_all_request 4 params body → 200400401403404
GET
/api/3/segmentMatchAll/{segmentId}
Create a Match All Request
create_match_all_request_with_segment_id 5 params → 200400401403404
GET
/api/3/segmentMatchAll/{segmentId}/{runId}
Return Match All result-set
get_result_set_by_id 5 params → 200400401403404
POST
/api/3/segmentMatchSome/{segmentId}
Create a Match Some Request
find_contact_id_by_ac_playload 5 params body → 200400401403404
GET
/api/3/segmentMatchSome/{segmentId}/{runId}
Return a Match Some result-set
get_result_set_by_run_id 4 params → 200400401403404
Most Recent Count History 1
GET
/api/3/segmentsV2/count-history
Retrieve the most recent result count for the given segments that were ran without an AdditionalCriteria
get_recent_count_history 1 param → 200400401403
Count History 2
GET
/api/3/segmentsV2/{segmentId}/count-history
Retrieve all result counts for the given segment that were ran without an AdditionalCriteria
get_count_history_by_segment_id 1 param → 200400401403
GET
/api/3/segmentsV2/{segmentId}/count-history/{timestamp}
Retrieve all result counts for the given segment that were ran without an AdditionalCriteria
get_count_history_with_timestamp 2 params → 200400401403

Schemas 22

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

AdditionalCriteriaRootDO
object
1 property
AdditionalCriteriaElementDO
object
2 properties
AdditionalCriteriaDO
object
6 properties 2 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
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
ConditionGroupDO
object
3 properties
ConditionGroupFieldDO
object
2 properties 1 required
ErrorResponseRootDO
object
1 property
ErrorDetailDO
object
5 properties
ErrorSourceDO
object
1 property
FieldDO
object
5 properties 4 required
MatchAllResponseRootDO
object
1 property
MatchAllDataDO
object
3 properties
MatchAllAttributeDO
object
Object representing the status and result of the match all request. Note that page number and total count information refer to the results in the "matches" att…
8 properties 4 required
PageDO
object
4 properties
RootDO
object
2 properties
SegmentDO
object
11 properties 3 required
SegmentDataDO
object
3 properties
SegmentCountHistoryResponseRootDO
object
2 properties
SegmentCountHistoryDataDO
object
3 properties
SegmentCountHistoryAttributeDO
object
Object that summarises the results of a segment's evaluation request
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-segment-matching-api-openapi.json Raw ↑

Other APIs ActiveCampaign publishes across the network.

ActiveCampaign Accounts API
AE Profile APIs.io
ActiveCampaign Addresses API
AE Profile APIs.io
ActiveCampaign AI API
AE Profile APIs.io
ActiveCampaign Automations API
AE Profile APIs.io
ActiveCampaign Branding API
AE Profile APIs.io
ActiveCampaign Broadcasts API
AE Profile APIs.io
ActiveCampaign Bulk Import API
AE Profile APIs.io
ActiveCampaign Calendars API
AE Profile APIs.io
ActiveCampaign Campaigns API
AE Profile APIs.io
ActiveCampaign Contacts API
AE Profile APIs.io
ActiveCampaign Credits API
AE Profile APIs.io
ActiveCampaign Custom Objects API
AE Profile APIs.io
#Segments#Contacts
← Back to A APIs
API Details
ID
activecampaign:activecampaign-segment-matching-api
Base URL
https://{yourAccountName}.api-us1.com
Docs
https://developers.activecampaign.com/reference/create_match_all_request
Provider
ActiveCampaign
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=activecampaign-segment-matching-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/activecampaign-segment-matching-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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