### Get User Details by ID Example

Source: https://developers.pandadoc.com/reference/detailsuser

This example shows the expected JSON response when successfully retrieving user details. It includes user identification, contact information, license type, and workspace roles.

```json
{
  "user_id": "ajnN7eGutJZsRKjQrNuPkh",
  "email": "josh@example.com",
  "first_name": "Josh",
  "last_name": "Doe",
  "phone_number": "+14842634627",
  "license": "Full",
  "is_organization_owner": true,
  "workspaces": [
    {
      "role": "Admin",
      "workspace_id": "fERpqZdFaF9dHVAeVxPFaV",
      "membership_id": "nPh2PDhFdDqAES9k64h9qX"
    }
  ]
}

```

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

### Get Document Content Examples

Source: https://developers.pandadoc.com/reference/getdocumentcontent

Demonstrates how to retrieve document content in different formats. Use the `format` query parameter to specify plaintext or markdown.

```json
{
  "format": "plaintext",
  "content": "Agreement between Party A and Party B..."
}
```

```json
{
  "format": "markdown",
  "content": "# Agreement\n\nBetween **Party A** and **Party B**..."
}
```

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

### Get Document Summary (JSON Example)

Source: https://developers.pandadoc.com/reference/getdocumentsummary

This example shows the expected JSON response when a document summary is successfully retrieved with 'detailed' granularity. It includes the summary text and its type.

```json
{
  "type": "detailed",
  "summary": "This agreement establishes a partnership between Party A and Party B, covering terms of service, payment schedules, intellectual property rights, and termination clauses. The contract is effective from March 2026 and runs for 12 months with automatic renewal."
}
```

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

### Get Template Status Example

Source: https://developers.pandadoc.com/reference/template-status

This example demonstrates how to retrieve the status of a specific template using its ID. Ensure you have the correct template ID and necessary authentication.

```json
{
  "id": "vibuun3DXG8QDDLfXm27Ne",
  "name": "API Sample PandaDoc Template",
  "date_created": "2024-07-15T17:44:07.524617Z",
  "date_modified": "2024-07-15T17:44:07.613821Z",
  "version": "2",
  "status": "template.PROCESSED"
}
```

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

### OpenAPI POST Example

Source: https://developers.pandadoc.com/reference/statusdocumentautoreminder

Illustrates the 'example' property for a POST request within an OpenAPI definition.

```json
{
                        "example": "POST"
                      }
```

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

### API Key Authentication Example

Source: https://developers.pandadoc.com/reference/getdocumentaimetadata

This example demonstrates how to format the `Authorization` header for API key authentication. The key should be prefixed with `API-Key`.

```text
API-Key 3039ba033eb1410caa0a2227158d63c9d6502cd8
```

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

### Example HTTP Authorization Header

Source: https://developers.pandadoc.com/reference/authentication-process

An example of the HTTP Authorization header with a sample access token.

```yaml
Authorization: Bearer 3039ba033eb1410caa0a2227158d63c9d6502cd8
```

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

### Create Document Attachment Response Example

Source: https://developers.pandadoc.com/reference/create-document-attachment

Example of a successful response when creating a document attachment.

```json
{
  "uuid": "1111bc85-b0f0-42a8-97e7-9265cd9a12a4",
  "date_created": "2025-01-31T14:02:59.667160Z",
  "created_by": {
    "id": "bSfiuAJNokERwsBxynKjwA",
    "email": "sergio@pandadoc.com",
    "first_name": "Sergio",
    "last_name": "",
    "avatar": null
  },
  "name": "Wikipedia logo",
  "type": "general"
}
```

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

### Create Document Example

Source: https://developers.pandadoc.com/reference/create-document

This example demonstrates how to create a document using the PandaDoc API, including specifying template, recipients, and fields.

