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

Act! Web API

JSON-based REST API for the Act! CRM database exposing contacts, companies, groups, opportunities, tasks, activity series, calendar, notes, history, documents, attachments, users, teams, preferences, analytics and tenant-defined custom entities — 410 operations across 31 resource areas. Collection reads accept OData v4 query options; requests can be batched at POST /api/$batch; webhooks are registered through the API itself. The database schema is discoverable at runtime through the MetadataInfo operations because Act! databases are user-extensible. Authentication is a JWT bearer token obtained from GET /authorize with HTTP Basic credentials and an Act-Database-Name header.

Act! Web API is one of 11 APIs that Act! CRM publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include CRM, REST API, OData, OpenAPI, and Webhook. The published artifact set on APIs.io includes API documentation, an API reference, an OpenAPI specification, and rate-limit docs.

This API exposes 29 operations across 29 paths, and defines 28 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 3 base URLs: https://apimta.act.com/act.web.api, https://{server}/{customer}-api/act.web.api, https://{server}/act.web.api.

29 operations 29 paths 28 schemas 28 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://apimta.act.com/act.web.api
Authentication
HTTP Basic, HTTP Bearer, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Act! Web API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Act-Database-Name (actDatabaseName). By default, every request must be authenticated.

  • basicAuth — HTTP Basic credentials (Act! user name and password, RFC 7617) presented to GET /authorize together with the Act-Database-Name header to mint a JWT bearer toke…
  • bearerAuth — JWT bearer token returned by GET /authorize (RFC 6750). Sent as Authorization: Bearer on every API request.
  • actDatabaseName — Name of the Act! database the request is scoped to.

Paths & Operations 29

Across 29 paths, the API surfaces 29 operations — 28 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Analytics 29
GET
/api/activities/analytics/task-list
Generates the task list activities for analytics task list widget
Analytics_GetLimitedTaskListActivities_65ECB9F3 5 params → 200400401404500
GET
/api/activities/analytics/activity-by-user
Generates activity sales by user data for given users.
Analytics_GetActivityByUser_EE78D56B 4 params → 200400401404500
GET
/api/activities/analytics/activity-by-user-details
Generates activity sales by user detail data for a given user.
Analytics_GetActivityByUserDetails_703CA4FB 4 params → 200400401404500
GET
/api/emarketing/analytics/campaign-leads
Gets contacts leads.
Analytics_GetCampaignLeads_417AF467 → 200400401404500
GET
/api/emarketing/analytics/campaign-lead-info
Gets opportunities within a campaign within a specified date range (optional filters on statuses and user ids).
Analytics_GetCampaignLeadInfo_E08EC92C 5 params → 200400401404500
GET
/api/emarketing/analytics/campaign-sent
Gets campaign sent within a specified date range.
Analytics_GetCampaignSent_4B94D20E 2 params → 200400401404500
GET
/api/emarketing/analytics/campaign-results
Gets campaign result information.
Analytics_GetCampaignResults_0F89CFC0 3 params → 200400401404500
GET
/api/{entityname}/analytics/query
Gets a custom analytic query to view specific data.
Analytics_GetCustomData_B83CB8C8 17 params → 200400401404500
GET
/api/{entityname}/analytics/query-details
Gets a custom analytic query to view specific data.
Analytics_GetCustomDataDetails_AE15B56B 17 params → 200400401404500
GET
/api/emarketing/analytics/history
Gets historical e-marketing information for a given date range.
Analytics_GetEmarketingHistory_1FECBF61 2 params → 200400401404500
GET
/api/analytics/kpi
Gets analytic KPI query to view specific data.
Analytics_GetKpiData_4DFFF7FB 15 params → 200400401404500
GET
/api/opportunity/analytics/revenue/actual-predicted
Generates actual vs predicted opportunity revenue.
Analytics_GetOpportunityActualVersusPredictedRevenue_3DBFEBCE 4 params → 200400401404500
GET
/api/opportunity/analytics/revenue/forecast-by-product
Generates forecasted opportunity data by given products.
Analytics_GetOpportunityForecastByProduct_6A5F800E 1 param → 200400401404500
GET
/api/opportunity/analytics/revenue/forecast-by-product-details
Generates forecasted opportunity data by a given product.
Analytics_GetOpportunityForecastByProductDetails_E8BE0DD8 1 param → 200400401404500
GET
/api/opportunity/analytics/revenue/forecast-by-rep
Generates forecasted opportunity data by given users.
Analytics_GetOpportunityForecastByRep_F4797D7A 1 param → 200400401404500
GET
/api/opportunity/analytics/revenue/forecast-by-rep-details
Generates forecasted opportunity data by a given user.
Analytics_GetOpportunityForecastByRepDetails_987464AE 1 param → 200400401404500
GET
/api/opportunities/analytics/pipeline
Gets all opportunity matching the custom filter that are currently being worked.
Analytics_GetOpportunityInPipeline_28599DA0 14 params → 200400401404500
POST
/api/opportunities/analytics/pipelines
Gets all opportunity matching the custom filter that are currently being worked.
Analytics_GetOpportunityInPipeline_139FD0C7 body → 200400401404500
GET
/api/opportunities/analytics/top-open
Gets all opportunity matching the custom filter that are currently being worked.
Analytics_GetTopOpenOpportunities_19FBF97E 15 params → 200400401404500
GET
/api/opportunity/analytics/stage-time
Generates opportunity data for the average time in a stage.
Analytics_GetOpportunityAverageTimeInStage_DCAE7DC3 3 params → 200400401404500
GET
/api/opportunity/analytics/revenue/close-reason
Generates opportunity data to summerizes how many times a reason has been closed.
Analytics_GetOpportunityCloseReasonCount_ABE6C32D 3 params → 200400401404500
GET
/api/opportunity/analytics/revenue/close-reason-details
Generates opportunity data that details the reason for being closed.
Analytics_GetOpportunityCloseReasonDetails_6BBA1207 4 params → 200400401404500
GET
/api/stages/analytics/opportunity-count
Generates a summary of the total number of opportunities within a stage.
Analytics_GetOpportunityCountByStages_CD8840AE 14 params → 200400401404500
GET
/api/opportunity/analytics/revenue/cost
Generates opportunity periodic revenue versus cost data for given products.
Analytics_GetOpportunityRevenueVersusCost_D5AA80A8 5 params → 200400401404500
GET
/api/opportunity/analytics/revenue/sales-by-product
Generates opportunity sales by product data for given products.
Analytics_GetOpportunitySalesByProduct_E254EF71 3 params → 200400401404500
GET
/api/opportunity/analytics/revenue/sales-by-product-details
Generates opportunity sales by product detail data for a given product.
Analytics_GetOpportunitySalesByProductDetails_89CE77DD 3 params → 200400401404500
GET
/api/opportunity/analytics/revenue/sales-by-rep
Generates opportunity sales by user data for given users.
Analytics_GetOpportunitySalesByRep_75FC5215 3 params → 200400401404500
GET
/api/opportunity/analytics/revenue/sales-by-rep-details
Generates opportunity sales by user data for a given user.
Analytics_GetOpportunitySalesByRepDetails_4BE7FF32 3 params → 200400401404500
GET
/api/opportunity/analytics/revenue/won-lost
Generates opportunty win versus loss data.
Analytics_GetOpportunityWonVersusLost_797C4A7F 2 params → 200400401404500

