### Install Paconn CLI

Source: https://github.com/getaccept/openapi/blob/master/README.md

Installs the Microsoft Power Platform Connectors CLI (paconn) required for custom connector installation. Run this command in the connector folder.

```bash
$ npm run ms-install
```

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

### Install npm Packages

Source: https://github.com/getaccept/openapi/blob/master/README.md

Installs required Node.js packages for creating a custom connector. Run this command in the connector folder.

```bash
$ npm install
```

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

### Signature Verification Example

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/TABLE_OF_CONTENTS.md

This code example demonstrates how to verify webhook signatures. Ensure you have the correct signing secret and follow the verification process to ensure the integrity of incoming webhook requests.

```python
import hmac
import hashlib

def verify_signature(payload, signature, secret):
    """Verify the signature of a webhook payload.

    Args:
        payload: The raw request body.
        signature: The signature from the request header.
        secret: Your webhook signing secret.

    Returns:
        True if the signature is valid, False otherwise.
    """
    expected_signature = hmac.new(secret.encode('utf-8'), payload, hashlib.sha256).hexdigest()
    return hmac.compare_digest(expected_signature, signature)
```

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

### API Reference Overview

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/README.md

This section provides a high-level overview of the API documentation structure, including core reference documents, integration guides, resource-specific guides, and API reference subdirectories.

```APIDOC
## API Reference Overview

This API documentation is organized into several sections to facilitate understanding and integration:

### Core Reference Documents
- **INDEX.md**: General overview and navigation.
- **quick-reference.md**: Quick lookup tables for common operations.
- **endpoints.md**: Complete reference for all API endpoints.
- **types.md**: Definitions for all data types and schemas.
- **configuration.md**: Details on authentication, headers, and error handling.

### Integration Guides
- **authentication.md**: Guides on OAuth2 and token-based authentication.
- **document-workflow.md**: Comprehensive guide to the document lifecycle.
- **webhooks.md**: Information on real-time event subscriptions.
- **advanced-features.md**: Documentation for specialized features.

### Resource-Specific Guides
- **templates.md**: Management of document and communication templates.
- **file-operations.md**: Handling of file uploads and attachments.
- **contacts-teams.md**: Management of contacts and teams.
- **errors.md**: Detailed information on error codes and troubleshooting.

### API Reference Subdirectory (`api-reference/`)
- **schemas.md**: Detailed data type documentation.
- **documents.md**: Endpoints for document operations.
- **contacts.md**: Endpoints for contact management.
- **templates.md**: Endpoints for template management.
- **users.md**: Endpoints for user management.
- **folders.md**: Endpoints for folder organization.
- **teams.md**: Endpoints for team management.

**Base URL**: `https://api.getaccept.com/v1`
```

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

### List Attachments Library Response

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/file-operations.md

Example response for listing all attachment files available in the GetAccept account.

```json
{
  "attachments": [
    {
      "id": "att_123",
      "name": "Company Brochure",
      "filename": "brochure.pdf",
      "size": 2048000,
      "created_at": "2024-01-01T12:00:00Z"
    }
  ]
}
```

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

### Upload Video Response

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/file-operations.md

Example response structure after successfully uploading a video file.

```json
{
  "video_id": "vid_123",
  "filename": "intro.mp4",
  "status": "processing"
}
```

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

### Pagination Example

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/quick-reference.md

Use offset and limit parameters to paginate list endpoints. The response includes items, total count, offset, and limit.

```http
GET /documents?offset=0&limit=50
```

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

### Get Video Details

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/file-operations.md

Returns video metadata and processing status.

```APIDOC
## GET /videos/{videoId}

### Description
Returns video metadata and processing status.

### Method
GET

### Endpoint
/videos/{videoId}

### Parameters
#### Path Parameters
- **videoId** (string) - Required - The ID of the video to retrieve details for.
```

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

### GET /notifications

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Lists all notifications for the currently authenticated user.

```APIDOC
## GET /notifications

### Description
List notifications. List notification for current user

### Method
GET

### Endpoint
/notifications

### Response
#### Success Response (200)
- **array** (array) - OK
```

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

### GET /test

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Test authentication to verify credentials and retrieve the current entity and user ID.

```APIDOC
## GET /test

### Description
Test authentication and get current entity and user ID.

### Method
GET

### Endpoint
/test

### Responses
#### Success Response (200)
- **TestResponse** (object) - OK
#### Error Response (401)
- **Error** (object) - Unauthorized
```

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

### Upload Attachment Response

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/file-operations.md

Example response structure after successfully uploading an attachment.

```json
{
  "attachment_id": "att_123",
  "filename": "appendix.pdf",
  "size": 51200
}
```

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

### Get Document Preview

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Generates and returns preview images for each page of the document.

```APIDOC
## GET /documents/{documentId}/preview

### Description
Returns preview images of each document page.

### Method
GET

### Endpoint
/documents/{documentId}/preview
```

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

### Upload Document File Response

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/file-operations.md

Example response structure after successfully uploading a document file.

```json
{
  "file_id": "file_123",
  "filename": "document.pdf",
  "size": 102400,
  "content_type": "application/pdf"
}
```

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

### GET /documents/{documentId}/pricing-tables

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/documents.md

Retrieves all pricing tables for a document.

```APIDOC
## GET /documents/{documentId}/pricing-tables