```APIDOC
## POST /documents

### Description
Creates a new document from a template with specified recipients and fields.

### Method
POST

### Endpoint
/documents

### Request Body
- **name** (string) - Required - The name of the document.
- **template_uuid** (string) - Required - The UUID of the template to use.
- **folder_uuid** (string) - Optional - The UUID of the folder to place the document in.
- **owner** (object) - Optional - Information about the document owner.
  - **membership_id** (string) - Required - The membership ID of the owner.
- **recipients** (array) - Required - A list of recipients for the document.
  - **email** (string) - Required - The email address of the recipient.
  - **first_name** (string) - Optional - The first name of the recipient.
  - **last_name** (string) - Optional - The last name of the recipient.
  - **role** (string) - Optional - The role of the recipient (e.g., 'user').
- **tokens** (array) - Optional - A list of tokens to be used in the document.
  - **name** (string) - Required - The name of the token.
  - **value** (string) - Required - The value of the token.
- **fields** (object) - Optional - Key-value pairs for document fields.
  - **field_name** (string) - The name of the field.
    - **value** (any) - The value of the field.
- **pricing_tables** (array) - Optional - Pricing table configurations.
  - **name** (string) - Required - The name of the pricing table.
  - **data_merge** (boolean) - Optional - Whether to data merge.
  - **options** (object) - Optional - Pricing table options.
    - **Tax** (object) - Tax configuration.
      - **type** (string) - Required - The type of tax (e.g., 'percent').
      - **name** (string) - Required - The name of the tax.
      - **value** (number) - Required - The tax value.
    - **Fee** (object) - Fee configuration.
      - **type** (string) - Required - The type of fee (e.g., 'percent').
      - **name** (string) - Required - The name of the fee.
      - **value** (number) - Required - The fee value.
  - **sections** (array) - Optional - Pricing table sections.
    - **title** (string) - Required - The title of the section.
    - **default** (boolean) - Optional - Whether this is the default section.
    - **rows** (array) - Optional - Rows within the section.
      - **options** (object) - Row options.
        - **optional** (boolean) - Optional - Whether the row is optional.
        - **optional_selected** (boolean) - Optional - Whether the optional row is selected.
        - **qty_editable** (boolean) - Optional - Whether quantity is editable.
      - **data** (object) - Row data.
        - **Name** (string) - Required - The name of the item.
        - **Description** (string) - Optional - The description of the item.
        - **Price** (number) - Required - The price of the item.
        - **QTY** (number) - Required - The quantity of the item.
        - **Tax** (object) - Tax applied to the row.
          - **value** (number) - Required - The tax value.
          - **type** (string) - Required - The type of tax (e.g., 'percent').
        - **Fee** (object) - Fee applied to the row.
          - **value** (number) - Required - The fee value.
          - **type** (string) - Required - The type of fee (e.g., 'percent').
      - **custom_fields** (object) - Custom fields for the row.

### Request Example
```json
{
  "name": "Full API Sample Document from PandaDoc Template",
  "detect_title_variables": true,
  "template_uuid": "hryJY9mqYZHjQCYQuSjRQg",
  "folder_uuid": "QMDSzwabfFzTgjW4kUijqQ",
  "owner": {
    "membership_id": "QMDSzwabfFzTgjW6KijHyu"
  },
  "recipients": [
    {
      "email": "josh@example.com",
      "first_name": "Josh",
      "last_name": "Ron",
      "role": "user"
    }
  ],
  "tokens": [
    {
      "name": "Favorite.Pet",
      "value": "Panda"
    }
  ],
  "fields": {
    "Favorite.Color": {
      "value": "PandaDoc green"
    },
    "Delivery": {
      "value": "Same Day Delivery"
    },
    "Like": {
      "value": true
    },
    "Date": {
      "value": "2019-12-31T00:00:00.000Z"
    }
  },
  "pricing_tables": [
    {
      "name": "Pricing Table 1",
      "data_merge": true,
      "options": {
        "Tax": {
          "type": "percent",
          "name": "Tax",
          "value": 10
        },
        "Fee": {
          "type": "percent",
          "name": "Fee",
          "value": 5
        }
      },
      "sections": [
        {
          "title": "Sample Section",
          "default": true,
          "rows": [
            {
              "options": {
                "optional": true,
                "optional_selected": true,
                "qty_editable": true
              },
              "data": {
                "Name": "Toy Panda",
                "Description": "Fluffy!",
                "Price": 10,
                "QTY": 3,
                "Tax": {
                  "value": 20,
                  "type": "percent"
                },
                "Fee": {
                  "value": 5,
                  "type": "percent"
                }
              },
              "custom_fields": {
                "Fluffiness": "5 / 5"
              }
            }
          ]
        }
      ]
    }
  ]
}
```

### Response
#### Success Response (200)
- **uuid** (string) - The unique identifier for the created document.
- **status** (string) - The current status of the document.
- **name** (string) - The name of the document.
- **created_at** (string) - The timestamp when the document was created.

#### Response Example
```json
{
  "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  "status": "draft",
  "name": "Full API Sample Document from PandaDoc Template",
  "created_at": "2023-10-27T10:00:00.000Z"
}
```
```

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

### Create Workspace Request Example

Source: https://developers.pandadoc.com/reference/create-workspace

