Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ActiveCampaign Groups API

The Groups API from ActiveCampaign — 7 operation(s) for groups.

ActiveCampaign Groups API is one of 36 APIs that ActiveCampaign publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 9 JSON Schema definitions.

Tagged areas include Groups. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an AsyncAPI specification, and 9 JSON Schemas.

This API exposes 12 operations across 7 paths. It is described by OpenAPI 3.0.3, at version 3.0.0.

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

12 operations 7 paths 0 schemas 2 DELETE5 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://youraccountname.api-us1.com/api/3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

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

  • ApiToken — Your ActiveCampaign API token

Paths & Operations 12

Across 7 paths, the API surfaces 12 operations — 2 DELETE, 5 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Groups 12
POST
/groupMembers
ActiveCampaign Add Custom Field to Field Group
add-custom-field-to-field-group body → 200403404422
GET
/groupMembers
ActiveCampaign Get All Custom Field Groups
get-all-custom-field-groups → 200400
DELETE
/groupMembers/{groupID}
ActiveCampaign Delete Custom Field Field Group
delete-custom-field-field-group 1 param body → 200404
GET
/groupMembers/{groupID}
ActiveCampaign Get Custom Field Group by ID
get-custom-field-to-field-group 1 param body → 200404
POST
/groupDefinitions
ActiveCampaign Create a Custom Field Group
create-a-custom-field-group 3 params body → 200400
PUT
/groupMembers/{groupId}
ActiveCampaign Update Custom Field Field Group
update-custom-field-field-group 1 param body → 200403404422
POST
/groups
ActiveCampaign Create a Group
create-a-new-group body → 200
GET
/groups
ActiveCampaign List All Groups
list-all-groups → 200
GET
/groups/{id}
ActiveCampaign Retrieve a Group
retrieve-a-group 1 param → 200403
PUT
/groups/{id}
ActiveCampaign Update a Group
update-a-group 1 param body → 200403
DELETE
/groups/{id}
ActiveCampaign Delete a Group
delete-a-group-1 1 param → 200400
GET
/groupLimits
ActiveCampaign List All Group Limits
list-all-group-limits → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

activecampaign-groups-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