### Description
Get all pricing tables for a document.

### Method
GET

### Endpoint
`GET https://api.getaccept.com/v1/documents/{documentId}/pricing-tables`

### Parameters
#### Path Parameters
- **documentId** (string) - Required - Document ID

### Responses
#### Success Response (200)
- `PricingTables`

#### Error Responses
- 401
- 404
```

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

### Get Attachments Library

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/file-operations.md

Returns a list of all attachment files available in your GetAccept account.

```APIDOC
## GET /attachments

### Description
Returns list of all attachment files available in your GetAccept account. These are files previously uploaded or created.

### Method
GET

### Endpoint
/attachments

### Response
#### Success Response (200)
- **attachments** (array) - A list of attachment objects.
  - **id** (string) - The unique identifier for the attachment.
  - **name** (string) - The name of the attachment.
  - **filename** (string) - The original filename of the attachment.
  - **size** (integer) - The size of the attachment in bytes.
  - **created_at** (string) - The timestamp when the attachment was created (ISO 8601 format).

### Response Example
```json
{
  "attachments": [
    {
      "id": "att_123",
      "name": "Company Brochure",
      "filename": "brochure.pdf",
      "size": 2048000,
      "created_at": "2024-01-01T12:00:00Z"
    }
  ]
}
```
```

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

### GET /templates

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/templates.md

Retrieves a list of available document templates. Supports filtering by folder and showing all templates.

```APIDOC
## GET /templates

### Description
Receive a list of available document templates. You can add new templates under the Templates-section in GetAccept.

### Method
GET

### Endpoint
https://api.getaccept.com/v1/templates

### Parameters
#### Query Parameters
- **showall** (string) - Optional - Show all templates for entity
- **folder_id** (string) - Optional - Show templates in a specific folder

### Responses
#### Success Response (200)
OK
```

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

### Check Video Job Status Response

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/file-operations.md

Example response for checking the processing status of a video conversion job.

```json
{
  "status": "completed",
  "progress": 100,
  "output_format": "mp4"
}
```

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

### GET /videos

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Retrieves a list of available videos on the entity. Videos can be added in the mobile app or within GetAccept.

```APIDOC
## GET /videos

### Description
Retrieves a list of available videos on the entity. Videos can be added in the mobile app or within GetAccept.

### Method
GET

### Endpoint
/videos

### Parameters
#### Query Parameters
- **offset** (integer) - No - Start list from record x
- **limit** (integer) - No - Number of records to list
- **include_video_url** (boolean) - No - Include presigned url for video
- **include_thumb_url** (boolean) - No - Include url for thumbnail

### Responses
#### Success Response (200)
OK
Content-Type: `application/json`
Schema: object
```

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

### Rate Limiting Headers Example

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/INDEX.md

These headers indicate the current rate limit status for API requests. 'X-RateLimit-Limit' shows the total requests allowed, 'X-RateLimit-Remaining' shows the requests left, and 'X-RateLimit-Reset' indicates the time (Unix timestamp) when the limit resets.

```http
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1704067200
```

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

### Get Template Details

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/templates.md

Retrieves the complete configuration of a specific document template, including its fields and roles.

```APIDOC
## GET /templates/{templateId}

### Description
Retrieves the complete configuration of a specific document template, including its fields and roles.

### Method
GET

### Endpoint
/templates/{templateId}
```

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

### GET /video/job/{videoId}

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Retrieves the current processing status of an uploaded video.

```APIDOC
## GET /video/job/{videoId}

### Description
Retrieves the current processing status of an uploaded video.

### Method
GET

### Endpoint
/video/job/{videoId}

### Parameters
#### Path Parameters
- **videoId** (string) - Yes - Video ID

### Responses
#### Success Response (200)
OK
Content-Type: `application/json`
Schema: `VideoJobStatus`
```

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

### GET /templates/{templateId}/pricing-tables

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Retrieves a list of pricing table items for a specific template.

```APIDOC
## GET /templates/{templateId}/pricing-tables

### Description
Receive a list of pricing-table items for a specific template.

### Method
GET

### Endpoint
/templates/{templateId}/pricing-tables

### Parameters
#### Path Parameters
- **templateId** (string) - Yes - Template ID

### Responses
#### Success Response (200)
- **PricingTables** (object) - A list of pricing table items.

#### Error Responses
- **401**
- **404**
```

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

### GET /users

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Fetches a list of active users for the current authenticated entity.

```APIDOC
## GET /users

### Description
Fetch a list of active users for the current authenticated entity

### Method
GET

### Endpoint
/users

### Responses
#### Success Response (200)
- **Users** (object) - A list of active users.

#### Error Responses
- **401**
```

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

### GET /templates/{templateId}/fields

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Retrieves a list of fields for a specified template.

```APIDOC
## GET /templates/{templateId}/fields

### Description
Receive a list of fields for a specific template.

