Paperform API

https://paperform.readme.io/reference
Admin
The Paperform API allows developers to programmatically manage forms, submissions, products,...
Tokens:746,833
Snippets:2,272
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Getting Started

Source: https://paperform.readme.io/reference/webhooks

Basic information on getting started with the Paperform API, including initial setup and common requests.

```APIDOC
## Getting Started

### Description

This section provides basic information for getting started with the Paperform API. It outlines the initial steps for making requests and understanding the API's structure.

### Method

GET

### Endpoint

(No specific endpoint URL provided in the source data for this section)

### Parameters

No specific parameters are detailed for this introductory section.

### Request Example

(No request example provided in the source data)

### Response

#### Success Response (200)

- **(No specific fields detailed)** - The structure of a successful response is not specified in the source data, but typically includes an empty JSON object `{}` for this type of endpoint.

#### Response Example

```json
{}
```
```

--------------------------------

### Getting Started

Source: https://paperform.readme.io/reference/papersign-documents

Information on how to get started with the Paperform API, including authentication requirements.

```APIDOC
## Getting Started

### Description
This section covers the initial steps for using the Paperform API, including authentication details.

### Method
GET

### Endpoint
(No specific URL provided in the source)

### Parameters
(No parameters listed in the source)

### Request Example
(No request example provided in the source)

### Response
#### Success Response (200)
- **(No fields defined)**

#### Error Response (400)
- **(No fields defined)**

#### Response Example
```json
{}
```
```

--------------------------------

### Getting Started

Source: https://paperform.readme.io/reference/papersign-spaces

Basic information on how to get started with the Paperform API, including authentication requirements.

```APIDOC
## Getting Started API

### Description
This section provides introductory information and authentication details for using the Paperform API.

### Method
GET

### Endpoint
/

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the request.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Paperform API - Getting Started (JSON Example)

Source: https://paperform.readme.io/reference/index

This snippet shows an example JSON response for the 'Getting Started' section of the Paperform API. It illustrates a successful response with status code 200 and a potential error response with status code 400.

```json
{}
```

```json
{}
```

--------------------------------

### Getting Started

Source: https://paperform.readme.io/reference/papersign-webhooks

This section provides basic information on how to get started with the Paperform API, including authentication requirements.

```APIDOC
## GET /

### Description
Provides introductory information and setup guidance for the Paperform API.

### Method
GET

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (200)
- **message** (string) - A success message or status.

#### Response Example
```json
{
  "message": "API ready to use"
}
```
```

--------------------------------

### Getting Started

Source: https://paperform.readme.io/reference/spaces

This section provides an overview of how to get started with the Paperform API. It outlines the authentication requirements and basic request structure.

```APIDOC
## GET /

### Description
This endpoint is for getting started with the Paperform API. It outlines authentication requirements.

### Method
GET

### Endpoint
/

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **(object)** - An empty JSON object indicating a successful request.

#### Response Example
```json
{}
```
```

--------------------------------

### Getting Started

Source: https://paperform.readme.io/reference/translations

Basic information to get started with the Paperform API. This endpoint typically returns a success or error status.

```APIDOC
## GET /api/getting-started

### Description
This endpoint provides general information or a status check for the Paperform API.

### Method
GET

### Endpoint
`/api/getting-started`

### Parameters
#### Query Parameters
None

#### Request Body
None

### Request Example
```bash
curl -X GET \
  '/api/getting-started' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'
```

### Response
#### Success Response (200)
- **message** (string) - A success message or status indicator.

#### Response Example
```json
{
  "message": "API is functioning correctly."
}
```

#### Error Response (400)
- **error** (string) - A description of the error.

#### Response Example
```json
{
  "error": "Invalid API key provided."
}
```
```

--------------------------------

### Example Endpoint

Source: https://paperform.readme.io/reference/webhooks

An example endpoint demonstrating a GET request that requires authentication and returns a JSON response.

```APIDOC
## Example Endpoint

### Description

This endpoint is an example demonstrating a typical GET request that requires authentication. It is designed to illustrate the structure of API interactions within the Paperform API.

### Method

GET

### Endpoint

(No specific endpoint URL provided in the source data for this example)

### Parameters

No specific parameters are detailed for this example endpoint.

### Request Example

(No request example provided in the source data)

### Response

#### Success Response (200)

- **(No specific fields detailed)** - The success response for this endpoint is indicated as an empty JSON object `{}`.

