---
title: "Retrieve a required action"
method: GET
path: "/v1/partner/companies/{companyId}/required-actions/{requiredActionId}"
tags: ["Required Actions"]
---

# Retrieve a required action

`GET /v1/partner/companies/{companyId}/required-actions/{requiredActionId}`

## Request

- Base URL: `https://api.test.doola.com`
- URL: `https://api.test.doola.com/v1/partner/companies/{companyId}/required-actions/{requiredActionId}`
- Auth: API key in header `Authorization`

One required action with its full history, so you can see when it was raised, whether doola reached your endpoint, and how many rounds it has taken.

## Path parameters

- `companyId` string, required
- `requiredActionId` string, required

## Response `200`

OK

- PartnerRequiredActionDto: An action doola needs you to take on a company
  - `requiredActionId` string
  - `doolaCompanyId` string
  - `actionCode` 'FORMATION_NAME_OPTIONS_EXHAUSTED' | 'FORMATION_SIGNATURE_SS4_RESET' | 'FORMATION_SIGNATURE_FORM8821_REQUIRED' | 'FORMATION_FOUNDER_ADDRESS_REQUIRED': What is needed
  - `actionName` string: Human-readable label for the action
  - `status` 'created' | 'delivered' | 'delivery_failed' | 'submitted' | 'rejected' | 'resolved'
  - `reason` string: Human-readable explanation you can surface to your user
  - `requestedFieldIds` string[]: Field ids to send back when resolving, named as GET /compliance/annual-reports/requirements names them. Empty when closing the action needs something other than field values.
  - `open` boolean
  - `awaitingResponse` boolean: True while doola is waiting for you to act on this action; false once you have submitted a resolution or the action is closed
  - `updatedAt` string, date-time: When this action last changed
  - `history` PartnerRequiredActionEventDto[]
    - `status` 'created' | 'delivered' | 'delivery_failed' | 'submitted' | 'rejected' | 'resolved': Status this step set
    - `submittedPayload` SubmittedResolutionPayload: The resolution exactly as the partner submitted it
      - `actionCode` string
      - `nameOptions` SubmittedNameOption[]: The name options as sent, in the order they were sent
        - `name` string
        - `entityTypeEnding` string
        - `position` integer: Preference order, present only when the partner sent one
      - `addresses` SubmittedAddress[]: The addresses as sent
        - `provider` string
        - `type` string
        - `line1` string
        - `line2` string
        - `city` string
        - `state` string
        - `postalCode` string
        - `country` string
        - `phone` string
      - `companyDetails` SubmittedCompanyDetails: Company details as the partner submitted them
        - `companyName` string
        - `address` SubmittedAddress: A company address as the partner submitted it
          - `provider` string
          - `type` string
          - `line1` string
          - `line2` string
          - `city` string
          - `state` string
          - `postalCode` string
          - `country` string
          - `phone` string
        - `mailingAddress` SubmittedAddress: A company address as the partner submitted it
          - `provider` string
          - `type` string
          - `line1` string
          - `line2` string
          - `city` string
          - `state` string
          - `postalCode` string
          - `country` string
          - `phone` string
        - `physicalAddress` SubmittedAddress: A company address as the partner submitted it
          - `provider` string
          - `type` string
          - `line1` string
          - `line2` string
          - `city` string
          - `state` string
          - `postalCode` string
          - `country` string
          - `phone` string
        - `phoneNumber` string
        - `authorizedShares` number
        - `issuedShares` number
        - `perValuedShares` number
    - `createdAt` string, date-time: When this step happened

## Changes

- **2026-11-03** `f607744a8927`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/doola/apis/doola-partner-api/changes/v1/partner/companies/:companyId/required-actions/:requiredActionId/get.md)

---

[API](https://skmtc.dev/doola/apis/doola-partner-api.md) - [All operations](https://skmtc.dev/doola/apis/doola-partner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/doola/apis/doola-partner-api/revisions/f607744a8927?raw)