This example demonstrates how to send a POST request to create a new workspace. Ensure you have the necessary Org Admin permissions. The request body should include the desired name for the new workspace.

```json
{
  "name": "A new workspace"
}
```

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

### Create User Request Example

Source: https://developers.pandadoc.com/reference/create-user

This example demonstrates the structure of a request body to create a new user. It includes user details, workspace assignments, and license type. Ensure you have organization admin privileges to perform this action.

```json
{
  "user": {
    "email": "test@pandadoc.com",
    "first_name": "New",
    "last_name": "User",
    "phone_number": ""
  },
  "workspaces": [
    {
      "workspace_id": "Ab123",
      "role": "Collaborator"
    }
  ],
  "license": "Guest"
}
```

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

### Create Templates Folder Request Example

Source: https://developers.pandadoc.com/reference/create-templates-folder

Use this example to create a new folder for storing templates. Ensure the folder name is provided in the request body.

```json
{
  "name": "A new templates folder"
}
```

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

### Get Document Summary - Missing Type Error (JSON Example)

Source: https://developers.pandadoc.com/reference/getdocumentsummary

This example illustrates the JSON response when the 'type' query parameter is missing from the request. This indicates an invalid request due to the missing parameter.

```json
{
  "error": {
    "code": "missing_type",
    "message": "The type query parameter was not provided."
  }
}
```

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

### Create User Response Example

Source: https://developers.pandadoc.com/reference/create-user

This is an example of a successful response when creating a user. It confirms the user's workspace assignments and provides their member ID.

```json
{
  "workspaces": [
    {
      "workspace_id": "MwZbjUVD5C3srSSxkpF4Aj",
      "role": "Member",
      "member_id": "VQDH2hdAPJBhSWmMrYa3zu"
    }
  ]
}
```

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

### Create Document from URL

Source: https://developers.pandadoc.com/reference/create-document-from-pandadoc-template

This endpoint enables the creation of a PandaDoc document from a public URL pointing to a PDF file. Information about roles, fields, and PDF examples can be found in the 'Create from public PDF' guide.

```APIDOC
## POST https://api.pandadoc.com/public/v1/documents

### Description
Create a document from a URL.

### Method
POST

### Endpoint
https://api.pandadoc.com/public/v1/documents

### Request Body
(Details not provided in source)
```

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

### Create Content Library Item Response Example

Source: https://developers.pandadoc.com/reference/create-content-library-item

This example demonstrates a successful response when creating a content library item. It includes the item's ID, name, creation/modification dates, version, and status.

```json
{
  "id": "va9aNuj3uX2w9M7uytn967",
  "name": "Sample CLI",
  "date_created": "2024-07-08T14:41:42.625906Z",
  "date_modified": "2024-07-08T14:41:42.700084Z",
  "version": "2",
  "status": "cli.PROCESSED"
}
```

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

### OpenAPI Schema Example

Source: https://developers.pandadoc.com/reference/search-catalog-items

An example of a nested schema definition within an OpenAPI specification, illustrating property requirements and example values.

```json
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string"
    }
  },
  "required": [
    "code"
  ]
},
"example": []
```

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

### List API Logs Example

Source: https://developers.pandadoc.com/reference/list-api-logs

