> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# formdesk

> Formdesk Forms

**Server path:** `/formdesk` | **Type:** Application | **PCID required:** Yes

## Tools

| Tool                                                | Description                |
| --------------------------------------------------- | -------------------------- |
| [`formdesk_add_result`](#formdesk_add_result)       | Add a form result          |
| [`formdesk_connect`](#formdesk_connect)             | Connect to Formdesk API    |
| [`formdesk_delete_result`](#formdesk_delete_result) | Delete a form result       |
| [`formdesk_get_result`](#formdesk_get_result)       | Get a specific form result |
| [`formdesk_list_forms`](#formdesk_list_forms)       | List all forms             |
| [`formdesk_list_results`](#formdesk_list_results)   | List form results          |

***

## formdesk\_add\_result

Add a form result

**Parameters:**

| Parameter | Type   | Required | Default | Description                                                                                                                           |
| --------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| `formId`  | string | Yes      | —       | The form identifier (form name or ID)                                                                                                 |
| `body`    | object | Yes      | —       | Key-value pairs where keys are form field names and values are the submission values. The exact fields depend on the form definition. |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "formId": {
        "type": "string",
        "description": "The form identifier (form name or ID)"
      },
      "body": {
        "type": "object",
        "description": "Key-value pairs where keys are form field names and values are the submission values. The exact fields depend on the form definition."
      }
    },
    "required": [
      "PCID",
      "formId",
      "body"
    ]
  }
  ```
</Expandable>

***

## formdesk\_connect

Connect to Formdesk API

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## formdesk\_delete\_result

Delete a form result

**Parameters:**

| Parameter  | Type   | Required | Default | Description                           |
| ---------- | ------ | -------- | ------- | ------------------------------------- |
| `formId`   | string | Yes      | —       | The form identifier (form name or ID) |
| `resultId` | string | Yes      | —       | The result/submission identifier      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "formId": {
        "type": "string",
        "description": "The form identifier (form name or ID)"
      },
      "resultId": {
        "type": "string",
        "description": "The result/submission identifier"
      }
    },
    "required": [
      "PCID",
      "formId",
      "resultId"
    ]
  }
  ```
</Expandable>

***

## formdesk\_get\_result

Get a specific form result

**Parameters:**

| Parameter  | Type   | Required | Default | Description                           |
| ---------- | ------ | -------- | ------- | ------------------------------------- |
| `formId`   | string | Yes      | —       | The form identifier (form name or ID) |
| `resultId` | string | Yes      | —       | The result/submission identifier      |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "formId": {
        "type": "string",
        "description": "The form identifier (form name or ID)"
      },
      "resultId": {
        "type": "string",
        "description": "The result/submission identifier"
      }
    },
    "required": [
      "PCID",
      "formId",
      "resultId"
    ]
  }
  ```
</Expandable>

***

## formdesk\_list\_forms

List all forms

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      }
    },
    "required": [
      "PCID"
    ]
  }
  ```
</Expandable>

***

## formdesk\_list\_results

List form results

**Parameters:**

| Parameter   | Type    | Required | Default | Description                                          |
| ----------- | ------- | -------- | ------- | ---------------------------------------------------- |
| `formId`    | string  | Yes      | —       | The form identifier (form name or ID)                |
| `offset`    | integer | No       | —       | Number of results to skip (for pagination)           |
| `limit`     | integer | No       | —       | Maximum number of results to return (for pagination) |
| `date_from` | string  | No       | —       | Filter results from this date (format: YYYY-MM-DD)   |
| `date_to`   | string  | No       | —       | Filter results up to this date (format: YYYY-MM-DD)  |

<Expandable title="inputSchema">
  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "PCID": {
        "type": "string",
        "description": "Pink Connect ID for the authenticated connection"
      },
      "formId": {
        "type": "string",
        "description": "The form identifier (form name or ID)"
      },
      "offset": {
        "type": "integer",
        "description": "Number of results to skip (for pagination)"
      },
      "limit": {
        "type": "integer",
        "description": "Maximum number of results to return (for pagination)"
      },
      "date_from": {
        "type": "string",
        "description": "Filter results from this date (format: YYYY-MM-DD)"
      },
      "date_to": {
        "type": "string",
        "description": "Filter results up to this date (format: YYYY-MM-DD)"
      }
    },
    "required": [
      "PCID",
      "formId"
    ]
  }
  ```
</Expandable>
