Fetch the events triggered by an action
Track and monitor the status of your actions by retrieving event logs and updates. Get detailed insights into request processing and completion.
Fetch the events for your actions
This endpoint lets you retrieve your most recent action requests and events.
Query parameters
pagenumber (optional)
The page to fetch (default to 1).
1
sizenumber (optional)
The number of events to be returned (between 1 and 25). Default to 10.
10
statusstring (optional)
The status of the events to retrieve.
Possible values
pending
completed
active
failed
typestring (optional)
The type of the events to retrieve.
Possible values
companies:added
jobs:request
Response
eventsarray
The list of events.
metaobject
The metas information.
Endpoint
GET
https://api.thecompaniesapi.com/v2/actions
API response
{events :[{cost :10,createdAt : "2024-08-23T17:02:47.296+02:00" ,data :{…},id :42,status : "pending" ,type : "jobs:request" ,updatedAt : "2024-08-23T17:02:47.296+02:00" ,},{cost :10,createdAt : "2024-08-23T17:02:40.000+02:00" ,data :{…},id :40,status : "completed" ,type : "jobs:request" ,updatedAt : "2024-08-23T17:02:40.000+02:00" ,},],meta :{currentPage :1,firstPage :1,lastPage :1,perPage :10,total :2,},}