PlugSign

https://plugsign.readme.io/reference/
Admin
PlugSign is a digital signature and document management API that enables integration of document...
Tokens:188,576
Snippets:481
Trust Score:9.9
Update:11 months ago
Show doc for...
Tokens:
Raw
### GET Company Resellers Signed Files - JSON Response Example

Source: https://plugsign.readme.io/reference/get-company-resellers-signed-files-amount

Example JSON response from the GET /api/companies/resellers/signed endpoint showing paginated results with reseller IDs and signed file counts. Includes pagination metadata and navigation links for multi-page result sets.

```json
{
  "current_page": 1,
  "data": [
    {
      "reseller_id": 3,
      "files": 2
    },
    {
      "reseller_id": 6,
      "files": 1
    }
  ],
  "first_page_url": "https://app.plugsign.com.br/api/companies/resellers/signed?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "https://app.plugsign.com.br/api/companies/resellers/signed?page=1",
  "links": [
    {
      "url": null,
      "label": "&laquo; Previous",
      "active": false
    },
    {
      "url": "https://app.plugsign.com.br/api/companies/resellers/signed?page=1",
      "label": "1",
      "active": true
    },
    {
      "url": null,
      "label": "Next &raquo;",
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "https://app.plugsign.com.br/api/companies/resellers/signed",
  "per_page": 15,
  "prev_page_url": null,
  "to": 2,
  "total": 2
}
```

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

### Batch Response Example with Signing Requests and Files

Source: https://plugsign.readme.io/reference/get-single-lote

JSON response example from the GET single batch endpoint showing complete batch data structure with embedded lote_requests array containing signing keys and URLs, plus files array with document metadata, download links, and upload information.

```json
{
  "data": {
    "id": 3,
    "company_id": 731,
    "name": "lote-exemplo",
    "created_at": "2024-09-30 16:49:38",
    "updated_at": "2024-09-30 16:49:38",
    "lote_requests": [
      {
        "id": 3,
        "signing_key": "rBIIb25n8UA2FOZXfb1R2uoXfa3hlM28",
        "email": "contato@exemplo.com",
        "message": "teste",
        "sender": 1573,
        "expire_date": null,
        "send_time": "30/09/2024 16:55:02",
        "update_time": "30/09/2024 16:55:52",
        "created_at": "30/09/2024 16:55:02",
        "status": "Pending",
        "lote_id": 3,
        "url": "https://app.plugsign.com.br/view/lote/321?signingKey=rBIIb25n8UA2FOZXfb1R2uoXfa3hlM28"
      }
    ],
    "files": [
      {
        "id": 463494,
        "name": "lote-exemplo-1",
        "file_name": "dxww4du3D4N3z56UXD92rczIsadn3pEd.pdf",
        "extension": "pdf",
        "size": 13,
        "status": "Unsigned",
        "document_key": "d182jiQ3C6BCaARdzxQMi24uqMa4328",
        "editted": "Yes",
        "is_template": "No",
        "template_fields": null,
        "accessibility": "Everyone",
        "departments": "",
        "folder": "Source",
        "uploaded_by": {
          "name": "Empresa",
          "last_name": "Exemplo"
        },
        "uploaded_on": "30/09/2024 16:49:38",
        "download": "https://app.plugsign.com.br/api/files/download/d182jiQ3C6BCaARdzxQMi24uqMa4328",
        "tags": [],
        "editablevalidate": 3
      },
      {
        "id": 463495,
        "name": "lote-exemplo-2",
        "file_name": "sv8gi4KZLd32GvR8L3Dd2Od34du4tx5x.pdf",
        "extension": "pdf",
        "size": 13,
        "status": "Unsigned",
        "document_key": "ax3thc56w2r3FvkxJX43z4dg5UBckd22",
        "editted": "Yes",
        "is_template": "No",
        "template_fields": null,
        "accessibility": "Everyone",
        "departments": "",
        "folder": "Source",
        "uploaded_by": {
          "name": "Empresa",
          "last_name": "Exemplo"
        },
        "uploaded_on": "30/09/2024 16:49:38",
        "download": "https://app.plugsign.com.br/api/files/download/ax3thc56w2r3FvkxJX43z4dg5UBckd22",
        "tags": [],
        "editablevalidate": 3
      }
    ]
  }
}
```

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

