Connecting to PdfMonkey

Using API Key Authentication

PdfMonkey uses API key authentication. To obtain an API key:

1. Log in to your PdfMonkey account at https://app.pdfmonkey.io
2. Navigate to your account settings
3. Open the API Key page
4. Copy your API key

After obtaining your API key, set the following connection properties:

• AuthScheme: Set this to APIKey.

Set the following in the ProfileSettings connection property:

• APIKey: Set this to your PdfMonkey API key.

Example Connection String

Profile=C:\profiles\PdfMonkey.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your_api_key"

Connecting to PdfMonkey

Once the authentication is configured, you can connect to PdfMonkey and query data from any of the available tables such as CurrentUser, DocumentCards, Documents, DocumentTemplateCards, and DocumentTemplates.

Available Tables

The PdfMonkey API Profile provides access to document generation and template data across 5 tables:

• CurrentUser: Returns authenticated user account details including plan information and document quota.
• DocumentCards: Returns document card summary records with status, download URLs, and filter support.
• Documents: Returns full document objects including payload, generation logs, and metadata (requires Id).
• DocumentTemplateCards: Returns document template card summaries with editor type and folder information (requires AppId).
• DocumentTemplates: Returns full document template objects including HTML body and print settings (requires Id).

Important Notes

• The Documents and DocumentTemplates tables require Id to be specified as a filter in the WHERE clause.
• The DocumentTemplateCards table requires AppId (workspace UUID) to be specified as a filter in the WHERE clause.
• The PdfMonkey API uses page-based pagination for list endpoints (DocumentCards, DocumentTemplateCards).
• Date fields use ISO 8601 format (yyyy-MM-dd'T'HH:mm:ssZ).
• Rate limiting applies - refer to PdfMonkey API documentation for current limits.

Usage Examples

CurrentUser:

SELECT * FROM CurrentUser

DocumentCards:

SELECT * FROM DocumentCards

DocumentCards - filter by Status:

SELECT * FROM DocumentCards WHERE Status = 'success'

DocumentCards - filter by workspace:

SELECT * FROM DocumentCards WHERE AppId = 'your-workspace-uuid'

DocumentCards - filter by template:

SELECT * FROM DocumentCards WHERE DocumentTemplateId = 'your-template-uuid'

DocumentCards - search by filename:

SELECT * FROM DocumentCards WHERE Filename = 'invoice-2024'

Documents:

SELECT * FROM Documents WHERE Id = 'your-document-uuid'

DocumentTemplateCards:

SELECT * FROM DocumentTemplateCards WHERE AppId = 'your-workspace-uuid'

DocumentTemplateCards - filter by folder:

SELECT * FROM DocumentTemplateCards WHERE AppId = 'your-workspace-uuid' AND TemplateFolderId = 'your-folder-uuid'

DocumentTemplates:

SELECT * FROM DocumentTemplates WHERE Id = 'your-template-uuid'

API Documentation

For more information about the PdfMonkey API, see the official PdfMonkey API documentation.

Connection Properties

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider.

---

Property	Description
APIKey	Your PdfMonkey API key from the PdfMonkey Dashboard.
AuthScheme	The scheme used for authentication. Accepted entries are APIKey or None. Allowed values are: BASIC, NONE, NTLM, OAUTH, APIKEY, OAUTH_CLIENT