Required Actions

List open required actions across your companies

Changed on

Every open required action across all of your companies, most recently changed first. Closed actions are excluded — use the per-company listing to reconcile those. total carries the tenant-wide open count whatever the page size. Histories are omitted; read a single action for those.

get/v1/partner/required-actions

Request

  • Base URL
    https://api.test.doola.com
  • URL
    https://api.test.doola.com/v1/partner/required-actions
  • Auth
    API key in header Authorization

Query parameters

pageinteger

Zero-based page index.

sizeinteger

Page size (max 100).

Response

OK

pageinteger
sizeinteger
totalinteger
totalPagesinteger

Example response

{
  "content": [
    {
      "requiredActionId": "31pLdpvMh4OfO90moxLgLT8AuQr",
      "doolaCompanyId": "31pLD0Tq2lm2FsgRBoHv4x3BpzZ",
      "actionCode": "FORMATION_NAME_OPTIONS_EXHAUSTED",
      "actionName": "New company names needed",
      "status": "delivered",
      "reason": "All submitted company name options were rejected by the state. Submit new options.",
      "requestedFieldIds": [
        "address"
      ],
      "history": [
        {
          "status": "delivered",
          "submittedPayload": {
            "actionCode": "FORMATION_NAME_OPTIONS_EXHAUSTED",
            "nameOptions": [
              {
                "name": "Acme Holdings",
                "entityTypeEnding": "LLC"
              }
            ],
            "addresses": [
              {
                "provider": "customer",
                "type": "business"
              }
            ],
            "companyDetails": {
              "address": {
                "provider": "customer",
                "type": "business"
              },
              "mailingAddress": {
                "provider": "customer",
                "type": "business"
              },
              "physicalAddress": {
                "provider": "customer",
                "type": "business"
              }
            }
          }
        }
      ]
    }
  ]
}

Changes