### Method
GET

### Endpoint
/templates/{templateId}/fields

### Parameters
#### Path Parameters
- **templateId** (string) - Yes - Template ID

### Responses
#### Success Response (200)
- **Fields** (object) - A list of fields for the template.

#### Error Responses
- **401**
- **404**
```

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

### GET /subscriptions/events

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

This call will return a list of available subscription events. Use this to see all possible events you can subscribe to.

```APIDOC
## GET /subscriptions/events

### Description
This call will return a list of available subscription events.

### Method
GET

### Endpoint
/subscriptions/events

### Responses
#### Success Response (200)
- **array** (`application/json`)
#### Error Response (401)
#### Error Response (404)
```

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

### Get Document Fields

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/documents.md

Retrieves a list of fields for a document or template, which can be used before or after signing.

```APIDOC
## GET /documents/{documentId}/fields

### Description
Get a list of fields for a document or template. Can be used both before and after a document has been signed.

### Method
GET

### Endpoint
`https://api.getaccept.com/v1/documents/{documentId}/fields`

### Parameters
#### Path Parameters
- **documentId** (string) - Yes - Document ID

#### Query Parameters
- **resolveEditorFields** (boolean) - No - Resolve editor fields to their values

### Responses
#### Success Response (200)
OK - `Fields`

#### Error Responses
- **401**
- **404**
```

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

### GET /attachments

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Receive a list of available attachments. You can add new attachments in GetAccept using a new document.

```APIDOC
## GET /attachments

### Description
Receive a list of available attachments. You can add new attachments in GetAccept using a new document.

### Method
GET

### Endpoint
/attachments

### Responses
#### Success Response (200)
- **Attachments** (object) - OK
#### Error Response (401)
- **Error** (object) - Unauthorized
```

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

### GET /communication-templates

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/templates.md

Retrieves a list of available communication templates. Supports filtering by status and pagination.

```APIDOC
## GET /communication-templates

### Description
Receive a list of available communication templates.

### Method
GET

### Endpoint
https://api.getaccept.com/v1/communication-templates

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - Start list from record x
- **limit** (integer) - Optional - Number of records to list
- **statuses** (string) - Optional - Filter list on status

### Responses
#### Success Response (200)
OK
```

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

### GET /subscriptions

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Receive a list of available subscriptions for the current entity. This endpoint retrieves all active subscriptions.

```APIDOC
## GET /subscriptions

### Description
Receive a list of available subscriptions for the current entity.

### Method
GET

### Endpoint
/subscriptions

### Responses
#### Success Response (200)
- **Subscriptions** (`application/json`)
#### Error Response (401)
```

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

### Get Custom Data for Document

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Retrieve all custom metadata associated with a specific document.

```http
GET /documents/{documentId}/custom-data
```

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

### GET /documents/{documentId}/custom-data

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/documents.md

Get all custom data properties for a document.

```APIDOC
## GET /documents/{documentId}/custom-data

### Description
Get all custom data properties for a document.

### Method
GET

### Endpoint
`https://api.getaccept.com/v1/documents/{documentId}/custom-data`

### Parameters
#### Path Parameters
- **documentId** (string) - Yes - Document ID
#### Query Parameters
- **limit** (integer) - No - Number of records to list
- **offset** (integer) - No - Start list from record x

### Responses
#### Success Response (200)
OK
```

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

### GET /documents/{documentId}/comments

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/documents.md

Get a list of chat comments for a document.

```APIDOC
## GET /documents/{documentId}/comments

### Description
Get a list of chat comments for a document.

### Method
GET

### Endpoint
`https://api.getaccept.com/v1/documents/{documentId}/comments`

### Parameters
#### Path Parameters
- **documentId** (string) - Yes - Document ID

### Responses
#### Success Response (200)
OK - Schema: array of `Comment`
```

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

### GET /documents/{documentId}/custom-data/{customDataId}

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/documents.md

Get a specific custom data property for a document.

```APIDOC
## GET /documents/{documentId}/custom-data/{customDataId}

### Description
Get a specific custom data property for a document.

### Method
GET

### Endpoint
`https://api.getaccept.com/v1/documents/{documentId}/custom-data/{customDataId}`

### Parameters
#### Path Parameters
- **documentId** (string) - Yes - Document ID
- **customDataId** (string) - Yes - Custom Data ID

### Responses
#### Success Response (200)
OK - Schema: `CustomDataProperty`
```

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

### GET /subscriptions/errors

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Get the last errors for active subscriptions. This endpoint retrieves error details associated with subscriptions.

```APIDOC
## GET /subscriptions/errors

### Description
Get the last errors for active subscriptions.

### Method
GET

### Endpoint
/subscriptions/errors