#### Response Example

```json
{}
```

#### Error Response (400)

- **(No specific fields detailed)** - The error response for this endpoint is also indicated as an empty JSON object `{}`.

#### Response Example

```json
{}
```
```

--------------------------------

### API Get Request Example (JSON Response)

Source: https://paperform.readme.io/reference/spaces

This snippet defines an example of a GET API request for forms. It specifies that the API requires authentication and provides example JSON responses for success (status 200) and failure (status 400).

```json
{
  "name": "",
  "code": "{}",
  "language": "json",
  "status": 200
}
```

```json
{
  "name": "",
  "code": "{}",
  "language": "json",
  "status": 400
}
```

--------------------------------

### Form Fields Response Example (JSON)

Source: https://paperform.readme.io/reference/spaces

An example of the JSON response structure when retrieving form fields. This illustrates the typical fields returned for each form field, including its type, label, and configuration options. The 'codes' array may contain success (200) and error (400) response examples.

```json
{
  "codes": [
    {
      "name": "",
      "code": "{}",
      "language": "json",
      "status": 200
    },
    {
      "name": "",
      "code": "{}",
      "language": "json",
      "status": 400
    }
  ]
}
```

--------------------------------

### Coupons API Response Examples

Source: https://paperform.readme.io/reference/papersign-webhooks

Example JSON responses for the Coupons API, including a successful response (200) and a bad request response (400).

```json
{}

```

```json
{}