### GET File Legacy History Request Examples (Node.js, Ruby, PHP, Python)

Source: https://plugsign.readme.io/reference/history

Examples of how to make a GET request to retrieve the legacy file history using different programming languages. These snippets show the basic structure for making authenticated API calls.

```javascript
const fetch = require('node-fetch');

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer token',
    'accept': 'application/json'
  }
};

fetch('https://app.plugsign.com.br/api/histories/legacy/file', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.plugsign.com.br/api/histories/legacy/file")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer token"
request["accept"] = "application/json"

response = http.request(request)
puts response.read_body
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.plugsign.com.br/api/histories/legacy/file",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer token",
    "accept: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:". $err;
} else {
  echo $response;
}
```

```python
import requests

url = "https://app.plugsign.com.br/api/histories/legacy/file"

headers = {
    "Authorization": "Bearer token",
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

print(response.text)
```

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

### GET Single Company Example Response - JSON

Source: https://plugsign.readme.io/reference/get-single-company

Example JSON response from the GET /api/companies/reseller/{id} endpoint showing the complete data structure of a single company record with all available fields populated with sample values.

```json
{
  "data": {
    "id": 9878,
    "name": "Velma Example",
    "email": "exemplo@gmail.com",
    "phone": "11999999999",
    "cnpj": "11111111111111",
    "address": "4140 Becker Light\nNolaberg, WV 06738-1712",
    "payment_end": "",
    "access": null,
    "can_login": null,
    "limits": [],
    "mail_host": "smtp.mailtrap.io",
    "mail_from": "no-reply@exemplo.com",
    "mail_username": "usuario@exemplo.com",
    "mail_encryption": "tls",
    "mail_port": "587",
    "unlimited": 0
  }
}
```

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

### GET All Customers Endpoint Request Examples

Source: https://plugsign.readme.io/reference/customers

Demonstrates how to make a GET request to the 'All Customers' endpoint using Python. This allows listing all registered customers and filtering results via query parameters. Requires 'Authorization' and 'accept' headers.

```python
import requests

url = "https://app.plugsign.com.br/api/customers"

headers = {
    'Authorization': 'Bearer token',
    'accept': 'application/json'
}

response = requests.get(url, headers=headers)

print(response.text)
```

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

### GET All Customers Endpoint Request Examples

Source: https://plugsign.readme.io/reference/customers

Demonstrates how to make a GET request to the 'All Customers' endpoint using cURL. This allows listing all registered customers and filtering results via query parameters. Requires 'Authorization' and 'accept' headers.

```shell
curl --request GET \
     --url https://app.plugsign.com.br/api/customers \
     --header 'Authorization: Bearer token' \
     --header 'accept: application/json'
```

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

### GET All Automated Reminders Request Examples

Source: https://plugsign.readme.io/reference/automated-reminders

Examples of how to call the GET /api/reminders/automated endpoint to list all automated reminders configured for the current company account. Supports cURL, Node.js, Ruby, PHP, and Python.

```shell
curl --request GET \
     --url https://app.plugsign.com.br/api/reminders/automated \
     --header 'Authorization: Bearer token' \
     --header 'accept: application/json'
```

```javascript
// Node.js example (using a hypothetical 'axios' library)
const axios = require('axios');

const options = {
  method: 'GET',
  url: 'https://app.plugsign.com.br/api/reminders/automated',
  headers: {
    'Authorization': 'Bearer token',
    'accept': 'application/json'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

```

```ruby
# Ruby example (using a hypothetical 'httparty' gem)
require 'httparty'

response = HTTParty.get('https://app.plugsign.com.br/api/reminders/automated', 
  headers: {
    'Authorization' => 'Bearer token',
    'accept' => 'application/json'
  }
)

puts response.body
```

```php
// PHP example (using cURL)

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, 'https://app.plugsign.com.br/api/reminders/automated');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
  'Authorization: Bearer token',
  'accept: application/json'
]);

$response = curl_exec($curl);

if (curl_errno($curl)) {
    echo 'Error:' . curl_error($curl);
}

c_lose($curl);

echo $response;

```

```python
# Python example (using 'requests' library)
import requests

url = "https://app.plugsign.com.br/api/reminders/automated"
headers = {
    "Authorization": "Bearer token",
    "accept": "application/json"
}

response = requests.get(url, headers=headers)

print(response.json())
```

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

### GET All Customers Endpoint Request Examples