### Responses
#### Success Response (200)
- **array** (`application/json`)
#### Error Response (401)
```

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

### Get Document Preview Images

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Retrieve preview images for each page of a document. Useful for displaying document content without downloading the full file.

```http
GET /documents/{documentId}/preview
```

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

### Login to Power Platform

Source: https://github.com/getaccept/openapi/blob/master/README.md

Logs you into the Power Platform using a device code flow. Follow the on-screen prompts to complete the login.

```bash
$ npm run ms-login
```

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

### Get All Fields in a Document

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Retrieve a list of all fields present within a document. This includes signature fields, text fields, etc.

```http
GET /documents/{documentId}/fields
```

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

### Run OpenAPI Converter

Source: https://github.com/getaccept/openapi/blob/master/README.md

Executes a script to generate custom connector definition files and OpenAPI to Swagger 2.0 conversions. Run this command in the project root.

```bash
$ npm run convert
```

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

### Get Template Fields

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/templates.md

Retrieves all fields defined within a specific document template, including their properties.

```APIDOC
## GET /templates/{templateId}/fields

### Description
Retrieves all fields defined within a specific document template, including their properties.

### Method
GET

### Endpoint
/templates/{templateId}/fields

### Response
#### Success Response (200)
- **field_id** (string) - Unique field identifier
- **name** (string) - Field name
- **type** (string) - Field type (text, signature, initials, checkbox, etc.)
- **required** (boolean) - Whether field is required
- **role** (string) - Which role/signer must complete this field
```

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

### Get Template Pricing Tables

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/templates.md

Retrieves the pricing tables configured within a specific document template.

```APIDOC
## GET /templates/{templateId}/pricing-tables

### Description
Retrieves the pricing tables configured within a specific document template.

### Method
GET

### Endpoint
/templates/{templateId}/pricing-tables
```

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

### Create Custom Connector

Source: https://github.com/getaccept/openapi/blob/master/README.md

Creates a new custom connector using the files in the connector folder. The command will prompt for the environment if not specified.

```bash
$ npm run ms-create
```

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

### GetAccept API Documentation Overview

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/GENERATION_SUMMARY.txt

This snippet outlines the structure and content of the GetAccept API documentation, including the number of files, API coverage, and key features.

```APIDOC
## GetAccept API Documentation Summary

### Description
This document provides a summary of the GetAccept API documentation, detailing the scope, structure, and key features of the generated reference materials based on the OpenAPI v1.6 Specification.

### Project Details
- **Project**: Technical Reference Documentation Generation
- **Source**: GetAccept OpenAPI v1.6 Specification
- **Output Directory**: /workspace/home/output/
- **Status**: COMPLETE

### Deliverables
- **Total Documentation Files**: 22 markdown files
- **Core Reference Files**: endpoints.md, types.md, quick-reference.md
- **Configuration & Auth Files**: authentication.md, configuration.md
- **Integration Guides**: document-workflow.md, webhooks.md, templates.md, file-operations.md
- **Specialized Topics**: contacts-teams.md, advanced-features.md, errors.md
- **API Reference Subdirectory**: schemas.md, documents.md, templates.md, contacts.md, users.md, folders.md, teams.md

### Content Statistics
- **Total Lines**: 6,500+
- **Total Words**: 16,000+
- **Total Size**: 232 KB
- **Endpoints Documented**: 86 (100% coverage)
- **Data Types Documented**: 39 (100% coverage)