```

--------------------------------

### Get Form Product (GET)

Source: https://paperform.readme.io/reference/papersign-spaces

Retrieves details of a specific product associated with a form. Requires form slug or ID and the product SKU. Authentication is required. No specific parameters are detailed, and the output schema is empty in this reference.

```HTTP
GET /forms/{slug_or_id}/products/{product_sku}
```

--------------------------------

### Example JSON Object

Source: https://paperform.readme.io/reference/listforms

This is an example of a JSON object, likely representing a Paperform submission or configuration. It includes basic fields like an ID.

```json
{
  "_id": "628f104209e221006e6c52fc"
}
```

--------------------------------

### Paperform API - List Forms Endpoint (JSON Example)

Source: https://paperform.readme.io/reference/index

This snippet demonstrates an example JSON response for the '/forms' endpoint, which is used to list forms. It's intended to show a successful retrieval of form data.

```json
{}
```

--------------------------------

### API Authentication Example (Bearer Token)

Source: https://paperform.readme.io/reference/spaces

This snippet demonstrates how to set up API authentication using a Bearer token. It shows the input field for the token and a button to toggle visibility, typical for security-related inputs.

```html
<div class="InputGroup-dropdown Dropdown Dropdown_closed" data-testid="dropdown-container"><button class="Button Button_sm InputGroup-button Dropdown-toggle" data-testid="api-auth-security-button" disabled="" aria-haspopup="dialog"><span>Bearer</span></button></div><div class="InputGroup-input-parent " data-testid="auth-input" translate="no"><div class="InputGroup-dropdown-inputs "><input autoComplete="off" class="InputGroup-input " id="APIAuth-token" placeholder="token" required="" spellcheck="false" type="text" value=""/><button aria-label="Hide" class="Button Button_xs rm-APIAuth-lock undefined Button_minimum Button_minimum_text Button_uppercase" type="button"><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="lock" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M19 11H5a2 2 0 0 0-2 2v7a2 2 0 0 0 2 2h14a2 2 0 0 0 2-2v-7a2 2 0 0 0-2-2ZM7 11V7a5 5 0 1 1 10 0v4" class="icon-stroke-width"></path></svg></span></button></div></div>
```

--------------------------------

### Configure Integrations and Project Settings

Source: https://paperform.readme.io/reference/papersign-documents

This JSON snippet configures project-wide settings, including enabling integrations like Wootric with an account token and defining various appearance aspects for the developer hub. It also sets up terms, variables, and AI-related configurations.

```json
{
  "projectsEnabled": true
},
"wootric": {
  "accountToken": "NPS-122b75a4",
  "enabled": true
}},
"context": {
  "labs": {},
  "user": {
    "isAuthenticated": false
  },
  "terms": [
    {
      "_id": "628f0feb6cbd2702cf3624a0",
      "term": "parliament",
      "definition": "Owls are generally solitary, but when seen together the group is called a 'parliament'!"
    }
  ],
  "variables": {
    "user": {},
    "defaults": [
      {
        "source": "security",
        "type": "http",
        "_id": "677c932cba96e000178f9c6f",
        "name": "bearerAuth",
        "scheme": "bearer",
        "apiSetting": "628f0fc209e221006e6c52fc"
      }
    ],
    "project": {
      "_id": "628f0feb6cbd2702cf36249f",
      "ai": {
        "chat": {
          "knowledge": {
            "custom_knowledge": null,
            "use_project_knowledge": false
          },
          "models": []
        }
      },
      "appearance": {
        "rdmd": {
          "callouts": {
            "useIconFont": false
          },
          "theme": {
            "background": "",
            "border": "",
            "markdownEdge": "",
            "markdownFont": "",
            "markdownFontSize": "",
            "markdownLineHeight": "",
            "markdownRadius": "",
            "markdownText": "",
            "markdownTitle": "",
            "markdownTitleFont": "",
            "mdCodeBackground": "",
            "mdCodeFont": "",
            "mdCodeRadius": "",
            "mdCodeTabs": "",
            "mdCodeText": "",
            "tableEdges": "",
            "tableHead": "",
            "tableHeadText": "",
            "tableRow": "",
            "tableStripe": "",
            "tableText": "",
            "text": "",
            "title": ""
          }
        },
        "main_body": {
          "type": "links"
        },
        "colors": {
          "highlight": "",
          "main": "#f2f0e8",
          "main_alt": "",
          "header_text": "",
          "body_highlight": "rgb(51, 51, 51)",
          "custom_login_link_color": ""
        },
        "typography": {
          "headline": "Open+Sans:400:sans-serif",
          "body": "Open+Sans:400:sans-serif",
          "typekit": false,
          "tk_key": "",
          "tk_headline": "",
          "tk_body": ""
        },
        "header": {
          "style": "solid",
          "img": [],
          "img_size": "auto",
          "img_pos": "tl",
          "linkStyle": "buttons"
        },
        "body": {
          "style": "none"
        },
        "global_landing_page": {
          "html": "",
          "redirect": ""
        },
        "referenceSimpleMode": true,
        "referenceLayout": "row",
        "link_logo_to_url": false,
        "theme": "solid",
        "overlay": "triangles",
        "landing": true,
        "sticky": false,
        "hide_logo": false,
        "childrenAsPills": false,
        "subheaderStyle": "links",
        "splitReferenceDocs": false,
        "showMetricsInReference": true,
        "logo": [
          "https://files.readme.io/eb6f15a-small-alt_3_lockup__black_on_transparent_.png",
          "alt_3_lockup__black_on_transparent_.png",
          322,
          80,
          "#000000",
          "https://files.readme.io/221d8d6-alt_3_lockup__black_on_transparent_.png"
        ],
        "loginLogo": [],
        "logo_white": [
          "https://files.readme.io/30a48c2-Paperform_Master_White.svg",
          "Paperform_Master_White.svg",
          0,
          0,
          "#000000"
        ],
        "logo_white_use": false,
        "favicon": [
          "https://files.readme.io/a4c708d-favicon.ico",
          "favicon.ico",
          48,
          48,
          "#000000"
        ],
        "stylesheet": "",
        "stylesheet_hub2": "",
        "stylesheet_hub3": "",
        "javascript": "",
        "javascript_hub2": "",
        "html_promo": "",
        "html_body": "",
        "html_footer": "",
        "html_head": "",
        "html_footer_meta": "",
        "html_hidelinks": false,
        "showVersion": true,
        "hideTableOfContents": false,
        "nextStepsLabel": "",
        "promos": [
          {
            "extras": {
              "type": "buttons",
              "buttonPrimary": "get-started",
              "buttonSecondary": "none"
            },
            "title": "The Paperform Public API Developer Hub",
            "text": "Welcome to the Paperform Public API developer hub. You'll find comprehensive guides and documentation to help you start working with Paperform Public API as quickly as possible, as well as support if you get stuck. Let's jump right in!"
          }
        ]
      }
    }
  }
}

```

--------------------------------

### Get documents (PHP)

Source: https://paperform.readme.io/reference/papersign-documents

This code snippet provides an example of retrieving a list of documents via the Paperform API's /papersign/documents endpoint using PHP. It employs cURL for making the GET request and requires a Bearer token for authentication.

```php
<?php

