---
title: "GET /v2/actions"
method: GET
path: "/v2/actions"
tags: ["actions"]
---

# GET /v2/actions

`GET /v2/actions`

## Request

- Base URL: `https://api.thecompaniesapi.com`
- URL: `https://api.thecompaniesapi.com/v2/actions`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/thecompaniesapi/apis/the-companies-api/docs/v2/actions/get.ts> (a function with typed inputs; its response is checked against the schema)

Get and filter your actions.

## Query parameters

- `full` boolean
- `ids` number[]
- `listId` number
- `page` number
- `search` string
- `size` number
- `status` 'active' | 'completed' | 'failed' | 'pending'
- `teamId` number
- `type` 'jobs:request' | 'companies:added'

## Response `200`

Get and filter your actions.

- object
  - `actions` Action[], required
    - `attempts` number
    - `cost` number, nullable
    - `createdAt` string, nullable
    - `data` object
      - `cleanedUp` number
      - `completed` string[]
      - `completedDomains` number
      - `completedDomainsSample` string[]
      - `count` number
      - `domain` string
      - `domains` string[]
      - `domainsSample` string[]
      - `elasticQuery` unknown
      - `failed` string[]
      - `failedDomains` number
      - `failedDomainsSample` string[]
      - `fields` object[]
        - `description` string
        - `key` string, required
        - `type` 'array|boolean' | 'array|number' | 'array|string' | 'boolean' | 'number' | 'string', required
        - `values` string[]
      - `grounded` boolean
      - `job` 'ask-domain' | 'ask-list' | 'enrich-companies' | 'enrich-list' | 'cleanup-list'
      - `model` 'claude' | 'claude-mini' | 'cousteau' | 'cousteau2' | 'cousteau2-thinking' | 'gpt' | 'gpt-mini' | 'groq' | 'groq-mini' | 'llama4'
      - `query` SegmentationCondition[]
        - `attribute` 'about.businessType' | 'about.industries' | 'about.industry' | 'about.name' | 'about.totalEmployees' | 'about.yearFounded' | 'ai.search' | 'analytics.monthlyVisitors' | 'apps' | 'codes.naics' | 'codes.sic' | 'contacts' | 'domain.domain' | 'domain.tld' | 'finances.revenue' | 'finances.stockExchange' | 'locations.headquarters.city.code' | 'locations.headquarters.continent.code' | 'locations.headquarters.country.code' | 'locations.headquarters.county.code' | 'locations.headquarters.state.code' | 'meta.listIds' | 'meta.score' | 'meta.syncedAt' | 'socials' | 'socials.linkedin.id' | 'technologies.active' | 'technologies.categories' | 'urls', required
        - `blockedOperator` boolean
        - `operator` 'and' | 'or', required
        - `sign` 'equals' | 'exactEquals' | 'greater' | 'lower' | 'notEquals', required
        - `values` union[], required
          - union
            - string
            - number
      - `question` string
      - `team` Team: A collection of users that can access the same resources.
        - `admin` boolean, nullable, required
        - `country` string, nullable, required
        - `createdAt` string, nullable, required
        - `credits` number, required
        - `creditsPack` number, required
        - `id` number, required
        - `name` string, nullable, required
        - `role` string, nullable
        - `stripeCustomerId` string, nullable, required
        - `stripeProductId` string, nullable, required
        - `stripeSubscribed` boolean, required
        - `stripeSubscriptionId` string, nullable, required
        - `stripeSubscriptionStatus` string, nullable, required
        - `websiteUrl` string, nullable, required
      - `totalDomains` number
      - `user` User: A user of the platform.
        - `colorMode` 'dark' | 'light' | 'system'
        - `createdAt` string, nullable
        - `currentTeamId` number, nullable, required
        - `email` string, required
        - `emailFree` boolean, nullable, required
        - `emailVerified` boolean, nullable, required
        - `emailVerifiedResentAt` string, nullable, required
        - `fullName` string, nullable, required
        - `hasPassword` boolean, nullable, required
        - `id` number, required
        - `locale` unknown
        - `pictureUrl` string, nullable, required
        - `referral` string, nullable
        - `role` 'owner' | 'user', nullable
    - `id` number, required
    - `listId` number
    - `promptId` number
    - `result` object
      - `answers` LLMAnswer[]
        - `companyId` number, required
        - `explanation` string
        - `fields` object[]
          - `description` string
          - `key` string, required
          - `type` 'array|boolean' | 'array|number' | 'array|string' | 'boolean' | 'number' | 'string', required
          - `values` string[]
        - `grounded` boolean
        - `output` object, required
        - `question` string, required
        - `score` number, required
      - `cleanedUp` number
      - `domains` string[]
    - `status` 'active' | 'completed' | 'failed' | 'pending', required
    - `teamId` number
    - `type` 'companies:added' | 'jobs:request'
    - `updatedAt` string, nullable
  - `meta` PaginationMeta, required: Metadata about a paginated or billed response.
    - `cost` number, required
    - `credits` number, required
    - `currentPage` number, required
    - `firstPage` number, required
    - `freeRequest` boolean, required
    - `lastPage` number, required
    - `maxScrollResultsReached` boolean
    - `perPage` number, required
    - `total` number, required

## Other responses

- `400`: The error message
- `401`: The error message

---

[API](https://skmtc.dev/thecompaniesapi/apis/the-companies-api.md) - [All operations](https://skmtc.dev/thecompaniesapi/apis/the-companies-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thecompaniesapi/apis/the-companies-api/revisions/f8bfc2d10b71?raw)