Source: https://plugsign.readme.io/reference/customers

Demonstrates how to make a GET request to the 'All Customers' endpoint using PHP. This allows listing all registered customers and filtering results via query parameters. Requires 'Authorization' and 'accept' headers.

```php
<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, 'https://app.plugsign.com.br/api/customers');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, [
  'Authorization: Bearer token',
  'accept: application/json'
]);

$response = curl_exec($curl);

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

curl_close($curl);

?>
```

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

### GET All Customers Endpoint Request Examples

Source: https://plugsign.readme.io/reference/customers

Demonstrates how to make a GET request to the 'All Customers' endpoint using Ruby. This allows listing all registered customers and filtering results via query parameters. Requires 'Authorization' and 'accept' headers.

```ruby
require 'uri'
require 'net/http'

url = URI("https://app.plugsign.com.br/api/customers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer token"
request["accept"] = "application/json"

response = http.request(request)
puts response.read_body
```

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

### GET All files Request (Ruby)

Source: https://plugsign.readme.io/reference/files

Illustrates how to retrieve all files via the API using Ruby's 'net/http' library. The example shows setting up the request with the correct URL and headers for authentication.

```ruby
require 'net/http'
require 'uri'

uri = URI.parse('https://app.plugsign.com.br/api/docs')
request = Net::HTTP::Get.new(uri)
request['Authorization'] = 'Bearer YOUR_TOKEN'
request['Accept'] = 'application/json'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
  http.request(request)
end

puts response.body
```

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

### Webhook GET Response Example - JSON

Source: https://plugsign.readme.io/reference/get-all-webhooks

Sample JSON response from the GET /api/webhooks endpoint showing the data structure returned when listing webhooks. Contains array of webhook objects with id, url, type, and status fields demonstrating the response format for active webhooks.

```json
{
    "data": [
        {
            "id": 7,
            "url": "https://webhook.site/4b782c19-e867-4b93-9a2d-7cade71d95a7",
            "type": "REQUESTS_UPDATED",
            "status": 1
        },
        {
            "id": 7,
            "url": "https://webhook.site/4b782c19-e867-4b93-9a2d-7cade71d95a7",
            "type": "REQUESTS_UPDATED",
            "status": 1
        }
    ]
}
```

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

### GET All Customers Endpoint Request Examples

Source: https://plugsign.readme.io/reference/customers

Demonstrates how to make a GET request to the 'All Customers' endpoint using Node.js. This allows listing all registered customers and filtering results via query parameters. Requires 'Authorization' and 'accept' headers.

```javascript
const fetch = require('node-fetch');

const options = {
  method: 'GET',
  headers: {
    Authorization: 'Bearer token',
    'accept': 'application/json'
  }
};

fetch('https://app.plugsign.com.br/api/customers', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));
```

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

### Lote Request Success Response Example

Source: https://plugsign.readme.io/reference/get-single-lote-request

Sample 200 OK response from the GET single lote request endpoint containing complete lote request details including timestamps, status, and signing URL for access.

```json
{
  "data": {
    "id": 1,
    "signing_key": "dagQ9dfs3asWA1dXXKCv4p2Udn352DSs",
    "email": "contato@exemplo.com",
    "message": "Segue para assinatura",
    "sender": 12,
    "expire_date": null,
    "send_time": "19/09/2024 09:49:24",
    "update_time": "01/10/2024 09:36:47",
    "created_at": "19/09/2024 09:49:24",
    "status": "Pending",
    "lote_id": 1,
    "url": "https://app.plugsign.com.br/view/lote/1?signingKey=dagQ9dfs3asWA1dXXKCv4p2Udn352DSs"
  }
}
```

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

### Sample Signature Request Response JSON

Source: https://plugsign.readme.io/reference/get-single-request

Complete example response from the GET Single Request endpoint demonstrating the full data structure including request identification, document reference, signature positions with page coordinates, sender details with certificate information, and request lifecycle timestamps.

