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

HubSpot Actors API

Operations for managing conversation participants including visitors and agents.

HubSpot Actors API is one of 93 APIs that HubSpot publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 652 JSON Schema definitions.

Tagged areas include Actors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, code examples, and 652 JSON Schemas.

This API exposes 2 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.1.0, at version 3.0.0.

Requests are made against a single base URL, https://api.hubapi.com.

2 operations 2 paths 6 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.0.0
Base URL
https://api.example.com
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

HubSpot Actors API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 1 scope.

Paths & Operations 2

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

Actors 2

Operations for managing conversation participants including visitors and agents.

GET
/conversations/v3/conversations/actors
Hubspot List Actors
listActors 2 params → 200default
GET
/conversations/v3/conversations/actors/{actorId}
Hubspot Retrieve an Actor
getActorById 1 param → 200default

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Error (7 properties), Actor (5 properties), ErrorDetail (5 properties), PagingNext (2 properties). Each schema is shown below with its type and property counts.

ErrorDetail
object
Detailed information about a specific error.
5 properties 1 required
ActorCollection
object
Paginated collection of actors
2 properties 1 required
Error
object
Standard error response structure.
7 properties 3 required
Paging
object
Pagination information for list responses.
1 property
PagingNext
object
Pagination cursor information for retrieving the next page.
2 properties
Actor
object
Represents a participant in a conversation (visitor, agent, or bot).
5 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hubspot-actors-api-openapi.yml Raw ↑

Other APIs HubSpot publishes across the network.

HubSpot Posts API
HubSpot URL Redirects API
HubSpot Pipelines API
HubSpot Products API
HubSpot Line Items API
HubSpot Quotes API
HubSpot CRM Properties API
HubSpot Owners API
HubSpot CRM Imports API
HubSpot Custom Objects API
HubSpot Marketing Events API
HubSpot Forms API