Skip to main content
GET
List a company's required actions

Authorizations

Authorization
string
header
required

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.

Path Parameters

companyId
string
required

doola company ID (KSUID).

Response

200 - */*

OK

requiredActionId
string
Example:

"31pLdpvMh4OfO90moxLgLT8AuQr"

doolaCompanyId
string
Example:

"31pLD0Tq2lm2FsgRBoHv4x3BpzZ"

actionCode
enum<string>

What is needed

Available options:
FORMATION_NAME_OPTIONS_EXHAUSTED,
FORMATION_SIGNATURE_SS4_RESET
Example:

"FORMATION_NAME_OPTIONS_EXHAUSTED"

actionName
string

Human-readable label for the action

Example:

"New company names needed"

status
enum<string>
Available options:
created,
delivered,
delivery_failed,
submitted,
rejected,
resolved
Example:

"delivered"

reason
string

Human-readable explanation you can surface to your user

Example:

"All submitted company name options were rejected by the state. Submit new options."

open
boolean
updatedAt
string<date-time>

When this action last changed

history
object[]