# Public API Documentation

> Documentation for Public API

Append .md to any documentation page URL to get its markdown version.

## Guides
- [Partner integration](https://developer.oneflow.com/docs/partner-integration.md)
- [Building a partner integration](https://developer.oneflow.com/docs/building-a-partner-integration.md)
- [Other important changes](https://developer.oneflow.com/docs/other-important-changes.md)
- [Getting started](https://developer.oneflow.com/docs/getting-started.md)
- [Authentication and authorization](https://developer.oneflow.com/docs/authentication-and-authorization.md)
- [API quick reference](https://developer.oneflow.com/docs/api-quick-reference.md)
- [Type reference](https://developer.oneflow.com/docs/type-reference.md)
- [Creating a contract](https://developer.oneflow.com/docs/creating-a-contract.md)
- [Create a contract with data fields](https://developer.oneflow.com/docs/create-a-contract-with-data-fields.md)
- [Create a contract with products](https://developer.oneflow.com/docs/create-a-contract-with-products.md)
- [Create a contract with counterparties](https://developer.oneflow.com/docs/create-a-contract-with-counterparties.md)
- [Contract import and AI extract](https://developer.oneflow.com/docs/contract-import-and-ai-extract.md)
- [Create a contract with data fields - Legacy](https://developer.oneflow.com/docs/create-a-contract-with-data-fields-legacy.md)
- [Product group](https://developer.oneflow.com/docs/product-group-1.md)
- [Decimal prices and quantities](https://developer.oneflow.com/docs/decimal-prices-and-quantities.md)
- [Product tax](https://developer.oneflow.com/docs/product-tax.md)
- [Download a contract file](https://developer.oneflow.com/docs/download-a-contract-file.md)
- [Manage template type data fields](https://developer.oneflow.com/docs/manage-template-type-data-fields.md)
- [Getting started with webhooks](https://developer.oneflow.com/docs/getting-started-with-webhooks.md)
- [Contact](https://developer.oneflow.com/docs/contact-1.md)
- [Contract](https://developer.oneflow.com/docs/contract.md)
- [Contract event](https://developer.oneflow.com/docs/contract-event.md)
- [Contract file](https://developer.oneflow.com/docs/contract-file.md)
- [Data field](https://developer.oneflow.com/docs/data-field.md)
- [Folder](https://developer.oneflow.com/docs/folder-1.md)
- [Links](https://developer.oneflow.com/docs/links.md)
- [Log](https://developer.oneflow.com/docs/log-1.md)
- [Participant](https://developer.oneflow.com/docs/participant.md)
- [Party](https://developer.oneflow.com/docs/party.md)
- [Product group](https://developer.oneflow.com/docs/product-group.md)
- [Reminder](https://developer.oneflow.com/docs/reminder.md)
- [Tag](https://developer.oneflow.com/docs/tag-1.md)
- [Template](https://developer.oneflow.com/docs/template.md)
- [Template type](https://developer.oneflow.com/docs/template-type.md)
- [User](https://developer.oneflow.com/docs/user.md)
- [Webhook](https://developer.oneflow.com/docs/webhook.md)
- [Webhook and event](https://developer.oneflow.com/docs/webhook-and-event.md)
- [Workspace](https://developer.oneflow.com/docs/workspace.md)
- [Oneflow platform glossary](https://developer.oneflow.com/docs/oneflow-platform-glossary.md)

## API Reference
- [API Overview](https://developer.oneflow.com/reference/api-overview.md)
- [API Rate Limit](https://developer.oneflow.com/reference/api-rate-limit.md)
- [Get account-related information](https://developer.oneflow.com/reference/get-account-related-information.md): Use this endpoint to retrieve information about the current Oneflow account.
- [Get integration extensions](https://developer.oneflow.com/reference/get-integration-extensions.md): Use this endpoint to retrieve all available integration extension information associated with your Oneflow account. You can use either a generic API token or an integration-specific API token in the `x-oneflow-api-token` header to access all available integration extensions.
- [Create a contact](https://developer.oneflow.com/reference/create-a-contact.md): Use this endpoint to create a new contact within the selected workspace.
- [Get Contacts in a workspace.](https://developer.oneflow.com/reference/get-contacts-in-a-workspace.md): Use this endpoint to retrieve the list of contacts in a workspace.
- [Get a contact by ID](https://developer.oneflow.com/reference/get-a-contact-by-id.md): Use this endpoint to retrieve a specific contact by ID.
- [Delete a contact by ID](https://developer.oneflow.com/reference/delete-a-contact-by-id.md): Use this endpoint to delete specific contact by its ID.
- [Update a contact by ID](https://developer.oneflow.com/reference/update-a-contact-by-id.md): Use this endpoint to update a specific contact by ID.
- [Get contracts](https://developer.oneflow.com/reference/get-contracts.md): Use this endpoint to retrieve the list of contracts.
- [Create a contract](https://developer.oneflow.com/reference/create-a-contract.md): Use this endpoint to create a new contract based on the selected template.
- [Get a contract by ID](https://developer.oneflow.com/reference/get-a-contract-by-id.md): Use this endpoint to retrieve a specific contract by its ID.
- [Update a contract by ID](https://developer.oneflow.com/reference/update-a-contract-by-id.md): Use this endpoint to update a specific contract by its ID. Note that many fields are only editable before the contract is signed.
- [Delete a contract by ID](https://developer.oneflow.com/reference/delete-a-contract-by-id.md): Use this endpoint to delete a specific contract by its ID.
- [Publish a contract by ID](https://developer.oneflow.com/reference/publish-a-contract-by-id.md): Use this endpoint to send contract to participants.
- [Move a contract by ID](https://developer.oneflow.com/reference/move-a-contract-by-id.md): Use this endpoint to move contract between workspaces and folders.
- [Mark contract as signed by ID](https://developer.oneflow.com/reference/mark-contract-as-signed-by-id.md): Use this endpoint to mark contract as signed by contract ID via API. Note that this is not the contract sign endpoint for a single user. This only to mark the contract is signed by all users.
- [Decline a contract by ID](https://developer.oneflow.com/reference/decline-a-contract-by-id.md): Use this endpoint to decline a contract by contract ID via API.
- [Copy a contract](https://developer.oneflow.com/reference/copy-a-contract.md): Use this endpoint to create a copy of an existing contract.
- [Start draft approval workflow of a contract](https://developer.oneflow.com/reference/start-draft-approval-workflow-of-a-contract.md): Use this endpoint to initiate the draft approval workflow of a contract.
- [Create a template from a contract](https://developer.oneflow.com/reference/create-a-template-from-a-contract.md): Use this endpoint to create a template from an existing contract.
- [Import a contract](https://developer.oneflow.com/reference/import-a-contract.md): Use this endpoint to import a contract.
- [AI Extract in an imported contract by ID](https://developer.oneflow.com/reference/ai-extract-in-an-imported-contract-by-id.md): Use this endpoint to perform AI Extract on a specific imported contract by its ID.
- [List contract comments.](https://developer.oneflow.com/reference/list-contract-comments.md): Use this endpoint to retrieve the list of comments available for the specified contract ID.
- [Create a comment.](https://developer.oneflow.com/reference/create-a-comment.md): Use this endpoint to add a comment to a specific contract. See [Comment](doc:comment) for more information.
- [Get a contract comment by ID.](https://developer.oneflow.com/reference/get-a-contract-comment-by-id.md): Use this endpoint to retrieve a specified contract comment by its ID.
- [Get contract data fields](https://developer.oneflow.com/reference/get-contract-data-fields.md): Use this endpoint to retrieve the list of data fields for the specified contract ID.
- [Update contract data field values](https://developer.oneflow.com/reference/update-contract-data-field-values.md): Use this endpoint to update one or multiple data field values in the specified contract. See [Data field](data-field) for more information.
- [Get a contract data field by ID](https://developer.oneflow.com/reference/get-a-contract-data-field-by-id.md): Use this endpoint to retrieve a specific contract data field by its ID.
- [Update a contract data field value](https://developer.oneflow.com/reference/update-a-contract-data-field-value.md): Use this endpoint to update the specified data field value in the specified contract. See [Data field](data-field) for more information.
- [Get a contract event by ID](https://developer.oneflow.com/reference/get-a-contract-event-by-id.md): Use this endpoint to retrieve a specific contract event by its ID.
- [Get contract files](https://developer.oneflow.com/reference/get-contract-files.md): Use this endpoint to retrieve the list of all files available for the specified contract ID, which includes the contract itself, contract verification, attachments, and PDF documents.
- [Upload files](https://developer.oneflow.com/reference/upload-files.md): Use this endpoint to add multiple attachments or a single PDF document to a contract. See [here](doc:create-a-contract-with-a-pdf) for more information.
- [Get a contract file by ID](https://developer.oneflow.com/reference/get-a-contract-file-by-id.md): Use this endpoint to retrieve a specific contract file by its ID.
- [Upload files to a file group](https://developer.oneflow.com/reference/upload-files-to-a-file-group.md): Use this endpoint to add multiple attachments or a single PDF document to a specific file group in a contract.
- [Upload an image to an image group](https://developer.oneflow.com/reference/upload-an-image-to-an-image-group.md): Use this endpoint to add an image to a specific image group in a contract.
- [Create a link](https://developer.oneflow.com/reference/create-a-link.md): Use this endpoint to create a link between contracts.
- [Delete a contract link by link ID](https://developer.oneflow.com/reference/delete-a-contract-link-by-link-id.md): Use this endpoint to delete a link between two contracts by link's ID.
- [Get parties](https://developer.oneflow.com/reference/get-parties.md): Use this endpoint to retrieve the list of parties for the specified contract ID.
- [Create a party](https://developer.oneflow.com/reference/create-a-party.md): Use this endpoint to create a counterparty in a contract.
- [Get a party by ID](https://developer.oneflow.com/reference/get-a-party-by-id.md): Use this endpoint to retrieve a party from a contract.
- [Update a party by ID](https://developer.oneflow.com/reference/update-a-party-by-id.md): Use this endpoint to update a party in a contract.
- [Delete a party by ID](https://developer.oneflow.com/reference/delete-a-party-by-id.md): Use this endpoint to delete a specific contract party by its ID.
- [Create a participant](https://developer.oneflow.com/reference/create-a-participant.md): Use this endpoint to add a new participant to an existing contract party.
- [Get a participant by ID](https://developer.oneflow.com/reference/get-a-participant-by-id.md): Use this endpoint to retrieve a specific participant from a contract party by its ID.
- [Update a participant by ID](https://developer.oneflow.com/reference/update-a-participant-by-id.md): Use this endpoint to update a participant in a contract.
- [Delete a participant by ID](https://developer.oneflow.com/reference/delete-a-participant-by-id.md): Use this endpoint to delete a specific contract participant by its ID.
- [Create an access link](https://developer.oneflow.com/reference/create-an-access-link.md): Use this endpoint to create an access link to a contract for a specific participant.
- [Get products in a contract](https://developer.oneflow.com/reference/get-products-in-a-contract.md): Use this endpoint to get products in a contract.
- [Get a product by ID](https://developer.oneflow.com/reference/get-a-product-by-id.md): Use this endpoint to get a specific product within a specific contract by product ID.
- [Update a product by ID](https://developer.oneflow.com/reference/update-a-product-by-id.md): Use this endpoint to update a specific product in a specific contract by the product ID. See [Products](doc:product-group#products) for more information.
- [Update a list of product groups](https://developer.oneflow.com/reference/update-a-list-of-product-groups.md): Use this endpoint to update the products and configurations of a list of product groups in a contract. See [Product Group](doc:product-group) for more information.
- [Get product groups in a contract](https://developer.oneflow.com/reference/get-product-groups-in-a-contract.md): Use this endpoint to get product groups in a contract.
- [Get a product group by ID](https://developer.oneflow.com/reference/get-a-product-group-by-id.md): Use this endpoint to get the products and configuration of a product group in a contract.
- [Update a product group by ID](https://developer.oneflow.com/reference/update-a-product-group-by-id.md): Use this endpoint to update the products and configuration of a product group in a contract. See [Product Group](doc:product-group) for more information.
- [Add a product to a product group](https://developer.oneflow.com/reference/add-a-product-to-a-product-group.md): Use this endpoint to add a product to a specific product group in a contract. See [Products](doc:product-group#products) for more information.
- [Get a product in a product group](https://developer.oneflow.com/reference/get-a-product-in-a-product-group.md): Use this endpoint to get a specific product within a specific product group in the contract.
- [Update a product in a product group](https://developer.oneflow.com/reference/update-a-product-in-a-product-group.md): Use this endpoint to update a specific product within a specific product group in the contract. See [Products](doc:product-group#products) for more information.
- [Delete a product in a product group](https://developer.oneflow.com/reference/delete-a-product-in-a-product-group.md): Use this endpoint to delete a specific product from a specific product group in the contract.
- [Get reminders](https://developer.oneflow.com/reference/get-reminders.md): Use this endpoint to get reminders on the contract.
- [Create a reminder](https://developer.oneflow.com/reference/create-a-reminder.md): Use this endpoint to create a internal reminder to the owner side participants on the contract.
- [Get a reminder by ID](https://developer.oneflow.com/reference/get-a-reminder-by-id.md): Use this endpoint to get a reminder on the contract.
- [Update a reminder by ID](https://developer.oneflow.com/reference/update-a-reminder-by-id.md): Use this endpoint to update an internal reminder which is already existing on a contract.
- [Delete a reminder by ID](https://developer.oneflow.com/reference/delete-a-reminder-by-id.md): Use this endpoint to delete a reminder on the contract.
- [Check API availability](https://developer.oneflow.com/reference/check-api-availability.md): Use this endpoint to check if the Oneflow API is available and to authenticate a Oneflow user.
- [Update a folder by ID](https://developer.oneflow.com/reference/update-a-folder-by-id.md): Use this endpoint to upadate a specific folder by ID.
- [Delete a folder by ID](https://developer.oneflow.com/reference/delete-a-folder-by-id.md): Use this endpoint to delete a specific folder by ID.
- [Create a folder](https://developer.oneflow.com/reference/create-a-folder.md): Use this endpoint to create a folder in the given workspace.
- [Get Folders](https://developer.oneflow.com/reference/get-folders.md): Use this endpoint to retrieve the list of folders in the account with their workspaces.
- [Get data to create a contract](https://developer.oneflow.com/reference/get-data-to-create-a-contract-1.md): Use this endpoint to retrieve the workspaces with their templates. This data is essential for creating a contract.
- [Get template type data fields](https://developer.oneflow.com/reference/get-template-type-data-fields.md): Use this endpoint to return the data fields of the specified template type.
- [Get logs](https://developer.oneflow.com/reference/get-logs.md): Use this endpoint to retrieve HTTP request logs occured in the Oneflow account.
- [Get tags](https://developer.oneflow.com/reference/get-tags.md): Use this endpoint to retrieve the list of all tags for the given account. See [Tag](doc:tag-1) for more information.
- [Create a tag](https://developer.oneflow.com/reference/create-a-tag.md): Use this endpoint to create a tag for the given account. See [Tag](doc:tag-1) for more information.
- [Delete a tag by ID](https://developer.oneflow.com/reference/delete-a-tag-by-id.md): Use this endpoint to delete a specific tag by ID.
- [Update a tag by ID](https://developer.oneflow.com/reference/update-a-tag-by-id.md): Use this endpoint to update a specific tag by ID.
- [Get a tag by ID](https://developer.oneflow.com/reference/get-a-tag-by-id.md): Use this endpoint to get a specific tag by ID.
- [Get templates](https://developer.oneflow.com/reference/get-templates.md): Use this endpoint to retrieve the list of templates available for the specified user.
- [Get a template by ID](https://developer.oneflow.com/reference/get-a-template-by-id.md): Use this endpoint to retrieve a specific template by its ID.
- [Get a template file by ID](https://developer.oneflow.com/reference/get-a-template-file-by-id.md): Use this endpoint to retrieve a specific template file by its ID.
- [Create a template type](https://developer.oneflow.com/reference/create-a-template-type.md): Use this endpoint to create a template type.
- [Get template types](https://developer.oneflow.com/reference/get-template-types-1.md): Use this endpoint to retrieve a list of template types available for the specified user.
- [Get template type by ID](https://developer.oneflow.com/reference/get-template-type-by-id.md): Use this endpoint to retrieve a specific template type by its ID.
- [Update template type data fields](https://developer.oneflow.com/reference/update-template-type-data-fields.md): Use this endpoint to update all data fields in the specified template type. See the [Data Field](data-field) for more information.
- [Delete a template type data field by ID](https://developer.oneflow.com/reference/delete-a-template-type-data-field-by-id.md): Use this endpoint to delete a data field by its ID in the specified template type. See the [Data Field](data-field) data model for more information.
- [Get users in an account](https://developer.oneflow.com/reference/get-users-in-an-account.md): Use this endpoint to retrieve a list of all users from a Oneflow account.
- [Get webhooks](https://developer.oneflow.com/reference/get-webhooks.md): Use this endpoint to retrieve the list of webhooks available for the specified user.
- [Create a webhook](https://developer.oneflow.com/reference/create-a-webhook.md): Use this endpoint to create a new webhook.
- [Get a webhook by ID](https://developer.oneflow.com/reference/get-a-webhook-by-id.md): Use this endpoint to retrieve a specific webhook by ID.
- [Update a webhook by ID](https://developer.oneflow.com/reference/update-a-webhook-by-id.md): Use this endpoint to update a specific webhook by ID.
- [Delete a webhook by ID](https://developer.oneflow.com/reference/delete-a-webhook-by-id.md): Use this endpoint to de-register a specific webhook by ID.
- [Get workspaces](https://developer.oneflow.com/reference/get-workspaces.md): Use this endpoint to retrieve the list of workspaces available for the specified user.
- [Get a workspace by ID](https://developer.oneflow.com/reference/get-a-workspace-by-id.md): Use this endpoint to retrieve a specific workspace by ID.
- [Get integration blueprints](https://developer.oneflow.com/reference/get-integration-blueprints.md): Use this endpoint to get a list of integration blueprints.
- [Create an integration blueprint](https://developer.oneflow.com/reference/create-an-integration-blueprint.md): Use this endpoint to create an integration blueprint.
- [Get an integration blueprint by ID](https://developer.oneflow.com/reference/get-an-integration-blueprint-by-id-1.md): Use this endpoint to get an integration blueprint by ID.
- [Update an integration blueprint by ID](https://developer.oneflow.com/reference/update-an-integration-blueprint-by-id-1.md): Use this endpoint to update an integration blueprint by ID.
- [Delete an integration blueprint by ID](https://developer.oneflow.com/reference/delete-an-integration-blueprint-by-id-1.md): Use this endpoint to delete an integration blueprint by ID.
- [Create an integration blueprint field](https://developer.oneflow.com/reference/create-an-integration-blueprint-field.md): Use this endpoint to create an integration blueprint field in the specified integration blueprint.
- [Update integration blueprint fields](https://developer.oneflow.com/reference/update-integration-blueprint-fields.md): Use this endpoint to update integration blueprint fields related to the specified integration blueprint.
- [Get integration blueprint fields](https://developer.oneflow.com/reference/get-integration-blueprint-fields.md): Use this endpoint to get a list of integration blueprint fields related to the specified integration blueprint.
- [Update an integration blueprint field by ID](https://developer.oneflow.com/reference/update-an-integration-blueprint-field-by-id.md): Use this endpoint to update an integration blueprint field related to the specified integration blueprint.
- [Delete an integration blueprint field by ID](https://developer.oneflow.com/reference/delete-an-integration-blueprint-field-by-id-1.md): Use this endpoint to delete an integration blueprint field related to the specified integration blueprint.
- [Get playbooks](https://developer.oneflow.com/reference/get-playbooks.md): Use this endpoint to get a list of playbooks.
- [Get ServiceProviderConfig](https://developer.oneflow.com/reference/get-serviceproviderconfig.md): Use this endpoint to get SCIM ServiceProviderConfig.
- [List Resource Types](https://developer.oneflow.com/reference/list-resource-types.md): Use this endpoint to get a list of resource types supported by the SCIM server.
- [List Schemas](https://developer.oneflow.com/reference/list-schemas.md): Use this endpoint to get a list of resource type schemas supported by the SCIM server.
- [Get schema by URN](https://developer.oneflow.com/reference/get-schema-by-urn.md): Use this endpoint to get the resource type schema corresponding to the provided URN.
- [Get Group](https://developer.oneflow.com/reference/get-group.md): Use this endpoint to retrieve a specific group by its ID.
- [Update Group](https://developer.oneflow.com/reference/update-group.md): Use this endpoint to update a group. See [Group](doc:data-model#group) for more information.
- [Delete Group](https://developer.oneflow.com/reference/delete-group.md): Use this endpoint to delete a specific group by its ID.
- [Patch Group](https://developer.oneflow.com/reference/patch-group.md): Use this endpoint to update one or more attributes of a group.
- [List Groups](https://developer.oneflow.com/reference/list-groups.md): Use this endpoint to get the list of groups.
- [Create Group](https://developer.oneflow.com/reference/create-group.md): Use this endpoint to create a group. See [Group](doc:data-model#group) for more information.
- [Get User](https://developer.oneflow.com/reference/get-user.md): Use this endpoint to retrieve a specific user by its ID.
- [Update User](https://developer.oneflow.com/reference/update-user.md): Use this endpoint to update a user. See [User](doc:data-model#user) for more information.
- [Patch User](https://developer.oneflow.com/reference/patch-user.md): Use this endpoint to update one or more attributes of a user.
- [Create User](https://developer.oneflow.com/reference/create-user.md): Use this endpoint to create a user. See [User](doc:data-model#user) for more information.
- [List Users](https://developer.oneflow.com/reference/list-users.md): Use this endpoint to get the list of users.