# Ironclad

> This reference documents each type of Action available to be sent.

## Pages

- [Actions](actions.md): This reference documents each type of Action available to be sent.
- [Activity API](activity-api.md): The Activity API exposes a super-fast, highly available API. The purpose of this API is to manage 3 things:
- [Add a Site to Your Account](add-a-site-to-your-account-1.md): {
- [Add a Snapshot Location to an Agreed Event](add-a-snapshot-location-to-an-agreed-event.md): Snapshots enable legal teams to manage and automatically capture visual evidence for clickwrap agreements at scale.
- [Adding a Signature to an Embedded Contract](adding-a-signature-to-embedded-contract.md): How to add a stylized signature or initials block into a document itself
- [Android SDK](android-sdk.md): Fork it at [
- [Angular SDK](angular-sdk.md): Angular SDK for easy Clickwrap/Browsewrap implementation leveraging PactSafe's JavaScript Library
- [Authentication (Activity API)](authentication-2.md): Learn about how authentication works with the Activity API.
- [BrowsewrapGroup Object](browsewrapgroup-object.md): This reference documents the properties and methods available on the BrowsewrapGroup object.
- [Check if Signer Has Accepted Latest Contracts](check-if-signer-has-accepted-latest-contracts.md): Occasionally, you may want to know if a Signer has accepted the latest set of Contract Versions within a Group, which...
- [Salesforce Integration](clickwrap-for-salesforce.md): It may be needed for you to write Ironclad Clickwrap data back to Salesforce once an agreement has been accepted.
- [ClickwrapGroup Object](clickwrapgroup-object.md): This reference documents the properties and methods available on the ClickwrapGroup object.
- [Ironclad Clickwrap Terminology](common-data-structures-in-pactsafe.md): Within Ironclad Clickwrap, there is a set of data structures to consider when interacting with the API that will help...
- [DataObject](dataobject.md): This reference documents the properties and methods available on the DataObject.
- [Debugging with PS.js](debugging-the-javascript-in-pactsafe.md): You can optionally enable debugging in our JavaScript library by adding a flag right after you load your`_ps('create...
- [Delete a Signer by Signer ID](delete-a-signer-1.md): {
- [Delete activity performed by a signer](delete-activity-by-signer-id.md): {
- [Archive a Contract](delete-contracts-contract-id.md): This will archive a Contract/Template from Ironclad Clickwrap. All associated versions and activities will also be ar...
- [Delete a Group](delete-groups-group-id.md): Delete a Group by ID
- [Delete a Snapshot location](delete-locations-id.md): Requires **manage** permissions for Snapshots. Only allow for draft locations now
- [Delete Field on a Version](delete-versions-version-id-fields-field-id.md): Delete Field on a Version by Version ID
- [Filtering Templates - Virtual Groups](dynamic-groups-and-how-to-use-them.md): Ironclad Clickwrap offers the ability to create multiple templates, filter them, and display the relevant template(s)...
- [Using Force Scroll](force-scroll-in-group-settings-and-how-to-handle-it-in-your-code.md): Inside your [Group settings](https://app.pactsafe.com/groups), you may have noticed the option to "Force Scroll" for ...
- [Retrieve Your Account](get-your-account-details-1.md): {
- [Retrieve PDF Record by ID](get-activity-activity-id-record.md): Retrieve a PDF Record of a Clickwrap Action by Action ID
- [Retrieve an Activity](get-activity-activity-id.md): Retrieve a Clickwrap Action by ID.
- [Retrieve PDF Record by Session ID](get-activity-record-session-session-id.md): Retrieve a PDF of a Clickwrap Request or Signer Record by Session ID
- [List all Activity.](get-activity.md): List Clickwrap Actions within the context of the User (across all Sites and Accounts)
- [Retrieve Latest Version](get-contracts-contract-id-versions-latest.md): This Version may be in a published or draft state.
- [Retrieve Latest Published Version](get-contracts-contract-id-versions-published.md): This will return the latest published Version of a Contract.
- [Retrieve a Version by Number](get-contracts-contract-id-versions-version-number.md): Note: This is not by the id of the Version.
- [List Versions of a Contract](get-contracts-contract-id-versions.md): List Versions of a Contract
- [Retrieve a Contract](get-contracts-contract-id.md): Note: You can also pass a query string parameter`expand=latest_version`to return the latest version for each Agreem...
- [List all Contracts](get-contracts.md): List contracts in an Account
- [Retrieve Export Job URLs](get-extract-evidence-id-urls.md): Retrieve the presigned urls of an export job if it is complete
- [Get an Export Job by ID](get-extract-evidence-id.md): Get an export job by id.
- [List all Export Jobs](get-extract-evidence.md): Get all export jobs.
- [Retrieve a Group by ID](get-groups-group-id.md): Retrieve a Group by ID
- [Retrieve a Group by Key](get-groups-key-group-key.md): Retrieve a Group by Key
- [List all Groups](get-groups.md): List all groups available to the current user
- [Get a Snapshot record for a timestamp.](get-locations-id-snapshots-record-timestamp.md): {
- [Get a Snapshot record for a specific Snapshot.](get-locations-id-snapshots-snapshotid-record.md): {
- [Get a Snapshot.](get-locations-id-snapshots-snapshotid.md): User requires **view** or **manage** permission.
- [Get a location's Snapshots.](get-locations-id-snapshots.md): User requires **view** or **manage** permission.
- [Get a Snapshot location.](get-locations-id.md): {
- [Get Snapshot locations](get-locations.md): Returns an array of Snapshot Locations
- [List all Contracts in a Site](get-sites-site-id-contract.md): Note: You can also pass a query string parameter`expand=published_version`to return the latest published version de...
- [List Groups in a Site](get-sites-site-id-groups.md): List Groups in the specified Site
- [List all Activity by Signer ID](get-sites-site-id-signers-id-signer-id-activity.md): List Clickwrap Actions within a Site by Signer ID
- [List all sites](get-sites.md): {
- [Retrieve a Version](get-versions-version-id.md): Retrieve a Version by ID
- [REST API](getting-started-rest-api.md): Our REST API is a comprehensive set of APIs to connect to Ironclad Clickwrap for things like creating or versioning c...
- [Introduction](getting-started.md): Hi there! Welcome to the Ironclad Clickwrap Developer Portal. We have a rich set of developer tools to help you integ...
- [Authentication (REST API)](getting-your-access-token.md): Learn how to authenticate with the REST API by generating and using an access token.
- [Global_ps Object](global-ps-object.md): This reference documents the properties and methods available on the global`_ps`object, and details on using the as...
- [GroupStore Object](groupstore-object.md): This reference documents the properties and methods available on the GroupStore object.
- [How to Add a Clickwrap Group into a Marketo Form](how-to-add-a-clickwrap-group-into-a-marketo-form.md): This step-by-step guide will teach you how to integrate Clickwrap tracking into your Marketo Form.
- [How to Add a Terms of Use to a Checkout Page](how-to-add-a-terms-of-use-clickwrap-to-a-checkout-page.md): This step-by-step guide will teach you how to load a Terms of Use Agreement to a checkout page.
- [How to Add a Terms of Use Clickwrap to a Sign Up Page](how-to-add-a-terms-of-use-clickwrap-to-a-sign-up-page.md): This step-by-step guide will teach you how to load a Terms of Use Agreement to a sign-up page.
- [Get Acceptance Record Download URL](how-to-get-a-download-url-for-a-pdf-record-after-acceptance.md): After your Signer accepts your agreements, you may want to provide them with a link to a copy of the agreement. This ...
- [Dynamically Render Contract Data](how-to-use-dynamic-contracts-with-the-javascript-library.md): With the Ironclad Clickwrap JavaScript Library, you can inject data to dynamically swap the values of tokens within a...
- [Integrating Ironclad Clickwrap without PS.js](integrating-clickwrap-without-psjs.md): The guide will cover a server-side setup for accepting clickwraps.
- [Integrating Ironclad Clickwrap with Zapier](integrating-pactsafe-with-zapier.md): 🚧 This article includes a reference to "Webhooks" in Ironclad Clickwrap.
- [Integrating your own email or SMS provider](integrating-your-own-email-or-sms-provider.md): Don't want to use our emails or SMS messages? Simply set up a new integration to configure using your own.
- [iOS SDK](ios-sdk.md): Fork it at [
- [Java SDK](java-sdk.md): A Java client for the [Ironclad Clickwrap](https://ironcladapp.com/product/clickwrap/) Activity API. Integrate into a...
- [Ironclad Clickwrap API Documentation](javascript-library-clickwrap-loading-a-clickwrap-101.md): - [Guides](/docs)
- [Ironclad Clickwrap API Documentation](javascript-library-clickwrap-loading-a-group-with-dynamic-contract-data.md): - [Guides](/docs)
- [Ironclad Clickwrap API Documentation](javascript-library-clickwrap-loading-a-virtual-group.md): - [Guides](/docs)
- [Ironclad Clickwrap API Documentation](javascript-library-clickwrap-marketo-forms.md): - [Guides](/docs)
- [Ironclad Clickwrap API Documentation](javascript-library-clickwrap-sending-acceptance-manually.md): - [Guides](/docs)
- [Ironclad Clickwrap API Documentation](javascript-library-clickwrap-sending-custom-data.md): - [Guides](/docs)
- [JavaScript Library](javascript-library-getting-started.md): With our JavaScript snippet, we make it as easy as possible to get started tracking acceptance with the Ironclad Clic...
- [JavaScript Library Reference Docs](javascript-library-reference-docs.md): The following section provides much more detailed information on the Ironclad Clickwrap JavaScript library itself.
- [General Considerations](javascript-sdk-considerations.md): Before getting started with implementing the Ironclad Clickwrap JavaScript SDK, you may want to consider some of the ...
- [List all Signers](list-all-signers-1-1.md): {
- [List all Signers in a Site](list-all-signers-2.md): {
- [List all Site Memberships](list-all-site-memberships-1.md): Site Memberships includes the permissions of the user on the Site.
- [Loading a Clickwrap 101](loading-a-clickwrap-101.md): Below, we'll cover a few key topics to getting up and running with the Ironclad Clickwrap JavaScript Library.
- [Manually Sending Acceptance](manually-sending-acceptance.md): The default behaviour for Embedded Clickwraps is to send acceptance as soon as the user checks the checkbox. When usi...
- [Overview](overview-copy.md): Sites are individual entities underneath an Account. Groups, Contracts, and Versions are all contained within the Sit...
- [ParameterStore Object](parameterstore-object.md): This reference documents the properties and methods available on the ParameterStore object.
- [Update a Version by Number](patch-contracts-contract-id-versions-version-number.md): Update a Contract Version by Version Number
- [Update a Contract](patch-contracts-contract-id.md): Update a Contract by ID
- [Update a Group](patch-groups-group-id.md): Update a Group by ID
- [Update a Snapshot location](patch-locations-id.md): Requires **manage** permissions for Snapshots.`key`can only be changed if the Snapshot Locaiton is in the`draft`(...
- [Update a Version](patch-versions-version-id.md): Before updating a Version, a new Version must be created in Draft status. More information on creating a version can ...
- [Restore the latest deprecated Version of a Contract](post-contracts-contract-id-restore.md): Allow the customer to restore the latest deprecated Version to published status.
- [Publish a Version](post-contracts-contract-id-versions-version-number-publish.md): To simplify the publishing of Versions via API, we've added a very simple route to call instead of including`{versio...
- [Create a Version](post-contracts-contract-id-versions.md): There are a couple of important things to note when creating a new Version for a Contract:
- [Create and Publish a Contract](post-contracts-publish.md): Note: Only supported for HTML contracts at this time.
- [Create an Export](post-extract-evidence.md): Creates an export job.
- [Publish a Group](post-groups-group-id-publish.md): Publish a Group by ID
- [Archive a Snapshot location.](post-locations-id-archive.md): Requires **manage** permissions for Snapshots. Only allow for published locations now.
- [Clone a Snapshot location.](post-locations-id-clone.md): Requires **manage** permissions for Snapshots.
- [Publish a Snapshot location](post-locations-id-publish.md): Requires **manage** permissions for Snapshots.
- [Trigger a Snapshot capture.](post-locations-id-snapshots-capture.md): Requires **upload** or **manage** permissions.
- [Archives a Snapshot.](post-locations-id-snapshots-snapshotid-archive.md): Requires **manage** permissions for Snapshots.
- [Upload a manually captured Snapshot.](post-locations-id-snapshots-upload.md): Requires **upload** or **manage** permissions.`captured_time`defaults to now. If`captured_time`is supplied it mus...
- [Create a new Snapshot location](post-locations.md): Requires **manage** permissions for Snapshots. A Snapshot Location can be either a`Mobile`or`Web`location dependi...
- [Create a contract](post-sites-site-id-contract.md): To create a Contract, you must specify a site ID, which will be part of the URL.
- [Create a Group in a Site](post-sites-site-id-groups.md): Create a Group in the specified Site
- [Create Field on a Version](post-versions-version-id-fields.md): Note: the Version must be in a draft state.
- [Publish a Version](post-versions-version-id-publish.md): Publish a Version by Version ID
- [Checking Acceptance on Login](prompting-your-user-on-login.md): As a company grows and adapts to changing regulatory landscapes, it must also update its agreements. Ensuring that us...
- [React SDK](react-sdk.md): Automatically loads the Ironclad Clickwrap JavaScript Library into your app so all you have to do is call`_ps`to us...
- [Remove a Site](remove-a-site-1.md): {
- [Retrieve a Signer by Signer ID](retrieve-a-signer-by-signer-id-1.md): {
- [Retrieve a Site](retrieve-a-site-1.md): A single Site with all of its properties and details.
- [Retrieve Last Contracts Signed by Signer](retrieve-last-terms-signed-by-signer.md): The [Retrieve Contracts Accepted by Signer](https://clickwrap-developer.ironcladapp.com/reference/get-retrieve-contra...
- [List all Site Members](retrieve-user-membership-for-a-site-1.md): {
- [List all User Memberships](retrieve-user-memberships-for-an-account-1.md): {
- [Retrieving Activity Data in Bulk](retrieving-data-in-bulk.md): Today, there are a few available options for retrieving bulk Activity of data from the Ironclad Clickwrap platform ou...
- [Retrieving Clickwrap HTML or Data](retrieving-group-html-or-data.md): At certain times, you may not be able to utilize one of our SDKs or our JavaScript Snippet but need a way to present ...
- [Salesforce Integration (via Salesforce Apex)](salesforce-integration-via-salesforce-apex.md): This guide provides a framework for integrating Ironclad Clickwrap and Salesforce with Salesforce Apex.
- [Salesforce Integration (via Zapier)](salesforce-integration-via-zapier.md): This guide provides a framework for integrating Ironclad Clickwrap and Salesforce, utilizing Zapier as a middleware t...
- [Overview](sdk-overview.md): Be sure to visit our [GitHub page](https://github.com/pactsafe) for our latest public examples!
- [Setting up the JavaScript Snippet](setting-up-the-javascript-snippet.md): This reference documents the JavaScript Snippet used to include the Ironclad Clickwrap Library on a website.
- [Signer Object](signer-object.md): A Signer in Ironclad Clickwrap refers to the counterparty accepting the contract. Signer objects in Ironclad are uniq...
- [Site Object](site-object.md): This reference documents the properties and methods available on the Site object.
- [Snapshots for Native Apps](snapshots-for-native-apps.md): This guide will cover setting up Snapshots for native apps.
- [Snapshots](snapshots.md): Users can be given **manage** or **upload** permissions.
- [Sending Acceptance via Activity API](tracking-acceptance-via-pactsafe-api.md): The following are definitions for various query parameters seen in the example API calls below:
- [Triggered Events](triggered-events-1.md): Let's say you wanted to enable a button once a checkbox is checked:
- [Troubleshooting ps.js API Calls](troubleshooting-verifying-calls-are-being-made.md): 🚧 HTTPS is Required
- [Tutorials](tutorials.md): This section will cover guides to set up Ironclad Clickwrap. Here you'll find step-by-step instructions.
- [Update a Signer by Signer ID](update-a-signer-by-signer-id-1.md): {
- [Update a Site](update-a-site-1.md): {
- [Update a User's Permissions](update-a-user-1.md): {
- [Update Your Account](update-your-account-details-1.md): {
- [Upsert a Signer](upsert-a-signer-1.md): You can pass **either** a single Signer JSON object or _an array_ of Signer objects with`additional_attributes`that...
- [Using Embedded Forms](using-embedded-forms-in-groups.md): Embedded forms give you the user experience of Ironclad Clickwrap's platform with the flexibility of our integration ...
- [Sending Clickwrap Data Server-side](using-psjs-with-back-end-api-calls.md): You may want to use PS.js to render the contracts on the page, populate a contract with app data, and more—but send t...
- [Webhook Events + Payload Examples](webhook-events.md): * Activity - Agreed
- [Getting Started with Webhooks](working-with-ironclad-webhooks.md): Webhooks allow you to automate custom backend actions and downstream processes in response to acceptances that are lo...