This example demonstrates how to list all API logs within a workspace. It includes optional parameters for filtering by date, page number, and items per page. Ensure you have the correct API key or OAuth token for authentication.

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "PandaDoc Public API",
    "description": "PandaDoc API spans a broad range of functionality to help you build incredible documents automation experiences inside your product.\n\nPandaDoc API is organized around REST. Our API has predictable resource-oriented URLs and uses standard HTTP response codes, authentication, and verbs.\n\n## Getting started\n\nYou can start testing PandaDoc API with a sandbox key on our [Enterprise](https://www.pandadoc.com/pricing/) plan, either active or in trial.\n\nGenerate your [sandbox key](https://developers.pandadoc.com/reference/sandbox-key) on the Developer Dashboard with predefined [rate limits](https://developers.pandadoc.com/reference/limits). Or contact our solutions expert if you work with high-transaction volumes.\n\n## Guides\n\nIf you're just getting started with PandaDoc, you may want to jump straight into one of our [getting started guides](https://developers.pandadoc.com/docs/getting-started) for the feature you're most interested in, whether that's:\n\n- [Create from template](https://developers.pandadoc.com/docs/create-send-document),\n- [Upload and send a local PDF](https://developers.pandadoc.com/docs/upload-and-send-a-local-pdf),\n- or [Listening for changes in document status](https://developers.pandadoc.com/docs/listen-document-status-changes).\n\nWe also recommend you to discover our dynamic content generation on a fly: [Create from a template with content placeholder](https://developers.pandadoc.com/docs/create-with-content-placeholders-from-template).\n",
    "termsOfService": "https://www.pandadoc.com/master-services-agreement/",
    "contact": {
      "name": "PandaDoc API Support",
      "url": "https://developers.pandadoc.com/",
      "email": "api-track@pandadoc.com"
    },
    "license": {
      "name": "MIT",
      "url": "https://github.com/PandaDoc/pandadoc-openapi-specification/blob/main/LICENSE"
    },
    "version": "7.29.1"
  },
  "servers": [
    {
      "url": "https://api.pandadoc.com",
      "description": "Public API"
    }
  ],
  "security": [
    {
      "apiKey": []
    },
    {
      "oauth2": []
    }
  ],
  "tags": [
    {
      "name": "API Logs",
      "description": "Operations related to API logs."
    }
  ],
  "paths": {
    "/public/v1/logs": {
      "get": {
        "deprecated": true,
        "x-sunset": "2027-02-04",
        "summary": "List API Log",
        "description": "Get the list of all logs within the selected workspace.\n Optionally filter by date, page, and `#` of items per page.",
        "operationId": "listLogs",
        "tags": [
          "API Logs"
        ],
        "parameters": [
          {
            "$ref": "#/components/parameters/SinceParam"
          },
          {
            "$ref": "#/components/parameters/ToParam"
          },
          {
            "$ref": "#/components/parameters/CountParam"
          },
          {
            "$ref": "#/components/parameters/PageParam"
          },
          {
            "$ref": "#/components/parameters/StatusesParam"
          },
          {
            "$ref": "#/components/parameters/MethodsParam"
          },
          {
            "$ref": "#/components/parameters/SearchParam"
          },
          {
            "$ref": "#/components/parameters/EnvironmentTypeParam"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/APILogListResponse"
                },
                "examples": {
                  "List API Logs": {
                    "$ref": "#/components/examples/APILogListExample"
                  },
                  "List API Logs 2XX": {
                    "$ref": "#/components/examples/APILogList2XXExample"
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400RequestError"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "429": {
            "$ref": "#/components/responses/429"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "apiKey": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "description": "The `Authorization` header must contain the API key. The value should be prefixed with `API-Key` followed by a space and the actual API key.\n",
        "x-default": "API-Key 3039ba033eb1410caa0a2227158d63c9d6502cd8"
      },
      "oauth2": {
        "type": "oauth2",
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://app.pandadoc.com/oauth2/authorize",
            "tokenUrl": "https://api.pandadoc.com/oauth2/access_token",
            "refreshUrl": "https://api.pandadoc.com/oauth2/access_token"
          }
        }
      }
    }
  }
}
```

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

### Example Entity Type

Source: https://developers.pandadoc.com/reference/handlequoteupdated

An example of the entity type, which is 'recipient' in this context.

```json
"recipient"
```

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

### OpenAPI Query Parameter Example

Source: https://developers.pandadoc.com/reference/getdocumentsummary

Example of a query parameter definition within an OpenAPI specification. It specifies the parameter's location, requirement, description, schema reference, and an example value.

```yaml
      "in": "query",
      "required": true,
      "description": "Document summary granularity to return.\n",
      "schema": {
        "$ref": "#/components/schemas/DocumentSummaryType"
      },
      "example": "detailed"
    }
  }
}