$apiUrl = 'https://api.paperform.co/v1/papersign/documents';
$apiToken = 'YOUR_API_TOKEN';

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, $apiUrl);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_HTTPHEADER, array(
    'Authorization: Bearer ' . $apiToken
));

$response = curl_exec($ch);

if (curl_errno($ch)) {
    echo 'Error:' . curl_error($ch);
} else {
    echo 'Documents: ' . $response;
}

c   url_close($ch);

?>
```

--------------------------------

### Get Forms in a Space - cURL Example

Source: https://paperform.readme.io/reference/webhooks

Shows how to list all forms associated with a specific space using cURL. This endpoint is part of the Business API and returns a JSON array of form objects if the request is successful.

```shell
curl -X GET https://api.paperform.co/v1/spaces/{id}/forms \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### Paperform README.io Configuration Example

Source: https://paperform.readme.io/reference/getformsubmission

This JSON snippet illustrates a configuration object for Paperform's integration with README.io. It includes settings related to proxy enablement and a unique document identifier.

```json
{
  "proxy-enabled": true
  },
  "_id": "628f104209e221006e6c52fc"
}
```

--------------------------------

### Create Form Product (POST)

Source: https://paperform.readme.io/reference/papersign-spaces

Creates a new product for a specific form. Requires form slug or ID. Authentication is required. No specific parameters are detailed, and the output schema is empty in this reference.

```HTTP
POST /forms/{slug_or_id}/products
```

--------------------------------

### Get Space by ID - cURL Example

Source: https://paperform.readme.io/reference/webhooks

Demonstrates how to retrieve a specific space using its ID via cURL. This endpoint requires Business API access and returns a JSON object containing space details upon success.

```shell
curl -X GET https://api.paperform.co/v1/spaces/{id} \
  -H "Authorization: Bearer YOUR_API_KEY"
```

--------------------------------

### GET /results?form={formIdParam}

Source: https://paperform.readme.io/reference/spaces

Get results for a specific form, identified by its ID or slug.

```APIDOC
## GET /results

### Description
Get results for a specific form, identified by its ID or slug.

### Method
GET

### Endpoint
/results

### Parameters
#### Query Parameters
- **form** (string) - Required - The slug, custom slug or ID of a Form to get results for.
- **search** (string) - Optional - Search forms by title.
- **skip** (integer) - Optional - Number of results to skip in the result set. Defaults to 0.
- **limit** (integer) - Optional - The number of results to return. Defaults to 20, maximum 100.
- **sort** (string) - Optional - The direction to sort in. Results are sorted by `created_at`, and defaults to `DESC`. Enum: [ASC, DESC].
- **before_date** (string, date-time) - Optional - Return results created on or after this date-time (UTC). Overwritten by `before_id`.
- **after_date** (string, date-time) - Optional - Return results created before this date (UTC). Overwritten by `after_id`.
- **after_id** (string) - Optional - Return results after the provided ID.
- **before_id** (string) - Optional - Return results before the provided ID.

### Response
#### Success Response (200)
- **results** (array) - An array of form submission results.
- **next_page** (string) - URL for the next page of results.

#### Response Example
```json
{
  "results": [
    {
      "submission_id": "sub_123",
      "submitted_at": "2023-10-27T11:00:00Z"
    }
  ],
  "next_page": "/results?form=67fqxwkp&after_id=sub_123"
}
```
```

--------------------------------

### GET /products?search={productSearch}

Source: https://paperform.readme.io/reference/spaces

Search for products by name.

```APIDOC
## GET /products

### Description
Search for products by name.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **search** (string) - Optional - Search products by name.
- **limit** (integer) - Optional - The number of results to return. Defaults to 20, maximum 100.

### Response
#### Success Response (200)
- **products** (array) - An array of product objects matching the search criteria.

#### Response Example
```json
{
  "products": [
    {
      "sku": "SKU-456",
      "name": "T-Shirt"
    }
  ]
}
```
```

--------------------------------

### List Products

Source: https://paperform.readme.io/reference/webhooks

Retrieves a list of products, with options for searching and pagination.

