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 Match All API

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

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

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

This API exposes 5 operations across 5 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

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

5 operations 5 paths 19 schemas 3 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://youraccountname.api-us1.com/api/3
Resource Areas
1

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. 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

Schemas 19

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

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
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
MatchAllDataDO
object
3 properties
PageDO
object
4 properties
ErrorDetailDO
object
5 properties
ConditionGroupFieldDO
object
2 properties 1 required
ErrorSourceDO
object
1 property
ConditionGroupDO
object
3 properties
MatchAllResponseRootDO
object
1 property
SegmentDO
object
11 properties 3 required
ErrorResponseRootDO
object
1 property
AdditionalCriteriaElementDO
object
2 properties
RootDO
object
2 properties
AdditionalCriteriaDO
object
6 properties 2 required
AdditionalCriteriaRootDO
object
1 property
FieldDO
object
5 properties 4 required
ConditionDO
object
7 properties 3 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
SegmentDataDO
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-match-all-api-openapi.yml 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 Match All 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.