### Documentation Structure Paths
- **Quick Reference Path**: README.md → quick-reference.md → authentication.md
- **Integration Learning Path**: INDEX.md → authentication.md → document-workflow.md → webhooks.md
- **Deep Reference Path**: All integration guides → endpoints.md → types.md → api-reference/*
- **Implementation Path**: quick-reference.md → endpoints.md → types.md → errors.md → specific-guide.md

### Key Features
- **Comprehensive Endpoint Documentation**: All 86 endpoints with full specifications, parameters, request bodies, response schemas, HTTP status codes, authentication requirements, grouped by 14 logical categories.
- **Complete Type Definitions**: All 39 data types documented with property tables, types, requirements, default values, and enum values.
- **Integration Guides**: Covers OAuth2/token auth, document workflow, webhooks, file uploads, templates, and contact/team management.
- **Quick Reference Materials**: 100+ reference tables for endpoint lookup, common parameters, status codes, and field types.
- **Error & Troubleshooting**: HTTP status codes, common error scenarios, response structure, rate limiting, and debugging strategies.
```

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

### Create Document via File Upload

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Use this endpoint to initiate document creation by uploading a file. You will need to upload the actual file content in a subsequent step.

```json
{
  "name": "My Document",
  "external_id": "external_123",
  "folder_id": "folder_123"
}
```

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

### Get Comments for Document

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Retrieves all comments associated with a document.

```APIDOC
## GET /documents/{documentId}/comments

### Description
Retrieves all comments for a document.

### Method
GET

### Endpoint
/documents/{documentId}/comments
```

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

### Create Document from Template

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Initiate document creation using a pre-defined template. Specify the template ID and recipient details.

```json
{
  "name": "From Template",
  "template_id": "template_123",
  "recipients": [
    {
      "email": "recipient@example.com",
      "name": "John Doe",
      "role": "signer"
    }
  ]
}
```

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

### Get Teams

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/contacts-teams.md

Retrieves a list of all teams within your organization.

```APIDOC
## Get Teams

### Description
Retrieves a list of all teams within your organization.

### Method
GET

### Endpoint
/teams
```

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

### List Videos

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/file-operations.md

Returns a list of uploaded videos.

```APIDOC
## GET /videos

### Description
Returns list of uploaded videos.

### Method
GET

### Endpoint
/videos
```

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

### Get User Statistics

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/users.md

Retrieves statistics for a single user.

```APIDOC
## GET /users/{userId}/statistics

### Description
Get statistics for a single user.

### Method
GET

### Endpoint
https://api.getaccept.com/v1/users/{userId}/statistics

### Parameters
#### Path Parameters
- **userId** (string) - Yes - User ID

### Responses
#### Success Response (200)
- **Description**: OK
```

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

### GET /users/{userId}/statistics

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Retrieves statistics for a single user.

```APIDOC
## GET /users/{userId}/statistics

### Description
Retrieves statistics for a single user.

### Method
GET

### Endpoint
/users/{userId}/statistics

### Parameters
#### Path Parameters
- **userId** (string) - Yes - User ID

### Responses
#### Success Response (200)
OK
Content-Type: `application/json`
Schema: object
```

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

### List Folders

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/folders.md

Lists and retrieves details of existing folders in GetAccept. Supports filtering by folder type.

```APIDOC
## GET /folders

### Description
List and get details of existing folders in GetAccept.

### Method
GET

### Endpoint
`https://api.getaccept.com/v1/folders`

### Parameters
#### Query Parameters
- **type** (string) - Optional - Show folders of a specific type: archive or template

### Responses
#### Success Response (200)
OK
```

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

### GET /refresh

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Refresh an access token before the original token has expired.

```APIDOC
## GET /refresh

### Description
You can request a refreshed access token before the original token has expired.

### Method
GET

### Endpoint
/refresh

### Responses
#### Success Response (200)
- **Refreshed Token** (object) - OK
```

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

### GET /documents/{documentId}/pages

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/documents.md

Retrieves a list of pages for a document.

```APIDOC
## GET /documents/{documentId}/pages

### Description
Get a list of pages for a document.

### Method
GET

### Endpoint
`GET https://api.getaccept.com/v1/documents/{documentId}/pages`

### Parameters
#### Path Parameters
- **documentId** (string) - Required - Document ID

### Responses
#### Success Response (200)
- OK

#### Error Responses
- 401
- 404
```

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

### Get Events

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/documents.md

Retrieves a list of events associated with a specific document.

```APIDOC
## GET /documents/{documentId}/events

### Description
Get a list of document events for a document.

### Method
GET

### Endpoint
`https://api.getaccept.com/v1/documents/{documentId}/events`

### Parameters
#### Path Parameters
- **documentId** (string) - Yes - Document ID

### Responses
#### Success Response (200)
OK - array of `Event`

#### Error Responses
- **401**
- **404**
```

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

### Create Document from Template

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/templates.md

Use this endpoint to create a new document using a specified template. Provide the document name, template ID, recipient details, and field values.

```json
{
  "name": "New Document",
  "template_id": "template_123",
  "recipients": [
    {
      "email": "signer@example.com",
      "name": "John Signer",
      "role": "signer"
    }
  ],
  "fields": {
    "field_123": "Value"
  }
}
```

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

### Get Document Fields

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Retrieves all fields present within a document.

```APIDOC
## GET /documents/{documentId}/fields

### Description
Returns all fields in the document.

### Method
GET

### Endpoint
/documents/{documentId}/fields
```

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

### Get Email Template

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/templates.md

Retrieves the details of a specific email template.

```APIDOC
## GET /email/templates/{emailTemplateId}

### Description
Retrieves the details of a specific email template.

### Method
GET

### Endpoint
/email/templates/{emailTemplateId}
```

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

### Pagination

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/quick-reference.md

Most list endpoints support pagination using offset and limit query parameters.

```APIDOC
## GET /documents?offset=0&limit=50

### Description
Supports pagination for list endpoints.

### Method
GET

### Endpoint
/documents

### Parameters
#### Query Parameters
- **offset** (integer) - Optional - The starting offset for the list.
- **limit** (integer) - Optional - The maximum number of records to return.

### Response
#### Success Response (200)
- **items** or **data** (array) - Array of records.
- **total** (integer) - Total number of records.
- **offset** (integer) - Current offset.
- **limit** (integer) - Requested limit.
```

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

### Create Contact

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/contacts-teams.md

Creates a new contact in your GetAccept account.

```APIDOC
## Create Contact

### Description
Creates a new contact in your GetAccept account.

### Method
POST

### Endpoint
/contacts

### Request Body
- **name** (string) - Required - The name of the contact.
- **email** (string) - Required - The email address of the contact.
- **phone** (string) - Optional - The phone number of the contact.
- **company** (string) - Optional - The company the contact belongs to.
- **country** (string) - Optional - The country of the contact.

### Request Example
```json
{
  "name": "John Doe",
  "email": "john@example.com",
  "phone": "+1234567890",
  "company": "Example Corp",
  "country": "US"
}
```
```

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

### GET /email/templates

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/templates.md

Retrieves a list of email templates associated with the entity.

```APIDOC
## GET /email/templates

### Description
Get a list of email templates on the entity.

### Method
GET

### Endpoint
https://api.getaccept.com/v1/email/templates

### Responses
#### Success Response (200)
OK
```

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

### POST /subscriptions/test

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Simulate or test a subscription / webhook event. This endpoint is useful for verifying your subscription configurations.

```APIDOC
## POST /subscriptions/test

### Description
Simulate or test a subscription / webhook event.

### Method
POST

### Endpoint
/subscriptions/test

### Request Body
Required: Yes
Content-Types: `application/json`

### Responses
#### Success Response (200)
#### Error Response (400)
#### Error Response (401)
```

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

### GET /communication-templates/{communicationTemplateId}

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/templates.md

Retrieves a specific communication template by its ID.

```APIDOC
## GET /communication-templates/{communicationTemplateId}

### Description
Receive a specific communication template.

### Method
GET

### Endpoint
https://api.getaccept.com/v1/communication-templates/{communicationTemplateId}

### Parameters
#### Path Parameters
- **communicationTemplateId** (string) - Required - Communication Template ID

### Responses
#### Success Response (200)
OK - Returns `CommunicationTemplate` schema.
```

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

### GET /videos/{videoId}

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Retrieves a specific video based on its video ID.

```APIDOC
## GET /videos/{videoId}

### Description
Retrieves a specific video based on its video ID.

### Method
GET

### Endpoint
/videos/{videoId}

### Parameters
#### Path Parameters
- **videoId** (string) - Yes - Video ID

### Responses
#### Success Response (200)
OK
Content-Type: `application/json`
Schema: `Video`
```

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

### POST /auth

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Authenticate using a token. This method is recommended for server-based access or clients where OAuth is not suitable. Access tokens must be requested using an administrator's login credentials.

```APIDOC
## POST /auth

### Description
Token based authentication is recommended for server-based access or access from clients where OAuth is not suitable. Access tokens has to be requested using an administrators login credentials.
Requests should include the header Content-Type with value application/json

### Method
POST

### Endpoint
/auth

### Request Body
Required: Yes
Content-Types: `application/json`

### Responses
#### Success Response (200)
- **Authentication Token** (object) - OK
#### Error Response (400)
- **Error** (object) - Bad Request
```

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

### POST /upload

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Uploads a document file, returning a file ID. This ID is used to associate the file with a GetAccept document. Only one file can be uploaded at a time, with a default size limit of 10 MB. Uploaded files must be imported into a document within 48 hours.

```APIDOC
## POST /upload

### Description
Upload a document file. You can upload one file at a time and get a file id. The file id is used to connect a file with a GetAccept document which is sent to recipients. If you want to upload mutliple files you run multiple POST. We only accept files up to 10 MB as default. Uploaded file need to be imported/added to a document within 48 hours after uploading. We recommended you to upload PDF files in order to guarantee the same look when sent. Other file types can be converted, such as: Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Other: html, tex, csv

### Method
POST

### Endpoint
/upload

#### Request Body
Required: Yes
Content-Types: `application/json`, `multipart/form-data`

### Response
#### Success Response (200)
- **object** (object) - OK
```

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

### Get Custom Data from Document

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Retrieves all custom metadata associated with a document.

```APIDOC
## GET /documents/{documentId}/custom-data

### Description
Retrieves custom metadata stored on documents.

### Method
GET

### Endpoint
/documents/{documentId}/custom-data
```

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

### Create Communication Template

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/templates.md

Use this endpoint to create a new communication template. Specify the name, subject, body, and whether to include the document.

```json
{
  "name": "Initial Outreach",
  "subject": "Please review and sign {{document_name}}",
  "body": "Hi {{recipient_name}}, please review the attached document.",
  "include_document": true
}
```

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

### Get Document Revisions

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Retrieves a history of all revisions and versions for a specific document.

```APIDOC
## GET /documents/{documentId}/revisions

### Description
Returns all document revisions and versions.

### Method
GET

### Endpoint
/documents/{documentId}/revisions
```

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

### Get Recipient Details

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Fetches detailed information about a specific recipient of a document.

```APIDOC
## GET /documents/{documentId}/recipients/{recipientId}

### Description
Retrieves details for a specific recipient of a document.

### Method
GET

### Endpoint
/documents/{documentId}/recipients/{recipientId}
```

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

### Create Folder Request

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/advanced-features.md

Use this JSON payload to create a new folder, specifying its name and parent folder ID.

```json
{
  "name": "2024 Contracts",
  "parent_id": "folder_parent_123"
}
```

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

### Get Document Recipients

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Retrieves a list of all recipients associated with a specific document.

```APIDOC
## GET /documents/{documentId}/recipients

### Description
Retrieves a list of all recipients for a document.

### Method
GET

### Endpoint
/documents/{documentId}/recipients
```

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

### POST /users

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Creates a new user in the database for the current entity.

```APIDOC
## POST /users

### Description
Creates a new user in the database for the current entity.

### Method
POST

### Endpoint
/users

### Request Body
Required: Yes
Content-Types: `application/json`

### Responses
#### Success Response (200)
OK
Content-Type: `application/json`
Schema: `User`
```

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

### Get All Recipients for a Document

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Retrieve a list of all recipients associated with a specific document.

```http
GET /documents/{documentId}/recipients
```

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

### Get Custom Data

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/contacts-teams.md

Retrieves custom data associated with a specific entity.

```APIDOC
## Get Custom Data

### Description
Retrieves custom data associated with a specific entity.

### Method
GET

### Endpoint
/custom-data/entity

### Query Parameters
- **entity_type** (string) - Required - Type of entity (contact, document, etc.).
- **entity_id** (string) - Required - ID of the entity.
```

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

### Include API Key Header

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/authentication.md

For specific operations, include your API key in the X-API-Key header. Contact the GetAccept API team for key allocation.

```http
X-API-Key: your-api-key
```

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

### Get Subscription Details

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/webhooks.md

Retrieves the details of a specific webhook subscription by its ID.

```APIDOC
## GET /subscriptions/{subscriptionId}

### Description
Retrieves the details of a specific webhook subscription.

### Method
GET

### Endpoint
/subscriptions/{subscriptionId}

### Parameters
#### Path Parameters
- **subscriptionId** (string) - Required - The ID of the subscription to retrieve.
```

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

### GET /templates/{templateId}/roles

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Fetches a list of roles associated with a specific template.

```APIDOC
## GET /templates/{templateId}/roles

### Description
Receive a list of roles for a specific template.

### Method
GET

### Endpoint
/templates/{templateId}/roles

### Parameters
#### Path Parameters
- **templateId** (string) - Yes - Template ID

### Responses
#### Success Response (200)
- **object** (object) - A list of roles for the template.

#### Error Responses
- **401**
- **404**
```

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

### Create Document from Template

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Creates a new document based on a pre-defined template, automatically populating recipient information.

```APIDOC
## POST /documents

### Description
Creates a new document from a template, pre-filling recipient details.

### Method
POST

### Endpoint
/documents

### Request Body
- **name** (string) - Required - The name of the document.
- **template_id** (string) - Required - The ID of the template to use.
- **recipients** (array) - Required - A list of recipients for the document.
  - **email** (string) - Required - The email address of the recipient.
  - **name** (string) - Required - The name of the recipient.
  - **role** (string) - Required - The role of the recipient (e.g., 'signer').

### Request Example
```json
{
  "name": "From Template",
  "template_id": "template_123",
  "recipients": [
    {
      "email": "recipient@example.com",
      "name": "John Doe",
      "role": "signer"
    }
  ]
}
```
```

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

### Create Communication Template

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/templates.md

Creates a new communication template with specified name, subject, body, and document inclusion settings.

```APIDOC
## POST /communication-templates

### Description
Creates a new communication template with specified name, subject, body, and document inclusion settings.

### Method
POST

### Endpoint
/communication-templates

### Request Body
- **name** (string) - Required - Name of the communication template
- **subject** (string) - Required - Subject line of the email
- **body** (string) - Required - Message body of the email
- **include_document** (boolean) - Optional - Whether to include the document in the email

### Request Example
{
  "name": "Initial Outreach",
  "subject": "Please review and sign {{document_name}}",
  "body": "Hi {{recipient_name}}, please review the attached document.",
  "include_document": true
}
```

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

### GET /documents/{documentId}/events

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/endpoints.md

Retrieves a list of events associated with a specific document.

```APIDOC
## GET /documents/{documentId}/events

### Description
Get events. Get a list of document events for a document.

### Method
GET

### Endpoint
/documents/{documentId}/events

### Parameters
#### Path Parameters
- **documentId** (string) - Yes - Document ID

### Responses
#### Success Response (200)
- **array of Event** (array) - OK

#### Response Example
(No example provided in source)
```

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

### Obtaining Access Token (Token-Based)

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/authentication.md

Use this endpoint to obtain an access token for server-to-server integrations by providing email, password, and client ID.

```APIDOC
## POST /auth

### Description
Obtains an access token for token-based authentication.

### Method
POST

### Endpoint
/auth

### Parameters
#### Request Body
- **email** (string) - Required - The administrator's email address.
- **password** (string) - Required - The administrator's password.
- **client_id** (string) - Required - The client ID of your registered application.

### Request Example
```json
{
  "email": "admin@example.com",
  "password": "password",
  "client_id": "your-client-id"
}
```

### Response
#### Success Response (200)
- **access_token** (string) - The obtained access token.
- **expires_in** (integer) - The token's expiration time in seconds.

#### Response Example
```json
{
  "access_token": "token_string_here",
  "expires_in": 3600
}
```
```

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

### GET /documents/{documentId}/status

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/documents.md

Retrieves the current status of a document using its ID.

```APIDOC
## GET /documents/{documentId}/status

### Description
Retrieves the current status of a document using its ID.

### Method
GET

### Endpoint
`GET https://api.getaccept.com/v1/documents/{documentId}/status`

### Parameters
#### Path Parameters
- **documentId** (string) - Yes - Document ID

### Responses
#### Success Response (200)
- **StatusResponse** (object) - OK
```

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

### Schemas

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/TABLE_OF_CONTENTS.md

Provides detailed type documentation for all 39 schema definitions, including properties, enum values, array item types, default values, and field requirements.

```APIDOC
## Schemas

### Description
Offers detailed type documentation for all 39 schema definitions, including properties, enum values, array item types, default values, and field requirements.

### Schema Definitions
All 39 schema definitions with full details.
```

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

### GET /documents/{documentId}/log

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/documents.md

Retrieves a detailed log of events for a specific document.

```APIDOC
## GET /documents/{documentId}/log

### Description
Get a detailed log of events for a specific document.

### Method
GET

### Endpoint
`GET https://api.getaccept.com/v1/documents/{documentId}/log`

### Parameters
#### Path Parameters
- **documentId** (string) - Required - Document ID

### Responses
#### Success Response (200)
- OK - array of `LogEntry`

#### Error Responses
- 401
- 404
```

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

### POST /documents/{documentId}/preview

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/documents.md

Generates a preview of an existing document or template.

```APIDOC
## POST /documents/{documentId}/preview

### Description
Generates a preview of an existing document or template.

### Method
POST

### Endpoint
`POST https://api.getaccept.com/v1/documents/{documentId}/preview`

### Parameters
#### Path Parameters
- **documentId** (string) - Required - Document ID

### Request Body
- Content-Type: `application/json`
- Required: No

### Responses
#### Success Response (200)
- `PreviewResponse`

#### Error Responses
- 400
- 401
- 404
```

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

### API Organization by Category

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/README.md

This section categorizes the available API endpoints into logical groups, providing a quick overview of the functionalities offered by the GetAccept API.

```APIDOC
## API Organization by Category

The GetAccept API is organized into the following categories:

### Authentication (5 endpoints)
- Obtain access tokens
- Refresh tokens
- Switch entities
- Revoke tokens
- Test authentication

### Documents (50+ endpoints)
- Create, list, get, update, delete documents
- Send documents
- Manage recipients
- Track activity and events
- Download and preview
- Manage fields, comments, custom data

### Templates (12 endpoints)
- List and manage document templates
- Configure template fields and roles
- Communication template management
- Email template management

### Contacts & Teams (8 endpoints)
- Contact CRUD operations
- Team management
- Contact organization

### File Operations (10 endpoints)
- Document uploads
- Attachment uploads
- Video uploads
- Archive uploads
- File retrieval

### Subscriptions & Webhooks (8 endpoints)
- Create and manage webhooks
- Event subscription management
- Webhook testing
- Event monitoring

### Folders & Organization (8 endpoints)
- Folder hierarchy management
- Document organization
- Custom data storage

### Users & Statistics (5 endpoints)
- User list and details
- User statistics and activity
```

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

### Get Specific Recipient Details

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Fetch detailed information for a particular recipient of a document.

```http
GET /documents/{documentId}/recipients/{recipientId}
```

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

### Get Contact Details

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/contacts-teams.md

Fetches complete information for a specific contact, including their history.

```APIDOC
## Get Contact Details

### Description
Fetches complete information for a specific contact, including their history.

### Method
GET

### Endpoint
/contacts/{contactId}

### Parameters
#### Path Parameters
- **contactId** (string) - Required - The ID of the contact to retrieve.
```

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

### GET /email/templates/{emailTemplateId}

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/api-reference/templates.md

Retrieves detailed information about a specific email template by its ID.

```APIDOC
## GET /email/templates/{emailTemplateId}

### Description
Get detailed information about an email template.

### Method
GET

### Endpoint
https://api.getaccept.com/v1/email/templates/{emailTemplateId}

### Parameters
#### Path Parameters
- **emailTemplateId** (string) - Required - Email Template ID

### Responses
#### Success Response (200)
OK - Returns `EmailTemplate` schema.
```

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

### Download Document

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/document-workflow.md

Retrieves the signed PDF version of a document.

```APIDOC
## GET /documents/{documentId}/download

### Description
Returns the signed PDF file of the document.

### Method
GET

### Endpoint
/documents/{documentId}/download
```

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

### Folder Management

Source: https://github.com/getaccept/openapi/blob/master/_autodocs/advanced-features.md

APIs for organizing documents within a hierarchical folder structure.

```APIDOC
## List Folders

### Description
Retrieves a list of all folders.

### Method
GET

### Endpoint
/folders
```

```APIDOC
## Get Folder Details

### Description
Retrieves details for a specific folder.

### Method
GET

### Endpoint
/folders/{folderId}
```

```APIDOC
## Create Folder

### Description
Creates a new folder.

### Method
POST

### Endpoint
/folders

### Request Body
- **name** (string) - Required - The name of the folder.
- **parent_id** (string) - Optional - The ID of the parent folder.
```

```APIDOC
## Update Folder

### Description
Updates an existing folder.

### Method
PUT

### Endpoint
/folders/{folderId}
```

```APIDOC
## Delete Folder

### Description
Deletes a folder.

### Method
DELETE

### Endpoint
/folders/{folderId}
```