```APIDOC
## GET /products

### Description
Retrieves a list of products, with options for searching and pagination.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **search** (string) - Optional - Search products by name.
- **skip** (integer) - Optional - Number of results to skip in the result set. Defaults to 0.
- **limit** (integer) - Optional - The number of results to return. Maximum is 100. Defaults to 20.
- **sort** (string) - Optional - The direction to sort in. Results are sorted by `created_at`. Enum: ASC, DESC. Defaults to DESC.

### Response
#### Success Response (200)
- **products** (array) - A list of product objects.

#### Response Example
```json
{
  "products": [
    {
      "id": "prod_abc",
      "sku": "SKU-123",
      "name": "Sample Product"
    }
  ]
}
```
```

--------------------------------

### GET /papersign/folders

Source: https://paperform.readme.io/reference/papersign-documents

Retrieves a list of all Paperform folders. This endpoint is useful for getting an overview of the folder structure.

```APIDOC
## GET /papersign/folders

### Description
Retrieves a list of all Paperform folders.

### Method
GET

### Endpoint
/papersign/folders

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{} 
```

### Response
#### Success Response (200)
- **folders** (array) - A list of folder objects.
  - **id** (string) - The ID of the folder.
  - **name** (string) - The name of the folder.

#### Response Example
```json
{
  "folders": [
    {
      "id": "folder_abc123",
      "name": "Project Alpha"
    },
    {
      "id": "folder_xyz789",
      "name": "Archived"
    }
  ]
}
```

```

--------------------------------

### List Form Products (GET)

Source: https://paperform.readme.io/reference/papersign-spaces

Retrieves a list of products associated with a specific form. Requires form slug or ID. Authentication is required. No specific parameters are detailed, and the output schema is empty in this reference.

```HTTP
GET /forms/{slug_or_id}/products
```

--------------------------------

### Get Submission

Source: https://paperform.readme.io/reference/papersign-spaces

Retrieves a specific submission by its ID. This endpoint is a shortcut for getting a submission without specifying the form.

```APIDOC
## GET /submissions/{id}

### Description
Retrieves a specific submission by its ID.

### Method
GET

### Endpoint
`/submissions/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the submission.

### Response
#### Success Response (200)
- **submission** (object) - The submission object.
  - **id** (string) - The ID of the submission.
  - **created_at** (string) - The timestamp when the submission was created.
  - **data** (object) - The submission data.

#### Response Example
```json
{
  "submission": {
    "id": "sub_123",
    "created_at": "2023-10-27T10:00:00Z",
    "data": {
      "name": "John Doe",
      "email": "john.doe@example.com"
    }
  }
}
```
```

--------------------------------

### GET /forms/{id}/submissions

Source: https://paperform.readme.io/reference/papersign-folders

Get a list of submissions for a specific form, identified by its ID. Supports filtering and pagination.

```APIDOC
## GET /forms/{id}/submissions

### Description
Get a list of submissions for a specific form, identified by its ID. Supports filtering and pagination.

### Method
GET

### Endpoint
/forms/{id}/submissions

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the record to get.

#### Query Parameters
- **form** (string) - Required - The slug, custom slug or ID of a Form to get results for.
- **search** (string) - Optional - Search forms by title.
- **after_id** (string) - Optional - Return results after the provided ID.
- **before_id** (string) - Optional - Return results before the provided ID.
- **skip** (integer) - Optional - Number of results to skip in the result set. Defaults to 0.
- **limit** (integer) - Optional - The number or results to return. Maximum is 100. Defaults to 20.
- **sort** (string) - Optional - The direction to sort in. Results are sorted by `created_at`, and defaults to `"DESC"`.
- **before_date** (string) - Optional - Return results created on or after this date-time (UTC). Overwritten by `before_id`.
- **after_date** (string) - Optional - Return results created before this date (UTC). Overwritten by `after_id`.

### Response
#### Success Response (200)
- **(Array)** - List of submissions

#### Response Example
```json
{
  "example": "response body"
}
```
```

--------------------------------

### GET /papersign/spaces

Source: https://paperform.readme.io/reference/spaces

Retrieves a list of all papersign spaces. This endpoint is used to get an overview of all available spaces within the system.

```APIDOC
## GET /papersign/spaces

### Description
Retrieves a list of all papersign spaces.

### Method
GET

### Endpoint
/papersign/spaces

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{} 
```

### Response
#### Success Response (200 OK)
- **spaces** (array of objects) - A list of papersign spaces. Each object contains details about a space.
  - **id** (string) - The ID of the space.
  - **name** (string) - The name of the space.

