ClientCasa
API

Form Submissions

Read completed form submissions. One row is one submission — it carries the form, kind, contact, status, and submittedAt. The normalized answers come back on a single GET; the list omits them. Submissions are created by the public forms, so the v1 API is read-only — ideal for syncing new leads and their answers into another system.

A form submission is one completed fill of a form — one row per submission. Each carries the form it belongs to, the denormalized kind (inquiry or questionnaire), the contact (and client, once a relationship exists), a status (in_progress or submitted), the source, and the date it was submittedAt.

The answers are normalized into form-responses, so a single GET /api/v1/form-submissions/{id} returns them under answers (each with a fieldId, question, and answer). The list endpoint omits answers (they come back as null) — fetch the individual submission to read them.

Because an inquiry submission is how a lead enters ClientCasa, this is the high-value sync point for integrations: pull new submissions and their answers into a CRM or sheet. Submissions are created by the public forms rather than the API, so the v1 API exposes them read-only.

GET
/api/v1/form-submissions

Authorization

x-api-key<token>

In: header

Query Parameters

page?integer
Default1
Range1 <= value
pageSize?integer
Default25
Range1 <= value <= 100
formId?string

UUID v4

Formatuuid
kind?string
Value in"inquiry" | "questionnaire"
status?string
Value in"in_progress" | "submitted"
contactId?string

UUID v4

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.clientcasa.com/api/v1/form-submissions"
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "formId": "550e8400-e29b-41d4-a716-446655440000",
      "kind": "inquiry",
      "status": "in_progress",
      "contactId": "550e8400-e29b-41d4-a716-446655440000",
      "clientId": "550e8400-e29b-41d4-a716-446655440000",
      "source": "string",
      "submittedAt": "2019-08-24",
      "answers": [
        {
          "fieldId": "string",
          "question": "string",
          "answer": "string"
        }
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "total": 0,
    "totalPages": 0,
    "hasMore": true
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
GET
/api/v1/form-submissions/{id}

Authorization

x-api-key<token>

In: header

Path Parameters

id*string

UUID v4

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.clientcasa.com/api/v1/form-submissions/550e8400-e29b-41d4-a716-446655440000"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "formId": "550e8400-e29b-41d4-a716-446655440000",
  "kind": "inquiry",
  "status": "in_progress",
  "contactId": "550e8400-e29b-41d4-a716-446655440000",
  "clientId": "550e8400-e29b-41d4-a716-446655440000",
  "source": "string",
  "submittedAt": "2019-08-24",
  "answers": [
    {
      "fieldId": "string",
      "question": "string",
      "answer": "string"
    }
  ],
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "string",
    "requestId": "string",
    "details": {
      "property1": null,
      "property2": null
    }
  }
}

Forms

Read your inquiry and questionnaire form definitions. A form has a kind (inquiry or questionnaire), a name, an optional public slug, an enabled flag, and an isDefault flag. The inquiry form is your public lead-capture form — when someone submits it, a lead is created (a lead is a Client at an early status). Questionnaires are reusable discovery templates. Forms are built in the dashboard designer, so the v1 API is read-only.

Inquiries (Lead Capture)

Submit a lead from your own website into a ClientCasa organization. A named-field endpoint — no form-field ids — that creates the lead, seeds the inbox, and sends the owner alert and visitor confirmation, exactly like a hosted ClientCasa form. The one write endpoint in the lead-capture flow; read the results back via Form Submissions.