```json
{
  "data": {
    "id": 1601469,
    "signing_key": "5BKLud7blQX2m3NFzhSBgca0S8KD7stu",
    "document": "LuJrWJ01duSEWxHsZoaZ1aU3rHf7QYOg",
    "email": "exemplo@gmail.com",
    "message": "teste",
    "positions": "[\"1041.33\",{\"type\":\"image\",\"page\":\"1\",\"xPos\":\"-999\",\"yPos\":\"-999\",\"width\":\"200\",\"height\":\"75\",\"fontsize\":null,\"group\":\"input\"}]",
    "chain_positions": "",
    "chain_emails": "",
    "signature_type": "all",
    "image_selfie": 0,
    "image_doc": 0,
    "image_doc_back": 0,
    "doubleauth": "0",
    "sender": {
      "id": 122,
      "name": "Teste",
      "last_name": "Costa",
      "email": "teste@hotmail.com",
      "phone": "989939999",
      "cpf": null,
      "permissions": ["edit", "delete", "upload", "send_request", "protect"],
      "recive_email": 1,
      "recive_whatsapp": 0,
      "role": "admin",
      "status": "Active",
      "certificate": {
        "certificate_name": "MINHA EMPRESA",
        "issuer": "ICP-Brasil",
        "model": "Certificado PJ",
        "validity": "2025-10-04 11:21:00"
      }
    },
    "expire_date": null,
    "send_time": "27/05/2025 01:39:24",
    "update_time": "04/06/2025 21:17:57",
    "due_months": 0,
    "creted_at": "27/05/2025 01:39:24",
    "status": "Pending",
    "observer": []
  }
}
```

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

### Example API Response (JSON)

Source: https://plugsign.readme.io/reference/post-create-customer

Demonstrates a successful API response for a customer registration, including the created customer's data and a confirmation message. This example showcases the structure of the 'data' object and the 'message' field returned upon successful operation.

```json
{
    "data": {
        "id": 289,
        "name": "Joaquim",
        "last_name": "Silva",
        "phone": "11999999999",
        "address": "Rua Nove de Julho, 1234, Centro, São Paulo",
        "email": "joaquim@teste.com.br"
    },
    "message": "Cliente cadastrado com sucesso!"
}
```

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

### GET Single Tag JSON Response Example

Source: https://plugsign.readme.io/reference/get-single-tag

Example JSON response returned by the GET /api/tags/{id} endpoint. Contains a data object with tag properties including ID, name, and creation timestamp in ISO format.

```json
{
    "data": {
        "id": 2,
        "name": "teste",
        "created_at": "2024-03-05 14:28:24"
    }
}
```

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

### Create Lote - POST Request with cURL

Source: https://plugsign.readme.io/reference/lotes

Creates a batch (lote) of documents in Plugsign via POST request. This endpoint accepts a batch name, minimum 2 files in Base64 format, optional department assignments, visibility settings, and validation type with QR code placement options. Requires Bearer token authentication and returns batch details including file information and metadata.

```shell
curl --request POST \
  --url https://app.plugsign.com.br/api/lotes \
  --header 'Authorization: Bearer token' \
  --header 'accept: application/json' \
  --header 'content-type: application/json'
```

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

### API Response Example for Client Registration

Source: https://plugsign.readme.io/reference/post-create-company

This JSON object represents a successful response after registering a new client. It includes a success message, authentication tokens, and detailed information about the registered company, such as its ID, name, contact details, and access credentials.

```json
{
    "message": "Cliente cadastrado com sucesso!",
    "token_type": "Bearer",
    "token": "ayJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9. eyJpc3MiOiJodHRwczpcLdvYXBwLnB33WdzaWduLmNvbS5icldYXBpXC9jbDkdjEsIm5iZiI6MTY2MTM0OTIyM2wianRpIjoiZU4Wdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw",
    "company": {
        "id": 148,
        "name": "Empresa XYZ",
        "email": "exemplo@teste.com.br",
        "phone": "11999999999",
        "cnpj": "11.111.111/1111-11",
        "address": "Rua dos anjos, 123, Centro, São Paulo",
        "access": {
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1diJ9.eyJpc3MiOiJodHRwczpcL1wvYXBwLnBsdWdzaWduLm1vb25icpYXQiOjE2NjEzNDkyMjEsIm5iZiI6MTY2MTM0OTIyMSwianRpIjoiZUxWdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw"
        },
        "cpf": "11111111111"
    }
}
```

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

### GET Single email sent - Response Example

Source: https://plugsign.readme.io/reference/get-single-email-sent

Example JSON response from the GET Single email sent endpoint showing the structure of sent email data. Returns email metadata including recipient address, subject line, message body, associated file identifier, origin source, and current delivery status.