#### Response Example
```json
{
  "spaces": [
    {
      "id": "space_abc123",
      "name": "Marketing Campaign"
    },
    {
      "id": "space_def456",
      "name": "Sales Proposals"
    }
  ]
}
```
```

--------------------------------

### Contact Support

Source: https://paperform.readme.io/reference/getting-started-1

For assistance with the Paperform API, contact the support team via in-app chat or email.

```APIDOC
## Contact Support

For help working with the Paperform API contact our support team via the [in-app chat](https://paperform.co/dashboard) or via [email](mailto:support@paperform.co).
```

--------------------------------

### Get Submission by ID

Source: https://paperform.readme.io/reference/spaces

Retrieve a specific submission using its unique ID. This endpoint is a shortcut for getting a submission without specifying the form.

```APIDOC
## GET /submissions/{id}

### Description
Retrieves a specific submission using its unique ID.

### Method
GET

### Endpoint
`/submissions/{id}`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique ID of the submission.
```

--------------------------------

### Create Form Product

Source: https://paperform.readme.io/reference/translations

Creates a new product associated with a specific form. Requires authentication.

```APIDOC
## POST /forms/{slug_or_id}/products

### Description
Creates a new product associated with a specific form.

### Method
POST

### Endpoint
/forms/{slug_or_id}/products

### Parameters
#### Path Parameters
- **slug_or_id** (string) - Required - The unique slug or ID of the form.

#### Request Body
- **product** (object) - Required - The details of the product to create.
  - **sku** (string) - Required - The Stock Keeping Unit of the product.
  - **name** (string) - Required - The name of the product.
  - **price** (number) - Required - The price of the product.
  - **description** (string) - Optional - A description of the product.

### Request Example
```json
{
  "product": {
    "sku": "PROD002",
    "name": "New Gadget",
    "price": 99.50,
    "description": "An amazing new gadget."
  }
}
```

### Response
#### Success Response (201 Created)
- **message** (string) - A success message indicating the product was created.
- **product** (object) - The newly created product object.

#### Response Example
```json
{
  "message": "Product created successfully.",
  "product": {
    "sku": "PROD002",
    "name": "New Gadget",
    "price": 99.50,
    "description": "An amazing new gadget."
  }
}
```
```

--------------------------------

### Create Form Product

Source: https://paperform.readme.io/reference/translations

Creates a new product for a specific form.

```APIDOC
## POST /forms/{slug_or_id}/products

### Description
Creates a new product within a specific form. The form can be identified by its slug or ID.

### Method
POST

### Endpoint
/forms/{slug_or_id}/products

### Parameters
#### Path Parameters
- **slug_or_id** (string) - Required - The slug or unique identifier of the form.

#### Request Body
- **product** (object) - Required - The details of the product to be created.
  - **name** (string) - Required - The name of the product.
  - **price** (number) - Required - The price of the product.
  - **description** (string) - Optional - A description of the product.
  - **sku** (string) - Optional - The stock keeping unit for the product.

### Response
#### Success Response (201)
- **product** (object) - The newly created product object.
```

--------------------------------

### Get Partial Submission - JS

Source: https://paperform.readme.io/reference/spaces

Retrieves a specific partial submission using its unique ID. This endpoint requires authentication and uses the GET method.

```javascript
fetch("/partial-submissions/{id}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
})
.then(response => response.json())
.then(data => console.log(data))
```

--------------------------------

### Product Schema

Source: https://paperform.readme.io/reference/papersign-folders

Defines the structure for product information, including name, quantity, price, discountability, and images.

```APIDOC
## Product Schema

### Description
Represents a product with its attributes, suitable for e-commerce integrations.

### Object

#### Properties
- **name** (string) - Description: Product name. Example: Product 1. Nullable: true
- **quantity** (number) - Format: int32 - Description: Product quantity. Example: 5. Nullable: true
- **price** (number) - Format: double - Description: Product price. Example: 10. Nullable: true
- **minimum** (number) - Format: int32 - Description: Minimum number of products to be selected. Example: 1. Nullable: true
- **maximum** (number) - Format: int32 - Description: Maximum number of products to be selected. Example: 10. Nullable: true
- **discountable** (boolean) - Description: Whether the product can be discounted. Example: false. Nullable: true
- **images** (array) - Description: List of product images.
  - **items** (object)
    - **url** (string) - Description: Image URL. Example: https://example.com/image.jpg
    - **width** (number) - Format: int32 - Description: Image width. Example: 100
    - **height** (number) - Format: int32 - Description: Image height. Example: 100
    - **required**: ["url", "width"]