```

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

### Create Member Token Example

Source: https://developers.pandadoc.com/reference/get-member-token

This example demonstrates how to create a member token. Ensure you are using Public API keys generated by an Org Admin. This endpoint is exposed upon request.

```json
{
  "token": "1fc7b52182405dbf004b9e9ffb555a6ac61419ba"
}
```

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

### Create Content Library Item Request Example

Source: https://developers.pandadoc.com/reference/create-content-library-item

This example shows the JSON payload for creating a new content library item. It requires a 'name' for the item.

```json
{
  "name": "CLI name example"
}
```

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

### Example Shared Link

Source: https://developers.pandadoc.com/reference/handlequoteupdated

An example of a shared link for a recipient to access a document.

```json
"https://app.pandadoc.com/document/15d4b481384b652a298530ddc7023bfc07a67d59"
```

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

### Create Templates Folder Response Example

Source: https://developers.pandadoc.com/reference/create-templates-folder

This is an example of a successful response when creating a new templates folder. It includes the folder's unique identifier, name, and creation timestamp.

```json
{
  "uuid": "h3HyGDj6NuiDfKEiY4xSMD",
  "name": "A new templates folder",
  "date_created": "2024-07-15T17:35:52.981054Z"
}
```

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

### Document Updated Event Example

Source: https://developers.pandadoc.com/reference/handledocumentsectionadded

An example of a document updated event payload.

```json
                "example": [
                  {
                    "event": "document_updated",

```

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

### Document Lock Information Example

Source: https://developers.pandadoc.com/reference/document-move-to-folder

Example of the structure returned when a document is locked.

```json
{
  "locked_by_user_id": "ajnN7eGutJZsRKjQrNuPkh",
  "lock_type": "wopi_editing",
  "expires_at": "2023-10-27T10:00:00Z"
}
```

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

### Recipient ID Example

Source: https://developers.pandadoc.com/reference/add-cc-recipient

Example of a recipient ID used in API requests.

```json
{
  "recipient_id": {
    "type": "string",
    "example": "2eWSKSvVqmuVCnuUK3iWwD"
  }
}
```

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

### Example API Key Authentication Header

Source: https://developers.pandadoc.com/reference/api-key-authentication-process

An example of an API request header with a sample API key. This demonstrates the format required for authentication.

```HTTP
Authorization: API-Key 3039ba033eb1410caa0a2227158d63c9d6502cd8
```

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

### Example Contact ID

Source: https://developers.pandadoc.com/reference/handlequoteupdated

An example of a valid contact identifier, which is a 22-character alphanumeric string.

```json
"HzXnuyNraSXMhXchYjUmHJ"
```

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

### Create Document Fields Request Example

Source: https://developers.pandadoc.com/reference/create-document-fields

This example shows how to structure a request to create fields for a document. It specifies the field type and its layout properties.

```json
{
  "fields": [
    {
      "type": "text",
      "layout": {
        "page": 1,
        "position": {
          "offset_x": 1,
          "offset_y": 1,
          "anchor_point": "topleft"
        },
        "style": {
          "width": 1,
          "height": 1
        }
      }
    }
  ]
}
```

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

### Current Member Details Example

Source: https://developers.pandadoc.com/reference/current-member-details

This example shows the JSON response when retrieving details for the currently authenticated member using their API key.

```json
{
  "user_id": "FA5QAu8UGA3oVDDZuPL75B",
  "membership_id": "RyMNXBjBPRppi56TfYBrXi",
  "email": "siarhei@pandadoc.com",
  "first_name": "Siarhei",
  "last_name": "",
  "is_active": true,
  "workspace": "n7SK7prHeoWJSXb9VkrPve",
  "workspace_name": "Workspace",
  "email_verified": true,
  "role": "Admin",
  "user_license": "Full",
  "date_created": "2023-08-03T11:49:16.364213Z",
  "date_modified": "2024-07-11T20:36:43.362526Z"
}
```

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

### Document Locked Response Example

Source: https://developers.pandadoc.com/reference/document-move-to-folder

Example of a response when attempting to modify a document that is currently locked.

```json
{
  "locked_by_user_id": "ajnN7eGutJZsRKjQrNuPkh",
  "lock_type": "wopi_editing",
  "expires_at": "2023-10-27T10:00:00Z",
  "type": "document_locked",
  "detail": "Document is currently being edited."
}
```

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

### API Log Details Example

Source: https://developers.pandadoc.com/reference/api-log-details

This example shows a successful API log entry for a POST request, including details about the request, response, and associated metadata.

```json
{
  "id": "AZC86i5PYKMjQjMMMw9e",
  "url": "/public/v1/documents/iZy3j9GmryVUSAbwL9tGWP/recipients/",
  "method": "POST",
  "status": 200,
  "request_time": "2024-07-15T18:59:38.000",
  "response_time": "2024-07-15T18:59:39.000",
  "request_body": {
    "id": "xNVQVHShdgxHTTPVJ3CWCC",
    "kind": "contact"
  },
  "query_params_string": null,
  "query_params_object": null,
  "response_body": {
    "recipient_id": "PsPqdRm4dt4thxnYMqttwY"
  },
  "token_type": "API_KEY",
  "application": null,
  "key": "9cf111111c3bd477ab9bb4123453b7f5d6502cd8",
  "request_id": "284b1456-1111-4ba9-1111-0d82418205f5",
  "user_email": "siarhei@pandadoc.com",
  "user_id": "Hzpt4yyQ3A5qHTTPdZQxpH"
}
```