ClientCasa
API

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.

Forms are the lead-capture and discovery form definitions you build on the Forms page. Each form has a kind:

  • inquiry — your public lead-capture form. A visitor fills it out, and ClientCasa creates a Contact and a lead (a lead is a Client at an early lifecycle status — new, contacted, or qualified). The default inquiry form is flagged isDefault; its slug powers the public URL.
  • questionnaire — a reusable discovery template you send to clients to gather details. An org can have many.

Forms are built in the dashboard designer, so the v1 API exposes them read-only. The submitted answers live in Form Submissions.

GET
/api/v1/forms

Authorization

x-api-key<token>

In: header

Query Parameters

page?integer
Default1
Range1 <= value
pageSize?integer
Default25
Range1 <= value <= 100
kind?string
Value in"inquiry" | "questionnaire"
slug?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.clientcasa.com/api/v1/forms"
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "string",
      "title": "string",
      "description": "string",
      "kind": "inquiry",
      "slug": "string",
      "enabled": true,
      "isDefault": true,
      "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/forms/{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/forms/550e8400-e29b-41d4-a716-446655440000"
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "string",
  "title": "string",
  "description": "string",
  "kind": "inquiry",
  "slug": "string",
  "enabled": true,
  "isDefault": true,
  "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
    }
  }
}

Contacts

Manage contacts — people you communicate with, with or without a client relationship.

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.