```

--------------------------------

### GET /forms/{slug_or_id}/products/{product_sku}

Source: https://paperform.readme.io/reference/papersign-folders

Retrieves details for a specific product associated with a form. Use this endpoint to get information about a particular product using its SKU.

```APIDOC
## GET /forms/{slug_or_id}/products/{product_sku}

### Description
Retrieves details for a specific product associated with a form. Use this endpoint to get information about a particular product using its SKU.

### Method
GET

### Endpoint
/forms/{slug_or_id}/products/{product_sku}

### Parameters
#### Path Parameters
- **slug_or_id** (string) - Required - The unique slug or ID of the form.
- **product_sku** (string) - Required - The SKU of the product to retrieve.

### Response
#### Success Response (200 OK)
- **id** (string) - The unique identifier of the product.
- **sku** (string) - The stock keeping unit of the product.
- **name** (string) - The name of the product.
- **price** (number) - The price of the product.
- **description** (string) - The description of the product.

#### Response Example
```json
{
  "id": "prod_abc123",
  "sku": "PRODUCT123",
  "name": "Premium Widget",
  "price": 29.99,
  "description": "A high-quality widget for all your needs."
}
```
```

--------------------------------

### Get Product by SKU

Source: https://paperform.readme.io/reference/webhooks

Retrieves a specific product using its SKU.

```APIDOC
## GET /products/{product_sku}

### Description
Retrieves a specific product using its SKU.

### Method
GET

### Endpoint
/products/{product_sku}

### Parameters
#### Path Parameters
- **product_sku** (string) - Required - The SKU of the product.

### Response
#### Success Response (200)
- **product** (object) - The product object.

#### Response Example
```json
{
  "sku": "SKU-123",
  "name": "Sample Product",
  "price": 19.99
}
```
```

--------------------------------

### Get Form Partial Submission - JS

Source: https://paperform.readme.io/reference/spaces

Fetches a specific partial submission associated with a form using its ID. This operation requires authentication and is performed via a GET request.

```javascript
fetch("/forms/{slug_or_id}/partial-submissions/{id}", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
})
.then(response => response.json())
.then(data => console.log(data))
```

--------------------------------

### List Form Submissions (API Request Example)

Source: https://paperform.readme.io/reference/papersign-folders

This example outlines how to request a list of submissions for a specific form using the Paperform API. It includes parameters for pagination and filtering.

```http
GET /forms/{slug_or_id}/submissions?limit=20&skip=0&afterId=123&beforeId=456&beforeDate=2023-01-01T00:00:00Z&afterDate=2022-01-01T00:00:00Z&sort=asc
```

--------------------------------

### Get Product by SKU

Source: https://paperform.readme.io/reference/translations

Retrieves a specific product by its SKU.

```APIDOC
## GET /products/{product_sku}

### Description
Retrieves details of a specific product using its SKU.

### Method
GET

### Endpoint
/products/{product_sku}

### Parameters
#### Path Parameters
- **product_sku** (string) - Required - The SKU of the product.

### Response
#### Success Response (200)
- **product** (object) - The product object.
  - **sku** (string) - The SKU of the product.
  - **name** (string) - The name of the product.
  - **price** (number) - The price of the product.

