> ## Documentation Index
> Fetch the complete documentation index at: https://docs.doola.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve a required action

> 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.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/partner/companies/{companyId}/required-actions/{requiredActionId}
openapi: 3.1.0
info:
  title: doola Partner API
  description: >-
    REST API for doola partners to create and manage customers and companies,
    retrieve formation documents, and look up reference data.


    Authenticate every request with a partner API key in the `Authorization`
    header. Generate keys and manage webhooks and event subscriptions in the
    doola Partner Portal.
  contact:
    name: doola
    url: https://www.doola.com
  version: v1
servers:
  - url: https://api.test.doola.com
    description: Sandbox — use test keys (dk_test_…)
  - url: https://api.doola.com
    description: Production — use live keys (dk_live_…)
security:
  - PartnerApiKey: []
tags:
  - name: Playground (sandbox only)
    description: >-
      Sandbox-only helpers to drive a test company through the Formation and
      EinCreation milestones end to end.
  - name: Required Actions
    description: >-
      Actions doola needs you to take on a company, such as supplying new name
      options after a state rejection.
  - name: Customers
    description: Create and look up customers under your partner tenant.
  - name: Documents
    description: List and download a company's formation documents.
  - name: Compliance
    description: Track a company's compliance obligations and their due dates.
  - name: Signatures
    description: Request embedded signing sessions for pending company documents.
  - name: Companies
    description: Create companies for your customers, then track formation status.
  - name: Reference data
    description: >-
      Static lookups for building company-creation requests: NAICS codes,
      states, countries, and state filing fees.
paths:
  /v1/partner/companies/{companyId}/required-actions/{requiredActionId}:
    get:
      tags:
        - Required Actions
      summary: Retrieve a required action
      description: >-
        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.
      operationId: getRequiredAction
      parameters:
        - name: companyId
          in: path
          description: doola company ID (KSUID).
          required: true
          schema:
            type: string
        - name: requiredActionId
          in: path
          description: Required action ID (KSUID).
          required: true
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PartnerRequiredActionDto'
components:
  schemas:
    PartnerRequiredActionDto:
      type: object
      description: An action doola needs you to take on a company
      properties:
        requiredActionId:
          type: string
          example: 31pLdpvMh4OfO90moxLgLT8AuQr
        doolaCompanyId:
          type: string
          example: 31pLD0Tq2lm2FsgRBoHv4x3BpzZ
        actionCode:
          type: string
          description: What is needed
          enum:
            - FORMATION_NAME_OPTIONS_EXHAUSTED
            - FORMATION_SIGNATURE_SS4_RESET
          example: FORMATION_NAME_OPTIONS_EXHAUSTED
        actionName:
          type: string
          description: Human-readable label for the action
          example: New company names needed
        status:
          type: string
          enum:
            - created
            - delivered
            - delivery_failed
            - submitted
            - rejected
            - resolved
          example: delivered
        reason:
          type: string
          description: Human-readable explanation you can surface to your user
          example: >-
            All submitted company name options were rejected by the state.
            Submit new options.
        open:
          type: boolean
        updatedAt:
          type: string
          format: date-time
          description: When this action last changed
        history:
          type: array
          items:
            $ref: '#/components/schemas/PartnerRequiredActionEventDto'
    PartnerRequiredActionEventDto:
      type: object
      description: A single step in a required action's history
      properties:
        status:
          type: string
          description: Status this step set
          enum:
            - created
            - delivered
            - delivery_failed
            - submitted
            - rejected
            - resolved
          example: delivered
        submittedPayload:
          $ref: '#/components/schemas/JsonNode'
          description: >-
            The resolution exactly as you submitted it. Present on submitted
            steps only; a historical record of that step, not the company's
            current state.
        createdAt:
          type: string
          format: date-time
          description: When this step happened
    JsonNode:
      type: object
      properties:
        empty:
          type: boolean
        array:
          type: boolean
        'null':
          type: boolean
        object:
          type: boolean
        float:
          type: boolean
        container:
          type: boolean
        textual:
          type: boolean
          deprecated: true
        number:
          type: boolean
        string:
          type: boolean
        integralNumber:
          type: boolean
        missingNode:
          type: boolean
        valueNode:
          type: boolean
        pojo:
          type: boolean
        floatingPointNumber:
          type: boolean
        short:
          type: boolean
        int:
          type: boolean
        long:
          type: boolean
        double:
          type: boolean
        bigDecimal:
          type: boolean
        bigInteger:
          type: boolean
        boolean:
          type: boolean
        binary:
          type: boolean
        nodeType:
          type: string
          enum:
            - ARRAY
            - BINARY
            - BOOLEAN
            - MISSING
            - 'NULL'
            - NUMBER
            - OBJECT
            - POJO
            - STRING
        embeddedValue:
          type: boolean
  securitySchemes:
    PartnerApiKey:
      type: apiKey
      description: >-
        Partner API key. Send the raw key as the `Authorization` header value —
        e.g. `dk_test_…` in sandbox or `dk_live_…` in production. Generate and
        rotate keys in the doola Partner Portal.
      name: Authorization
      in: header

````