```json
{
  "data": {
    "sent_to": "exemplo@gmail.com",
    "subject": "Lembre-se de assinar o doc pendente!",
    "message": "Você foi convidado(a) para assinar um documento por José",
    "file": "11VR4D775d3d2a3Vdw68MpTdfRWTddfD",
    "origin": "api_manual_reminder",
    "status": "Pending"
  }
}
```

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

### POST /websites/plugsign_readme_io_reference

Source: https://plugsign.readme.io/reference/post-create-company

This endpoint is used to register a new company and its associated settings within the PlugSign system. It allows for configuration of various parameters including payment details, API integrations, and document generation options.

```APIDOC
## POST /websites/plugsign_readme_io_reference

### Description
Registers a new company with detailed configuration options, including API credentials, payment information, and document generation preferences.

### Method
POST

### Endpoint
`/websites/plugsign_readme_io_reference`

### Parameters
#### Request Body
- **id** (int32) - Optional - Provider's exit port, only numbers.
- **can_login** (boolean) - Optional - Set to 1 if the company is authorized to access the system, and 0 if not.
- **payment_end** (string) - Optional - Format d/m/Y. Must be a date later than the current date.
- **plugzapi_instance** (string) - Optional - PlugZapi instance identifier.
- **plugzapi_token** (string) - Optional - PlugZapi authentication token.
- **plugzapi_account_token** (string) - Optional - PlugZapi account token.
- **editablevalidate** (integer) - Optional - Controls QR Code placement and validation page generation.
  - 1: QR Code at the top (no final page).
  - 2: No QR Code at the top, only a final page.
  - 3: Validation final page and QR Code in the header (extra pages will be created).
  - 4: QR Code at the bottom (no final page).
  - 5: Validation final page and QR Code at the bottom (extra pages will be created).
  - 6: QR Code (Text) on the left side.
  - 7: QR Code (Text) on the right side.
- **unlimited** (integer) - Optional - When enabled (True), no custom limits will be applied to the company.
- **limits** (array) - Optional - Company-specific limits.
  - **type** (string) - Required - The type of limit (disk, users, files, or signer).
  - **limit** (integer) - Required - The total limit in number.
- **webhook_header_name** (string) - Optional - Custom header name sent in webhooks to the registered URI.
- **webhook_header_value** (string) - Optional - Custom header value sent in webhooks to the registered URI.

### Request Example
```json
{
  "id": 123,
  "can_login": true,
  "payment_end": "31/12/2024",
  "plugzapi_instance": "instance123",
  "plugzapi_token": "your_plugzapi_token",
  "plugzapi_account_token": "your_plugzapi_account_token",
  "editablevalidate": 3,
  "unlimited": 0,
  "limits": [
    {
      "type": "users",
      "limit": 100
    },
    {
      "type": "disk",
      "limit": 1024
    }
  ],
  "webhook_header_name": "X-Custom-Header",
  "webhook_header_value": "SecretValue"
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message of successful registration.
- **token_type** (string) - The type of token issued (e.g., "Bearer").
- **token** (string) - Authentication token for subsequent API requests.
- **company** (object) - Details of the registered company.
  - **id** (integer) - Unique identifier for the company.
  - **name** (string) - Name of the company.
  - **email** (string) - Contact email for the company.
  - **phone** (string) - Contact phone number for the company.
  - **cnpj** (string) - Company's CNPJ (Brazilian taxpayer registry number).
  - **address** (string) - Company's physical address.
  - **access** (object) - Access credentials for the company.
    - **token** (string) - Access token for the company.
  - **cpf** (string) - Company representative's CPF (Brazilian individual taxpayer registry number).

#### Response Example
```json
{
    "message": "Cliente cadastrado com sucesso!",
    "token_type": "Bearer",
    "token": "ayJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9. eyJpc3MiOiJodHRwczpcLdvYXBwLnB33WdzaWduLmNvbS5icldYXBpXC9jbDkdjEsIm5iZiI6MTY2MTM0OTIyM2wianRpIjoiZU4Wdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw",
    "company": {
        "id": 148,
        "name": "Empresa XYZ",
        "email": "exemplo@teste.com.br",
        "phone": "11999999999",
        "cnpj": "11.111.111/1111-11",
        "address": "Rua dos anjos, 123, Centro, São Paulo",
        "access": {
            "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1diJ9.eyJpc3MiOiJodHRwczpcL1wvYXBwLnBsdWdzaWduLm1vb25icpYXQiOjE2NjEzNDkyMjEsIm5iZiI6MTY2MTM0OTIyMSwianRpIjoiZUxWdlp3R3dkVTI0STVleCIsInN1YiI6Mjg4LCJwcnYiOiIyM2JkNWM4OTQ5ZjYwMGFkYjM5ZTcwMWM0MDA4NzJkYjdhNTk3NmY3IiwiZW1haWwiOiJndWlsaGVybWVAdGVzdGUuY29tLmJyIn0.ErA0h7WOYNnKnEoqmZH_0ajI7nI7BgdDY1U5lyxRXgw"
        },
        "cpf": "11111111111"
    }
}
```
```

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

### GET Logs Response Example - Paginated Log Records

Source: https://plugsign.readme.io/reference/get-logs

Example JSON response from the GET /api/logs endpoint showing log records with pagination metadata. Contains an array of log entries with request details and a pagination structure including first, last, prev, and next links along with current page information.

```json
{
  "data": [
    {
      "id": 1397,
      "url": "https://app.plugsign.com.br/api/webhooks",
      "method": "GET",
      "status": 200,
      "request_body": "[]",
      "response": "{\"data\":[{\"id\":7,\"url\":\"https:\\/\\/app.plugsign.com.br\",\"type\":\"REQUESTS_UPDATED\",\"status\":0},{\"id\":13,\"url\":\"https:\\/\\/app.plugsign.com.br\",\"type\":\"REQUESTS_OPENED\",\"status\":1}]}",
      "created_at": "2024-08-19 15:59:45"
    }
  ],
  "links": {
    "first": "/?page=1",
    "last": "/?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "/",
    "per_page": "10",
    "to": 2,
    "total": 2
  }
}
```

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

### GET File tags - JSON Response Example

Source: https://plugsign.readme.io/reference/get-file-tags

Sample JSON response from the GET /api/files/{id}/tags endpoint. Returns a data array containing tag objects with id, name, and created_at properties. Each tag represents a label associated with a document.

```json
{
    "data": [
        {
            "id": 2,
            "name": "teste",
            "created_at": "2024-03-05 14:28:24"
        },
        {
            "id": 2,
            "name": "teste",
            "created_at": "2024-03-05 14:28:24"
        }
    ]
}
```

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

### OpenAPI Definition for GET Single Signature Type

Source: https://plugsign.readme.io/reference/get-single-signature-type

This OpenAPI 3.1.0 definition outlines the 'GET Single Signature Type' endpoint. It specifies the request method (GET), the URL path (/api/requests/types/{id}), required parameters (id), and the structure of the successful response (200 OK) with example data. Authentication is configured using an API key.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Endpoints manuais",
    "version": "1.4"
  },
  "servers": [
    {
      "url": "https://app.plugsign.com.br"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "x-bearer-format": "bearer",
        "x-default": "token"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/requests/types/{id}": {
      "get": {
        "summary": "GET Single signature type",
        "description": "<p>   Com este endpoint, você obtém os detalhes de um <em>signature type</em> específico. </p>",
        "operationId": "get-single-signature-type",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id do signature type",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"data\": {\n    \"id\": 1,\n    \"name\": \"Testemunha\",\n    \"created_at\": \"2024-11-26 15:51:53\",\n    \"updated_at\": \"2024-11-26 15:51:53\"\n  }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "example": 1,
                          "default": 0
                        },
                        "name": {
                          "type": "string",
                          "example": "Testemunha"
                        },
                        "created_at": {
                          "type": "string",
                          "example": "2024-11-26 15:51:53"
                        },
                        "updated_at": {
                          "type": "string",
                          "example": "2024-11-26 15:51:53"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "682b40f5c6c634001175eff2:682d539e5f73a9002adb010a"
}
```

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

### Webhook Response Example (JSON)

Source: https://plugsign.readme.io/reference/post-update-company

Example of a successful JSON response from a webhook.
This response indicates a successful client update.

```json
{
    "message": "Cliente atualizado com sucesso"
}
```

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

### GET All files Request (PHP)

Source: https://plugsign.readme.io/reference/files

Shows a PHP implementation for fetching all files from the Plugsign API. This example uses cURL functions to construct and send the GET request with necessary headers.

```php
<?php

$curl = curl_init();

curl_setopt($curl, CURLOPT_URL, 'https://app.plugsign.com.br/api/docs');
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_HTTPHEADER, array(
    'Authorization: Bearer YOUR_TOKEN',
    'Accept: application/json'
));

$response = curl_exec($curl);

if (curl_errno($curl)) {
    echo 'Error:' . curl_error($curl);
}

curl_close($curl);

echo $response;
?>
```

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

### OpenAPI 3.1.0 Specification for GET Single Tag

Source: https://plugsign.readme.io/reference/get-single-tag

Complete OpenAPI definition for the GET /api/tags/{id} endpoint that retrieves a single tag by its ID. Includes security scheme configuration with bearer token authentication, path parameters, and JSON response schema with example data.

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Endpoints manuais",
    "version": "1.4"
  },
  "servers": [
    {
      "url": "https://app.plugsign.com.br"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "x-bearer-format": "bearer",
        "x-default": "token"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/api/tags/{id}": {
      "get": {
        "summary": "GET Single tag",
        "description": "<p>   Com este endpoint, você pode <strong>visualizar os detalhes de uma única tag</strong> previamente cadastrada no sistema. </p>",
        "operationId": "get-single-tag",
        "parameters": [
          {
            "name": "id",
            "in": "path",
            "description": "Id da tag a ser retornada",
            "schema": {
              "type": "integer",
              "format": "int32"
            },
            "required": true
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"data\": {\n        \"id\": 2,\n        \"name\": \"teste\",\n        \"created_at\": \"2024-03-05 14:28:24\"\n    }\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "integer",
                          "example": 2,
                          "default": 0
                        },
                        "name": {
                          "type": "string",
                          "example": "teste"
                        },
                        "created_at": {
                          "type": "string",
                          "example": "2024-03-05 14:28:24"
                        }
                      }
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "682b40f5c6c634001175eff2:682d5b8610b31c00120859ce"
}
```

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

### GET /websites/plugsign_readme_io_reference

Source: https://plugsign.readme.io/reference/get-all-folders

Retrieve a list of all folders and their subfolders. Filtering options are available via query parameters.

```APIDOC
## GET /websites/plugsign_readme_io_reference

### Description
With this endpoint, you can list all folders or specific folders on the platform, remembering that the API will also return subfolders as secondary objects. It is possible to filter the results using the available query parameters listed below.

### Method
GET

### Endpoint
/websites/plugsign_readme_io_reference

### Parameters
#### Query Parameters
- **folderId** (string) - Optional - The ID of the folder to retrieve.
- **parentId** (string) - Optional - The ID of the parent folder to filter by.

### Response
#### Success Response (200)
- **folders** (array) - A list of folder objects.
  - **id** (string) - The unique identifier of the folder.
  - **name** (string) - The name of the folder.
  - **parentId** (string) - The ID of the parent folder.
  - **subfolders** (array) - A list of subfolder objects.

#### Response Example
```json
{
  "folders": [
    {
      "id": "folder_123",
      "name": "Documents",
      "parentId": null,
      "subfolders": [
        {
          "id": "folder_456",
          "name": "Reports",
          "parentId": "folder_123",
          "subfolders": []
        }
      ]
    }
  ]
}
```
```

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

### POST /websites/plugsign_readme_io_reference

Source: https://plugsign.readme.io/reference/post-create-company

Create a sub-account (company) and obtain a token for its independent management. This allows for granular control over sub-accounts within the system.

```APIDOC
## POST /websites/plugsign_readme_io_reference

### Description
Creates a sub-account (company) and provides a token for its management. This enables independent manipulation of sub-accounts within the system.

### Method
POST

### Endpoint
/websites/plugsign_readme_io_reference

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **company_name** (string) - Required - The name of the company to be created.
- **email** (string) - Required - The email address associated with the new company.

### Request Example
```json
{
  "company_name": "New Subsidiary Inc.",
  "email": "contact@newsubsidiary.com"
}
```

### Response
#### Success Response (201 Created)
- **company_id** (string) - The unique identifier for the newly created company.
- **api_token** (string) - The token to be used for managing this sub-account.

#### Response Example
```json
{
  "company_id": "cmp_12345abcde",
  "api_token": "tok_abcdef1234567890"
}
```
```
Tokens:
Raw