#### Response Example
```json
{
  "product": {
    "sku": "SKU-123",
    "name": "T-Shirt",
    "price": 25.00
  }
}
```
```

--------------------------------

### Webhooks - GET

Source: https://paperform.readme.io/reference/translations

This section pertains to webhook functionality within Paperform. The specific endpoint and method for managing webhooks are not fully detailed in the provided snippet, but it indicates a GET request is associated with this category and requires authentication.

```json
{
  "url": "",
  "method": "get",
  "auth": "required"
}
```

--------------------------------

### README Explorer and Proxy Configuration (JSON)

Source: https://paperform.readme.io/reference/papersigncanceldocument

Configuration settings for the 'x-readme' extension, enabling or disabling explorer and proxy features. These settings are part of the overall API documentation metadata.

```json
{
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```

--------------------------------

### Create Product on Form (POST /forms/{slug_or_id}/products)

Source: https://paperform.readme.io/reference/postformproduct

This endpoint creates a product on a specified form. It requires the form's slug or ID and product details such as SKU, price, and name. This functionality is part of the Business API plan. The request body must include `product_field_key`, `SKU`, `price`, and `name`.

```json
{
  "product_field_key": "a1b2c3d4e5",
  "SKU": "PRODUCT-SKU-123",
  "price": 19.99,
  "name": "Example Product"
}
```

--------------------------------

### API Endpoint GET /spaces

Source: https://paperform.readme.io/reference/listspaces

This defines the GET request for the /spaces endpoint. It specifies that bearer authentication is required and lists the available query parameters for filtering and searching spaces, such as date ranges and name searches.

```JSON
{
  "/spaces": {
    "get": {
      "parameters": [
        {
          "example": "ASC"
        },
        {
          "in": "query",
          "name": "before_date",
          "schema": {
            "type": "string",
            "format": "date-time"
          },
          "description": "Return results created on or after this date-time (UTC). Overwritten by `before_id`.",
          "example": "2019-06-11T20:36:29.000Z"
        },
        {
          "in": "query",
          "name": "after_date",
          "schema": {
            "type": "string",
            "format": "date-time"
          },
          "description": "Return results created before this date (UTC). Overwritten by `after_id`.",
          "example": "2019-06-11T20:36:29.000Z"
        },
        {
          "in": "query",
          "name": "search",
          "schema": {
            "type": "string"
          },
          "description": "Search spaces by name.",
          "example": "John Doe"
        }
      ]
    }
  },
  "security": [
    {
      "bearerAuth": []
    }
  ]
}
```

--------------------------------

### List Products

Source: https://paperform.readme.io/reference/papersign-documents

Retrieves a list of products, with support for searching and pagination.

```APIDOC
## GET /products

### Description
Retrieves a list of available products. Supports searching by name and pagination.

### Method
GET

### Endpoint
/products

### Parameters
#### Query Parameters
- **search** (string) - Optional - Search products by name.
- **after_id** (string) - Optional - Return results after the provided ID.
- **before_id** (string) - Optional - Return results before the provided ID.
- **skip** (integer) - Optional - Number of results to skip in the result set. Defaults to 0.
- **limit** (integer) - Optional - The number of results to return. Defaults to 20, maximum 100.
- **sort** (string) - Optional - The direction to sort in. Results are sorted by `created_at`, and defaults to `"DESC"`. Enum: ["ASC", "DESC"]
- **before_date** (date-time) - Optional - Return results created on or after this date-time (UTC). Overwritten by `after_id`.
- **after_date** (date-time) - Optional - Return results created before this date (UTC). Overwritten by `before_id`.

### Response
#### Success Response (200)
- **products** (array) - An array of product objects.
  - **sku** (string) - The product's SKU.
  - **name** (string) - The name of the product.
  - **price** (number) - The price of the product.
  - ... (other product properties)

#### Response Example
```json
{
  "products": [
    {
      "sku": "SKU-123",
      "name": "Example Widget",
      "price": 19.99
    },
    {
      "sku": "SKU-456",
      "name": "Another Gadget",
      "price": 29.99
    }
  ]
}
```
```

--------------------------------

### Create Form Product

Source: https://paperform.readme.io/reference/spaces

Adds a new product to a specific form.

```APIDOC
## POST /forms/{slug_or_id}/products

### Description
Adds a new product to a specific form.

### Method
POST

### Endpoint
/forms/{slug_or_id}/products

### Parameters
#### Path Parameters
- **slug_or_id** (string) - Required - The unique slug or ID of the form.

#### Request Body
- **sku** (string) - Required - The stock keeping unit for the new product.
- **name** (string) - Required - The name of the new product.
- **price** (number) - Required - The price of the new product.
- **currency** (string) - Required - The currency for the product's price (e.g., USD, EUR).

### Request Example
```json
{
  "sku": "PROD002",
  "name": "New Gadget",
  "price": 49.50,
  "currency": "CAD"
}
```

### Response
#### Success Response (201)
- **message** (string) - Confirmation message indicating the product was created.
- **product** (object) - The newly created product object.
  - **sku** (string) - The stock keeping unit of the product.
  - **name** (string) - The name of the product.
  - **price** (number) - The price of the product.
  - **currency** (string) - The currency of the product's price.

#### Response Example
```json
{
  "message": "Product created successfully.",
  "product": {
    "sku": "PROD002",
    "name": "New Gadget",
    "price": 49.50,
    "currency": "CAD"
  }
}
```
```
Tokens:
Raw