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

The Companies API actions API

The actions API from The Companies API — 2 operation(s) for actions.

The Companies API actions API is one of 12 APIs that The Companies API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include actions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

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

3 operations 2 paths 6 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2.0.0
Base URL
https://api.thecompaniesapi.com/v2
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

The Companies API actions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (apiKey).

  • apiKey — The API key to use for authentication, you can get it from your API tokens page.

Paths & Operations 3

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

actions 3
GET
/v2/actions
Get and filter your actions.
fetchActions 9 params → 200400401
POST
/v2/actions
Request or estimate a new action.
requestAction body → 200400401403
POST
/v2/actions/{actionId}/retry
Ask for a retry of failed action.
retryAction 1 param body → 200400401

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Team (14 properties), User (14 properties), Action (12 properties), PaginationMeta (9 properties). Each schema is shown below with its type and property counts.

User
object
A user of the platform.
14 properties 9 required
PaginationMeta
object
Metadata about a paginated or billed response.
9 properties 8 required
SegmentationCondition
object
A condition for our platform segmentation engine.
5 properties 4 required
Team
object
A collection of users that can access the same resources.
14 properties 13 required
Action
object
An action tracks a request made to our job queue and its result.
12 properties 2 required
LLMAnswer
object
An answer from a query made to the LLM.
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thecompaniesapi-actions-api-openapi.yml Raw ↑

Other APIs The Companies API publishes across the network.

The Companies API analytics API
The Companies API companies API
The Companies API industries API
The Companies API job-titles API
The Companies API lists API
The Companies API locations API
The Companies API prompts API
The Companies API teams API
The Companies API technologies API
The Companies API users API
The Companies API utilities API