Skip to content
Changelog

Report a bug

Signwell integration: operations for AI agents

Signwell connects to Type.com as an integration. This page lists the 28 operations documented for Claude and Codex in Type.com: 13 read, 9 write, 6 destructive.

About Signwell

SignWell API v1 reference operations, subject to Type setup and account permissions.

Categories: Documents & Forms

How to connect Signwell to Type.com

Connect
Configure provider-specific API target and authentication setup.
Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

28 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

28 operations listed.

Document

  • Read

    Get Document

    Returns a document and all associated document data. Supply the unique document ID from either a document creation request or Document page URL. Each recipient includes its `delivery_method`, and recipients whose delivery includes SMS also include an `sms` object with the masked phone number and SMS delivery status.

    GET /api/v1/documents/{id}

  • Read

    Completed PDF

    Gets a completed document PDF or ZIP file. Supply the unique document ID from either a document creation request or document page URL.

    GET /api/v1/documents/{id}/completed_pdf

  • Write

    Create Document

    Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent. Recipients are notified by email, SMS, or both based on each recipient's `delivery_method`. SMS delivery is available only to workspaces that are eligible for SMS and have it enabled, and requires a `phone_number` in E.164 format.

    POST /api/v1/documents

  • Write

    Create Document from Template

    Creates and optionally sends a new document for signing. If `draft` is set to true the document will not be sent. Pre-signed template signatures and initials are copied to the new document as document content — they remain visible on the document but do not generate a signing event, do not emit a `document_signed` webhook, and the recipient's status will not reflect them as a real signing action. If the template was pre-signed for a signer and the request adds new unsigned signature/initials fields for that same signer, the pre-applied ratifications are cleared silently so the signer is asked to sign once. Recipients are notified by email, SMS, or both based on each recipient's `delivery_method`. SMS delivery is available only to workspaces that are eligible for SMS and have it enabled, and requires a `phone_number` in E.164 format.

    POST /api/v1/document_templates/documents

  • Write

    Update Recipients

    Updates one or more recipients on a document that has already been sent. Only recipients who have not started signing may be updated. Recipient IDs must be retrieved from the Get Document response. Allowed document statuses: sent, viewed, pending, bounced. For non-embedded documents, updated recipients will receive a new notification email. For embedded signing documents, email behavior follows each recipient's send_email setting. This endpoint does not support changing a recipient's `delivery_method` or `phone_number`; SMS delivery settings are set when the document is created.

    PATCH /api/v1/documents/{id}/recipients

  • Write

    Update Authentication

    Update passcode delivery settings for recipients on a sent document. Only recipients who have not started signing can be updated.

    PATCH /api/v1/documents/{id}/authentication

  • Write

    Send Reminder

    Sends a reminder to recipients who have not signed yet. Each recipient is reminded through their delivery method (email, SMS, or both). SMS reminders are only sent to recipients whose delivery method includes SMS, and only when the workspace is eligible for SMS and has it enabled.

    POST /api/v1/documents/{id}/remind

  • Destructive

    Delete Document

    Deletes a document. Deleting a document will also cancel document signing (if in progress). Supply the unique document ID from either a Create Document request or document page URL.

    DELETE /api/v1/documents/{id}

  • Destructive

    Update and Send Document

    Updates a draft document and sends it to be signed by recipients. `subject` and `message` apply to email notifications only; SMS notifications always use fixed system templates.

    POST /api/v1/documents/{id}/send

Template

  • Read

    Get Template

    Returns a template and all associated template data. Supply the unique template ID from either a Create Template request or template page URL.

    GET /api/v1/document_templates/{id}

  • Write

    Create Template

    Creates a new template.

    POST /api/v1/document_templates

  • Destructive

    Update Template

    Updates an existing template.

    PUT /api/v1/document_templates/{id}

  • Destructive

    Delete Template

    Deletes a template. Supply the unique template ID from either a Create Template request or template page URL.

    DELETE /api/v1/document_templates/{id}

API Application

  • Read

    Get API Application

    Gets the details of a specific API Application within an account. Supply the unique Application ID from either the Create API Application response or the API Application edit page.

    GET /api/v1/api_applications/{id}

  • Destructive

    Delete API Application

    Deletes an API Application from an account. Supply the unique Application ID from either the Create API Application response or the API Application edit page

    DELETE /api/v1/api_applications/{id}

Webhooks

  • Read

    List Webhooks

    List all the webhooks in the account.

    GET /api/v1/hooks

  • Write

    Create Webhook

    Register a callback URL that we will post document and template events to. See [Events](https://developers.signwell.com/reference/events) for every event and when it is sent, and [Event Data](https://developers.signwell.com/reference/event-data) for the data each one carries. Note: a `document_signed` event is not emitted solely because a pre-signed template signature/initials was copied as document content, and `event.related_signer` only identifies a real recipient signing action.

    POST /api/v1/hooks

  • Destructive

    Delete Webhook

    Deletes a registered callback URL that we are posting document events to.

    DELETE /api/v1/hooks/{id}

Me

  • Read

    Get credentials

    Retrieves the account information associated with the API key being used.

    GET /api/v1/me

Bulk Send

  • Read

    Get Bulk Send

    Returns information about the Bulk Send.

    GET /api/v1/bulk_sends/{id}

  • Read

    List Bulk Sendings

    Returns information about the Bulk Send.

    GET /api/v1/bulk_sends

  • Read

    Get Bulk Send CSV Template

    Fetches a CSV template that corresponds to the provided document template IDs. CSV templates are blank CSV files that have columns containing required and optional data that can be sent when creating a bulk send. Fields can be referenced by the field label. Example: [placeholder name]_[field label] could be something like customer_address or signer_company_name (if 'Customer' and 'Signer' were placeholder names for templates set up in SignWell).

    GET /api/v1/bulk_sends/csv_template

  • Read

    Validate Bulk Send CSV

    Validates a Bulk Send CSV file before creating the Bulk Send. It will check the structure of the CSV and the data it contains, and return any errors found.

    POST /api/v1/bulk_sends/validate_csv

  • Read

    Get Bulk Send Documents

    Returns information about the Bulk Send.

    GET /api/v1/bulk_sends/{id}/documents

  • Write

    Create Bulk Send

    Creates a bulk send, and it validates the CSV file before creating the bulk send.

    POST /api/v1/bulk_sends

Regional

  • Read

    MX – NOM-151 Certificate

    Download NOM-151 certificate for a completed document. Returns a ZIP file, download URL, or raw certificate data based on query parameters.

    GET /api/v1/documents/{id}/nom151_certificate

Account

  • Read

    Get Account

    Returns the name, logo, and default settings of the account associated with the credentials being used.

    GET /api/v1/account

  • Write

    Update Account

    Updates the account name, logo, or default settings. Only the fields included in the request are changed.

    PUT /api/v1/account

See How connections work for access and permissions, or browse all integrations.