Schemas 28

The contract defines 28 schemas that model the data the API accepts and returns. The most detailed are act.web.api.Controllers.AnalyticsPipeline (14 properties), act.web.api.models.Analytics.MarketingLead (11 properties), act.web.api.models.Analytics.PipelineOpportunity (11 properties), act.web.api.models.Analytics.TaskListActivity (9 properties). Each schema is shown below with its type and property counts.

act.web.api.models.Analytics.CloseReasonDetails
object
6 properties
act.web.api.models.Analytics.CustomData
object
3 properties
act.web.api.models.Analytics.ForecastByRepDetail
object
6 properties
act.web.api.models.Analytics.PeriodicActualAndPredictedRevenue
object
This model describes actual revenue vs. potential revenue vs. projected (weighted) revenue for a given time period. Projected values are available for future t…
4 properties
act.web.api.models.Analytics.CampaignInfo
object
3 properties
act.web.api.models.Analytics.ForecastByProduct
object
Sales revenue or revenues is income received from selling goods or services over a period of time.
8 properties
act.web.api.models.Analytics.PipelineOpportunity
object
Opportunity currently being worked.
11 properties
act.web.api.models.Analytics.PeriodicRevenueAndCost
object
Sales revenue or revenues is income received from selling goods or services over a period of time.
5 properties
act.web.api.models.Analytics.SalesByProductDetail
object
4 properties
act.web.api.models.Analytics.TimeInStage
object
Describes information about the average time an opportunity is in a stage.
3 properties
act.web.api.models.Analytics.SalesByProduct
object
4 properties
act.web.api.models.Analytics.EmarketingHistory
object
Describes historical e-marketing information.
2 properties
act.web.api.models.Analytics.UserActivityCount
object
3 properties
act.web.api.models.Analytics.EmailAction
object
Describes information about e-marketing email actions
3 properties
act.web.api.models.Analytics.OpportunityStageCount
object
5 properties
act.web.api.models.Analytics.CampaignResult
object
7 properties
act.web.api.models.Analytics.SalesByRepDetail
object
4 properties
act.web.api.models.Analytics.UserActivityDetail
object
7 properties
act.web.api.models.Analytics.WonLostMetrics
object
Describes opportunity wins vs losses.
5 properties
act.web.api.models.Analytics.TaskListActivity
object
Activity to display in user's analytics task list
9 properties
act.web.api.Controllers.AnalyticsPipeline
object
14 properties
act.web.api.models.Analytics.ForecastByProductDetail
object
6 properties
act.web.api.models.Analytics.ForecastByRep
object
Sales revenue or revenues is income received from selling goods or services over a period of time.
8 properties
act.web.api.models.Analytics.SalesByRep
object
5 properties
act.web.api.models.Analytics.CloseReasonCount
object
Totals the number of closed reasons.
2 properties
act.web.api.models.Analytics.MarketingLead
object
11 properties
act.web.api.models.Analytics.CampaignLeadInfo
object
A Breakdown of opportunities within a campaign ( of opportunities, total and weighted values).
5 properties
act.web.api.models.Analytics.KpiData
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

act-analytics-api-openapi.yml Raw ↑

Other APIs Act! CRM publishes across the network.

Act! CRM Activity Series API
Act! CRM Custom Entities API
Act! CRM Document Types API
Act! CRM History Types API
Act! CRM Marketing Automations API
Act! CRM Metadata Info API
Act! CRM Secondary Contacts API
Act! CRM Supplemental Files API
Act! CRM Sync Data API
Act! CRM Task Types API
Where this information came from

This is an independent, third-party profile of Act! Web 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.