Intake

Get an intake submission

get/intake/{matterId}/submissions/{submissionId}

Request

  • Base URL
    https://api.smokeball.com
  • URL
    https://api.smokeball.com/intake/{matterId}/submissions/{submissionId}
  • Auth
    API key in header x-api-key and API key in header Authorization

Path parameters

submissionIdstring required

The intake submission identifier.

matterIdstring required

Response

OK

idstring nullable
hrefstring nullable
relationstring nullable
methodstring nullable
formIdstring nullable

Id of the form that the submission is for.

formTitlestring nullable

Title of the form that the submission is for.

status'draft' | 'active' | 'completed' | 'cancelled'

Intake submission status.

communicationMethod'email' | 'communicate' | 'embed' | 'internalUse' | 'document'

Intake submission communication method.

createdDatestring date-time

When the submission was created.

lastUpdatedstring date-time

When the submission was last updated.

Example response

{
  "formId": "ae4bc84e-b601-4767-9d0f-5d078832418e",
  "formTitle": "Client Intake Form",
  "createdDate": "2026-01-01T00:00:00.0000000+00:00",
  "lastUpdated": "2026-01-01T00:00:00.0000000+00:00",
  "recipient": {
    "contactId": "5d9b8697-8c6f-45dd-b22d-87045ed4df35",
    "email": "client@example.com",
    "name": "Sample Client"
  },
  "responses": [
    {
      "sectionTitle": "Contact Details",
      "groups": [
        {
          "label": "Primary Contact",
          "fields": [
            {
              "label": "Phone number",
              "value": "0400 000 000"
            }
          ]
        }
      ],
      "fields": [
        {
          "label": "Phone number",
          "value": "0400 000 000"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 15 revisions of this API.