# Platform Documentation > Documentation for Platform ## API Reference: Overview - [About Conga Advantage Platform](https://developer.conga.com/platform/reference/about-conga-revenue-lifecycle-solution.md) - [REST API Introduction](https://developer.conga.com/platform/reference/rest-api-introduction.md) - [Authentication](https://developer.conga.com/platform/reference/authentication.md) ## API Reference: User Management - User Admin - [Create a user](https://developer.conga.com/platform/reference/post_api-user-management-v1-users.md): Creates a new user and returns the user's ID. - [Get all users](https://developer.conga.com/platform/reference/get_api-user-management-v1-users.md): Returns all users that meet the criteria. - [Create multiple users](https://developer.conga.com/platform/reference/post_api-user-management-v1-users-bulk.md): Creates multiple users and returns their IDs.
**Note**:
**Note**: Bulk user updation is not supported for the `Integration` user type.
- [Update a user](https://developer.conga.com/platform/reference/patch_api-user-management-v1-users-userid-1.md): Updates the user information for a specific user. - [Deactivate a user](https://developer.conga.com/platform/reference/delete_api-user-management-v1-users-userid.md): Deactivates a user and returns status. - [Get user details by user ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-users-userid.md): Returns the details of a user based on the user ID. - [Upload users](https://developer.conga.com/platform/reference/post_api-user-management-v1-users-upload.md): Accepts a .csv file containing user records as input, creates users, and returns the IDs for all newly created users.**Note**:
**Note**: User clone is not supported for the `Integration` user type.
- [Restore a deactivated user](https://developer.conga.com/platform/reference/put_api-user-management-v1-users-userid-restore.md): Based on the user ID, restores the user (if deactivated) and sends the message to auth. - [Get CSV format for user upload](https://developer.conga.com/platform/reference/get_api-user-management-v1-users-templates-download.md): Fetches the most recent user metadata, generates a .csv file with all of the user fields, and returns a template for uploading users for download. - [Get a user's role](https://developer.conga.com/platform/reference/get_api-user-management-v1-users-userid-roles.md): Retrieves a user's role based on the user ID and returns the status as the role name. - [Check if a user is assigned a role](https://developer.conga.com/platform/reference/get_api-user-management-v1-users-userid-roles-roleid-exists.md): Using a user ID and a role ID, returns true or false depending on whether the user is assigned a role or not. - [Update a user's role](https://developer.conga.com/platform/reference/put_api-user-management-v1-users-userid-roles-roleid.md): Updates a user's role based on the user ID and role ID passed in. - [Assign permission group to a user](https://developer.conga.com/platform/reference/put_api-user-management-v1-users-userid-permissiongroups.md): Appends the permission group name to the provided user's current permission groups and returns the updatedUser object. - [Delete permission groups from a user](https://developer.conga.com/platform/reference/delete_api-user-management-v1-users-userid-permissiongroups-1.md): Removes the permission group names from the provided user's current permission groups and returns the updatedUser object along with error messages for invalid records. - [Create and update multiple users](https://developer.conga.com/platform/reference/put_api-user-management-v1-users-bulk-upsert-1.md): Creates and updates multiple users and returns the IDs of the users.**Note**: If a user already exists (based on a Platform user record identifier), the API will update the existing user instead… - [Re-send welcome email to new user](https://developer.conga.com/platform/reference/post_api-user-management-v1-users-userid-send-welcome-email-1.md): The system sends every new user a welcome email with login details. If a user is created with an incorrect email address entry, the welcome email cannot reach its intended recipient. In such… - [Get integration user's client ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-users-integrationuserid-secret-1.md): Retrieves integration user's client ID based on the user ID. - [Generate integration user secret](https://developer.conga.com/platform/reference/patch_api-user-management-v1-users-integrationuserid-secret-1.md): Generates the **Secret** for the provided integration user ID and returns the Client ID and Client Secret. - [Create and update multiple users synchronously](https://developer.conga.com/platform/reference/put_api-user-management-v1-users-bulk-upsert-sync.md): Creates and updates multiple users and returns the IDs of the users synchronously.
**Note**: If a user already exists (based on a Platform user record identifier), the API will update the existing… - User Group - [Create a user group](https://developer.conga.com/platform/reference/post_api-user-management-v1-user-groups-1.md): Creates a new user group and returns the user group's ID. - [Get filtered user groups](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-groups-1.md): Returns all user groups that meet the criteria. - [Update a user group](https://developer.conga.com/platform/reference/put_api-user-management-v1-user-groups-usergroupid-1.md): Updates the user group information for a specific group. - [Delete a user group](https://developer.conga.com/platform/reference/delete_api-user-management-v1-user-groups-usergroupid-1.md): Deletes a user group and returns status. - [Get user group details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-groups-usergroupid-1.md): Returns the details of a user group based on the user group ID. - [Create and update multiple user groups](https://developer.conga.com/platform/reference/put_api-user-management-v1-user-groups-bulk-upsert-usergroups-1.md): Creates and updates multiple user groups and returns the ids of the user groups created and updated.
**Note**: If a user group already exists (based on a Platform user record identifier), the API… - User Group Member - [Create a user group member](https://developer.conga.com/platform/reference/post_api-user-management-v1-user-groups-usergroupid-members-memberid-1.md): Adds a new member to the group and returns the ID of the newly added member. - [Delete a user group member](https://developer.conga.com/platform/reference/delete_api-user-management-v1-user-groups-usergroupid-members-memberid-1.md): Deletes a user group member and returns status. - [Create user group members in bulk](https://developer.conga.com/platform/reference/post_api-user-management-v1-user-groups-bulk-create-usergroupmembers-1.md): Adds new members to user groups and returns the IDs of the newly added members. - [Get all user group members by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-groups-usergroupid-members-1.md): Returns all user group members that meet the criteria. - [Get user group member details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-groups-members-usergroupmemberid-1.md): Returns the details of a user group member based on the user group member ID. - [Get all user group members](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-groups-members-1.md): Returns all user group members that meet the criteria. - Role Admin - [Create a new role](https://developer.conga.com/platform/reference/post_api-user-management-v1-roles.md): Creates a new role and returns the role's ID. - [Get all roles](https://developer.conga.com/platform/reference/get_api-user-management-v1-roles.md): Returns all roles that meet the criteria. - [Create multiple roles](https://developer.conga.com/platform/reference/post_api-user-management-v1-roles-bulk.md): Creates multiple roles and returns their IDs. - [Update a role](https://developer.conga.com/platform/reference/put_api-user-management-v1-roles-roleid.md): Updates the name and description of the provided role ID. - [Delete a role](https://developer.conga.com/platform/reference/delete_api-user-management-v1-roles-roleid.md): Deletes the role with the given role ID and returns the status. - [Get role information by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-roles-roleid.md): Returns the details of a role based on the role ID. - [Check whether the role exists](https://developer.conga.com/platform/reference/get_api-user-management-v1-roles-roleid-exists.md): Uses the role ID as an input to check whether the role exists. - [Assign permission groups to a role](https://developer.conga.com/platform/reference/put_api-user-management-v1-roles-roleid-permissiongroups.md): Appends the permission group names to the provided role's current permission groups and returns the updated role. - [Delete permission groups from a role](https://developer.conga.com/platform/reference/delete_api-user-management-v1-roles-roleid-permissiongroups-1.md): Removes the permission group names from the provided role's current permission groups and returns the updated role along with error messages for invalid records. - [Clone a role](https://developer.conga.com/platform/reference/post_api-user-management-v1-roles-roleid-clone.md): Clones the role based on the role ID and returns the cloned role's ID. - [Assign admin permissions to a role](https://developer.conga.com/platform/reference/put_api-user-management-v1-roles-roleid-admin-permissions-1.md): Appends the admin permission to the provided role's current admin permissions and returns the updated role. - [Delete admin permissions from a role](https://developer.conga.com/platform/reference/delete_api-user-management-v1-roles-roleid-admin-permissions-1.md): Removes the admin permissions from the provided role's current admin permissions and returns the updated role. - Admin Permissions - [Get the master list of admin permissions](https://developer.conga.com/platform/reference/get_api-user-management-v1-admin-permissions-1.md): Returns the master list of admin permissions from the data storage. - Permission Groups - [Get the master list of permission groups](https://developer.conga.com/platform/reference/get_api-user-management-v1-permissiongroups.md): Returns the master list of permission groups from data storage. - [Add permission group names to the master list](https://developer.conga.com/platform/reference/post_api-user-management-v1-permissiongroups.md): Adds permission group names to the master list and returns the updated list of permission groups. - [Delete permission groups](https://developer.conga.com/platform/reference/delete_api-user-management-v1-permissiongroups.md): Removes permission group names from the stored master list, as well as any associated object, action, or scope permissions granted to that permission group if no user or role is associated with it,… - [Clone the permission group](https://developer.conga.com/platform/reference/post_api-user-management-v1-permissiongroups-permissiongroupname-clone-1.md): Clones the permission group (Object Permissions and Scopes Permissions) by passing the existing permission group as a parameter and the permission group information in the request body. - [Get applicable objects for contact scope in a permission group](https://developer.conga.com/platform/reference/get_api-user-management-v1-permissiongroups-permissiongroupname-contact-scope-applicable-objects.md): Returns all objects applicable for contact scope in the specified permission group — primary objects and any object that has a lookup or reference field pointing to a primary object — filtered by the… - Organization - [Update organizational information](https://developer.conga.com/platform/reference/patch_api-user-management-v1-organization-info.md): Updates an organization's sitewide information, like number, date, and currency formats. - [Get an organization's information](https://developer.conga.com/platform/reference/get_api-user-management-v1-organization-info.md): Returns an organization's sitewide information, like number, date, and currency formats. - [Get the locale](https://developer.conga.com/platform/reference/get_api-user-management-v1-organization-locale.md): Returns the organization's locale. - [Get the time zone](https://developer.conga.com/platform/reference/get_api-user-management-v1-organization-timezone.md): Returns the organization's time zone. - [Get the currency type](https://developer.conga.com/platform/reference/get_api-user-management-v1-organization-currency.md): Returns the organization's currency. - Organization External Integration - [Add external identifiers](https://developer.conga.com/platform/reference/post_api-user-management-v1-integrations-externalintegrationid-1.md): Add an organization's external integration identifiers. - [Remove external identifiers](https://developer.conga.com/platform/reference/delete_api-user-management-v1-integrations-externalintegrationid.md): Updates an organization's external integration and removes external identifiers. - [Get external identifiers](https://developer.conga.com/platform/reference/get_api-user-management-v1-integrations-externalintegrationid.md): Returns the external identifiers of an external integration. - [Update external identifiers](https://developer.conga.com/platform/reference/put_api-user-management-v1-integrations-externalintegrationid.md): Updates an organization's external integration identifiers. - [Get all identity providers (IdPs)](https://developer.conga.com/platform/reference/get_api-user-management-v1-integrations-identity-providers-1.md): Retrieves all identity providers. - [Add an external identifier](https://developer.conga.com/platform/reference/post_api-user-management-v1-integrations-1.md): Add an organization's external integration identifier. - [Update external identifiers](https://developer.conga.com/platform/reference/put_api-user-management-v1-integrations-1.md): Updates an organization's external integration identifiers. - [Delete external identifiers](https://developer.conga.com/platform/reference/delete_api-user-management-v1-integrations-1.md): Deletes external identifiers. - [Get a list of external integration identifiers](https://developer.conga.com/platform/reference/get_api-user-management-v1-integrations-1.md): Returns all external integration identifiers that meet the specified criteria, with support for sorting and pagination. - [Update an external integration identifier](https://developer.conga.com/platform/reference/patch_api-user-management-v1-integrations-id-1.md): Updates an organization's external integration identifier. - API Connections - [Add API connection](https://developer.conga.com/platform/reference/post_api-user-management-v1-api-connections-externalidentifier-1.md): Adds API connection. - [Update API connection](https://developer.conga.com/platform/reference/put_api-user-management-v1-api-connections-externalidentifier-1.md): Updates API connection. - [Get API connections](https://developer.conga.com/platform/reference/get_api-user-management-v1-api-connections-externalidentifier.md): Retrieves API connections based on the API connection type selected. - [Get all API connections](https://developer.conga.com/platform/reference/get_api-user-management-v1-api-connections.md): Retrieves all API connections. - [Update API connection status](https://developer.conga.com/platform/reference/put_api-user-management-v1-api-connections-externalidentifier-status.md): Updates the status of the API connection. - Guest User - [Create a guest user](https://developer.conga.com/platform/reference/post_api-user-management-v1-user-guest-1.md): Creates a guest user and returns the guest user's ID. - [Update a guest user](https://developer.conga.com/platform/reference/put_api-user-management-v1-user-guest-userid-1.md): Updates the user information for a specific guest user. - [Deactivate a guest user](https://developer.conga.com/platform/reference/delete_api-user-management-v1-user-guest-userid-1.md): Deactivates a guest user and returns the status. - [Restore a deactivated guest user](https://developer.conga.com/platform/reference/put_api-user-management-v1-user-guest-userid-restore-1.md): Based on the guest user ID, restores a guest user (if deactivated) and sends the message to auth. - [Register storefront](https://developer.conga.com/platform/reference/patch_api-user-management-v1-user-guest-storefront-1.md): Updates the mapping between a guest user and a storefront, including storefront type and URL. - Contact Users - [Create a contact user and a mapping between user and contact object](https://developer.conga.com/platform/reference/post_api-user-management-v1-contact-users.md) - [Update a contact user](https://developer.conga.com/platform/reference/put_api-user-management-v1-contact-users-userid.md) - [Deactivate a contact user](https://developer.conga.com/platform/reference/delete_api-user-management-v1-contact-users-userid.md) - [Reactivate a contact user](https://developer.conga.com/platform/reference/put_api-user-management-v1-contact-users-userid-restore.md) - Field Permission - [Set field permissions](https://developer.conga.com/platform/reference/post_api-user-management-v1-field-permissions-1.md): Sets field permissions and returns a unique identifier (ID). - [Get the field permission details by object and permission group name](https://developer.conga.com/platform/reference/get_api-user-management-v1-field-permissions-1.md): Fetches the field permission details for the given object and permission group name. - [Update a field permission for a given permission group and object](https://developer.conga.com/platform/reference/put_api-user-management-v1-field-permissions-1.md): Updates a field permission for a given permission group and object, and returns the updated field permission details. - [Delete a field permission by permission group and object](https://developer.conga.com/platform/reference/delete_api-user-management-v1-field-permissions-1.md): Deletes a field permission from the given permission group and object. - [Set multiple field permissions](https://developer.conga.com/platform/reference/post_api-user-management-v1-field-permissions-bulk-1.md): Sets multiple field permissions and returns their respective unique identifiers (ID). - [Get the field permission details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-field-permissions-fieldpermissionid-1.md): Fetches the field permission details based on the field permission ID. - [Update a field permission](https://developer.conga.com/platform/reference/put_api-user-management-v1-field-permissions-fieldpermissionid-1.md): Updates a field permission and returns the updated field permission details. - [Delete a field permission by ID](https://developer.conga.com/platform/reference/delete_api-user-management-v1-field-permissions-fieldpermissionid-1.md): Deletes a field permission for the given field permission ID. - Object Permission - [Create a new object permission](https://developer.conga.com/platform/reference/post_api-user-management-v1-objectpermissions.md): Creates a new object permission and returns the object permission's ID. - [Get all object permissions](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions.md): Returns all object permissions that meet the criteria. - [Create multiple object permissions](https://developer.conga.com/platform/reference/post_api-user-management-v1-objectpermissions-bulk.md): Creates multiple object permissions and returns their IDs. - [Delete multiple object permission records](https://developer.conga.com/platform/reference/delete_api-user-management-v1-objectpermissions-bulk.md): Removes multiple object permission records and returns a list of the deleted object permission's IDs as well as error messages for invalid records. - [Get object permission details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions-objectpermissionid.md): Fetches the object permission details based on the object permission ID. - [Update an object permission](https://developer.conga.com/platform/reference/put_api-user-management-v1-objectpermissions-objectpermissionid.md): Updates an object permission and returns updated object permission details. - [Delete an object permission](https://developer.conga.com/platform/reference/delete_api-user-management-v1-objectpermissions-objectpermissionid.md): Removes an object permission and returns the deleted object permission's ID. - [Validate object action permission](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions-objectname-actionpermissions-actionname-validate.md): Based on the object name and action name, validates whether the object has action permission. - [Get object permission details by object name](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions-objects-objectname.md): Fetches the object permission details for the provided object name. - [List all object names for object permissions](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions-objects-1.md): Fetches and lists all objects for object permissions and returns `OK` when the request is executed. - [Get primary objects for contact scope](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions-contact-scope-primary-objects.md): Returns the list of primary objects supported for contact scope, filtered by the current user's object permissions. - Property Permission - [Upsert a new property permission](https://developer.conga.com/platform/reference/put_api-user-management-v1-property-permissions-permissiongroupname-propertyname-1.md): Upserts a new property permission - [Get property permissions By permissionGroupName and propertyName](https://developer.conga.com/platform/reference/get_api-user-management-v1-property-permissions-permissiongroupname-propertyname-1.md): Retrieves property permissions based on permissionGroupName and propertyName. - [Delete a Property Permission](https://developer.conga.com/platform/reference/delete_api-user-management-v1-property-permissions-permissiongroupname-propertyname-1.md): Removes Property Permission for given permissionGroupName and propertyName - [Get property objects for a given permissionGroupName](https://developer.conga.com/platform/reference/get_api-user-management-v1-property-permissions-permissiongroupname-propertyobjects-1.md): Retrieves property objects based on the PermissionGroupName. - Record Type Permission - [Set a record type's permission](https://developer.conga.com/platform/reference/post_api-user-management-v1-recordtype-permissions-1.md): Sets a record type's permission and returns its unique identifier (ID). - [Update a record type's permission for a given permission group and object](https://developer.conga.com/platform/reference/put_api-user-management-v1-recordtype-permissions-1.md): Updates a record type's permission for a given permission group and object, and returns the updated record type permission details. - [Set multiple record type permissions](https://developer.conga.com/platform/reference/post_api-user-management-v1-recordtype-permissions-bulk-1.md): Sets multiple record type permissions and returns their unique identifiers (ID). - [Get the record type permission details by object and permission group name](https://developer.conga.com/platform/reference/get_api-user-management-v1-recordtype-permissions-permissiongroupname-objectname-1.md): Fetches the record type permission details based on the object and permission group name. - [Delete a record type's permission by permission group and object](https://developer.conga.com/platform/reference/delete_api-user-management-v1-recordtype-permissions-permissiongroupname-objectname-1.md): Removes a record type's permission from the given permission group and object. - [Get the record type permission details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-recordtype-permissions-recordtypepermissionid-1.md): Fetches the record type permission details based on the record type permission ID. - [Update a record type's permission](https://developer.conga.com/platform/reference/put_api-user-management-v1-recordtype-permissions-recordtypepermissionid-1.md): Updates a record type's permission and returns the updated record type permission details. - [Delete a record type's permission by ID](https://developer.conga.com/platform/reference/delete_api-user-management-v1-recordtype-permissions-recordtypepermissionid-1.md): Removes a record type's permission for the given record type permission ID. - Action Permissions - [Get the master list of all action permissions](https://developer.conga.com/platform/reference/get_api-user-management-v1-actionpermissions.md): Retrieves the master list of action permissions from the data storage. - User - [Get logged-in user information](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-info.md): Returns information about the current logged-in user.
**Note**: If the locale, currency, and time zone information are not available at the user level, this endpoint retrieves them from the… - [Get logged-in user's locale](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-locale.md): Returns the locale information for the current logged-in user. - [Get logged-in user's time zone](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-timezone.md): Returns time zone information for the current logged-in user. - [Get logged-in user's currency](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-currency.md): Returns currency information for the current logged-in user. - [Get logged-in user's currency format](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-currency-format-1.md): Returns currency format information for the current logged-in user. - [Get all action permissions for the current user](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-actionpermissions.md): Returns a list of all object action permissions available for the current user. - [Get action permissions by object name](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-objects-objectname-actionpermissions-1.md): Retrieves the details of action permissions on the object name. - [Get bulk action permissions](https://developer.conga.com/platform/reference/post_api-user-management-v1-user-objects-actionpermissions-1.md): Retrieves the details of action permissions on the object names. - [Get record type permission details by object name](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-objects-objectname-recordtypes-1.md): Fetches the record type permission details based on the object name. - [Get field permission details by object name](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-objects-objectname-field-permissions-1.md): Fetches the field permission details based on the object name. - [Get field permission details by field name on given object](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-objects-objectname-field-permissions-fields-fieldname-1.md): Fetches the field permission details based on the field name on given object. - [Get users with full access on given objects](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-object-access-users-1.md): Fetches users who have full access on all objects passed as input. - [Get accessible property values of property object by object name and action type](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-objects-objectname-property-permissions-propertyname-actionname.md): Returns a list of property values that the current user can access for the specified property on the given object with the specified action type. - [Update a user's UI settings](https://developer.conga.com/platform/reference/patch_api-user-management-v1-user-userid-ui-settings.md): Updates a user's UI settings based on the user ID and the provided settings. - Role - [Get all roles](https://developer.conga.com/platform/reference/get_api-user-management-v1-runtime-roles-1.md): Returns all roles that meet the criteria. - Timezone and Locale - [Get all time zones](https://developer.conga.com/platform/reference/get_api-user-management-v1-timezones.md): Retrieves all time zones. - [Get all locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-locales.md): Retrieves all locales. - [Get all decimal symbols from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-decimal-symbols-1.md): Retrieves all decimal symbols from locales. - [Get all digit grouping symbols from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-digitgrouping-symbols-1.md): Retrieves all digit grouping symbols from locales. - [Get all long date formats from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-longdate-formats-1.md): Retrieves all long date formats from locales. - [Get all short date formats from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-shortdate-formats-1.md): Retrieves all short date formats from locales. - [Get all time formats from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-time-formats-1.md): Retrieves all time formats from locales. - [Get all digit groups from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-digitgroups-1.md): Retrieves all digit groups from locales. - [Get all negative number formats from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-negativenumber-formats-1.md): Retrieves all negative number formats from locales. - Currency Format - [Get all currency formats](https://developer.conga.com/platform/reference/get_api-user-management-v1-currency-formats-1.md): Retrieves all currency formats based on the provided format type. - Grant Login - [Create a Grant Login Request](https://developer.conga.com/platform/reference/post_api-user-management-v1-grantlogin-1.md): Creates a Grant Login Request and returns its unique identifier (ID). - [Get all Grant Login Requests](https://developer.conga.com/platform/reference/get_api-user-management-v1-grantlogin-1.md): Returns all grant logins that meet the criteria. - [Cancel Grant Login Request](https://developer.conga.com/platform/reference/put_api-user-management-v1-grantlogin-grantloginid-1.md): Cancels the Grant Login Request and returns status. - [Get the grant login details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-grantlogin-grantloginid-1.md): Fetches the grant login details based on the grant login ID. - [Get Access durations](https://developer.conga.com/platform/reference/get_api-user-management-v1-grantlogin-durations-1.md): Retrieves all Access Durations available. ## API Reference: Schema Manager - Object Definition - [Define a new object schema](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-1.md): Validates and creates an object schema definition. - [List all object names](https://developer.conga.com/platform/reference/get_api-schema-v1-objects-1.md): Fetches and lists all metadata and returns `OK` when the request is executed. - [Update a schema definition](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-1.md): Validates and updates an object's schema definition. - [Get a translated schema definition](https://developer.conga.com/platform/reference/get_api-schema-v1-objects-objectname-1.md): Validates and fetches a given object's schema definition. - [Set an object's shared status](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-shared-isshared-1.md): Sets the IsShared field for the given object to indicate whether the object is shareable. - [Deprecate an object](https://developer.conga.com/platform/reference/patch_api-schema-v1-objects-objectname-deprecate-1.md): Deprecates the object in the metadata, accepting the object name as input and setting it to be deprecated. - [Import custom schema](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-customschema-import-1.md): Imports schema for custom fields and custom objects.
**Note:** The custom field is deleted only if it contains no data in any of the records.
- [Update an object's field definition](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-fields-fieldname-1.md): Validates and updates the field definitions available in the specified object. - [Set the field to deprecate](https://developer.conga.com/platform/reference/patch_api-schema-v1-objects-objectname-fields-fieldname-deprecate-1.md): Validates the field of the given object and sets it to be deprecated. - [Validate formula field expression](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-fields-fieldname-expression-validate-1.md): Validates the formula field expression of the field of the given object. - [Get the list of formula functions](https://developer.conga.com/platform/reference/get_api-schema-v1-objects-formula-functions-1.md): Retrieves the list of formula functions from data storage. - Index Definition - [Index a field](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-indexes-1.md): Validates and enables the "IsIndexField" field value to true for a field in a given object. - [Delete an existing index](https://developer.conga.com/platform/reference/delete_api-schema-v1-objects-objectname-indexes-indexfieldname-1.md): Validates and sets the "IsIndexField" field value to false for a field in a given object. - Picklist Definition - [Create a new picklist](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-picklists-1.md): Validates and creates a new picklist metadata for the given object. - [Rename a picklist](https://developer.conga.com/platform/reference/patch_api-schema-v1-objects-objectname-picklists-rename-1.md): Validates and renames the picklist for the given object and picklist and returns 'OK' when the request is executed. - [Update a picklist](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-picklists-picklistname-1.md): Validates and updates the picklist for the given object and picklist and returns 'OK' when the request is executed. - [Create a new picklist entry](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-picklists-picklistname-picklist-entries-1.md): Validates and creates a picklist entry for the given picklist and object. - [Update a picklist entry by value](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-picklists-picklistname-picklist-entries-picklistentryvalue-1.md): Validates and updates the picklist value details for the given picklist and object. - [Create picklist entries by value](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-picklists-picklistname-picklist-entries-bulk-1.md): Validates and updates the picklist value details for the given picklist and object. - [Update picklist entries by value](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-picklists-picklistname-picklist-entries-bulk-1.md): Validates and updates the picklist value details for the given picklist and object. - Dependent Picklist Definition - [Get the dependent picklist](https://developer.conga.com/platform/reference/get_api-schema-v1-objects-objectname-fields-fieldname-dependent-picklists-1.md): Validates and fetches the dependent picklist metadata for the given dependent field name and object. - [Create a new dependent picklist mapping](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-fields-fieldname-dependent-picklists-1.md): Validates and creates a new dependent picklist mapping for the given dependent field name and object. - [Update the dependent picklist](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-fields-fieldname-dependent-picklists-1.md): Validates and updates the dependent picklist metadata for the given dependent field name and object. - [Delete the dependent picklist](https://developer.conga.com/platform/reference/delete_api-schema-v1-objects-objectname-fields-fieldname-dependent-picklists-1.md): Validates and removes the dependent picklist metadata for the given dependent field and object. - RecordType Definition - [Create a record type picklist entry](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-recordtype-entries-1.md): Validates and creates a picklist entry (value detail) for a given object's record type. - [Update record type picklist entries](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-recordtype-entries-bulk-1.md): Validates and updates the picklist entries (value details) for a given object's record type. - Complex Field Definition - [Create new complex field metadata](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-complex-fields-1.md): Validates and creates metadata for complex fields. - [Create a new complex field](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-complex-field-complexfieldmetadataname-1.md): Validates and creates a complex field for the given complex field metadata. - [Update an object's complex field definition](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-complex-field-complexfieldmetadataname-1.md): Validates and updates the complex field definition for the given complex field metadata and object. - [Create complex fields](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-complex-fields-complexfieldmetadataname-1.md): Validates and creates multiple complex fields for the given complex field metadata. - Object Definition Translation - [Define the translation](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-translations-locale-1.md): Defines the translation for the given object and language-region combination. - [Update translation](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-translations-locale-1.md): Updates translation for the given object. - [Get translation](https://developer.conga.com/platform/reference/get_api-schema-v1-objects-objectname-translations-locale-1.md): Retrieves a translation for the given object. - [Delete translation](https://developer.conga.com/platform/reference/delete_api-schema-v1-objects-objectname-translations-locale-1.md): Deletes the translation for the given object and locale. - Object Metadata - [Get a schema definition](https://developer.conga.com/platform/reference/get_api-metadata-v1-objects-objectname-1.md): Validates and retrieves an object's metadata at runtime. - [Export custom schema](https://developer.conga.com/platform/reference/post_api-metadata-v1-objects-customschema-export-1.md): For the object(s) passed in the request body, exports a schema (zipped, with a JSON file for each object) for custom fields and custom objects. This exports:**Note**: Upload a Zip file containg list of configurations.
- [Get configuration categories](https://developer.conga.com/platform/reference/get_api-config-management-v1-configurations-categories-1.md): Fetches all configuration categories. ## API Reference: Email - Email Template - [Render an email template](https://developer.conga.com/platform/reference/post_api-email-v1-email-templates-id-render.md): Fetches the email template information based on the email template ID and template render request. - [Render an unsaved email template](https://developer.conga.com/platform/reference/post_api-email-v1-email-templates-render-1.md): Fetches the email template information based on the template render request. This API allows you to see a preview of an unsaved email template. - [Create an email template](https://developer.conga.com/platform/reference/post_api-email-v1-email-templates.md): Creates an email template based on the information passed in the request body. - [Get the list of email templates based on filter and sort criteria](https://developer.conga.com/platform/reference/get_api-email-v1-email-templates.md): Returns a list of email templates filtered by access type or category, with support for sorting and pagination. - [Create a template attachment for a given template ID](https://developer.conga.com/platform/reference/post_api-email-v1-email-templates-id-1.md): Creates a template attachment for the given template ID based on the email attachment information passed in the request body. - [Get an email template by ID](https://developer.conga.com/platform/reference/get_api-email-v1-email-templates-id.md): Retrieves the email template based on the email template ID. - [Update an email template](https://developer.conga.com/platform/reference/put_api-email-v1-email-templates-id.md): Updates the email template based on the email template ID and updated email template information. - [Delete an email template](https://developer.conga.com/platform/reference/delete_api-email-v1-email-templates-id.md): Removes the email template based on the email template ID. - [Delete a template attachment for a given template ID](https://developer.conga.com/platform/reference/delete_api-email-v1-email-templates-id-filename-delete-1.md): Removes the template attachment for the given email template ID based on the file name. - [Delete all template attachments for a given template id at once](https://developer.conga.com/platform/reference/delete_api-email-v1-email-templates-id-delete-1.md): Removes all template attachments for the given email template ID. - [Get the list of email templates based on search criteria](https://developer.conga.com/platform/reference/get_api-email-v1-email-templates-search.md): Returns a list of email templates that match the specified search criteria, with support for sorting and pagination. - [Clone the email template](https://developer.conga.com/platform/reference/post_api-email-v1-email-templates-id-clone.md): Clones the email template based on the email template ID, with a new email template ID. When setAsDefault is true, the cloned template inherits the default product associations from the source and… - Email Template Category - [Create an email template category](https://developer.conga.com/platform/reference/post_api-email-v1-email-template-categories.md): Validates and creates an email template category. - [Get the list of email template categories](https://developer.conga.com/platform/reference/get_api-email-v1-email-template-categories.md): Returns the list of email template categories. - [Get an email template category by ID](https://developer.conga.com/platform/reference/get_api-email-v1-email-template-categories-id.md): Validates and retrieves the email template category based on the email template category ID. - [Update an email template category](https://developer.conga.com/platform/reference/put_api-email-v1-email-template-categories-id.md): Validates and updates the email template category based on the email template category ID. - [Delete the email template category](https://developer.conga.com/platform/reference/delete_api-email-v1-email-template-categories-id.md): Removes the email template category based on the email template category ID. - Email Sender - [Send an email](https://developer.conga.com/platform/reference/post_api-email-v1-emails.md): Validates and sends an email based on the information provided in the request body and returns a status code in response. - [Send bulk/mass email](https://developer.conga.com/platform/reference/post_api-email-v1-emails-bulk.md): Validates and sends bulk emails based on the information provided in the request body and returns a status code in response. - [Verify an email domain](https://developer.conga.com/platform/reference/get_api-email-v1-emails-domain-verify.md): Checks whether the given domain/subdomain is registered and can be used for sending emails. - [Send bulk/mass email using the v2 contract.](https://developer.conga.com/platform/reference/post_api-email-v2-emails-bulk.md) - [Invalidate an email domain verification cache entry.](https://developer.conga.com/platform/reference/delete_api-email-v1-emails-domain-invalidate.md): Clears the persisted and runtime verification state for the given domain/subdomain so the next lookup is fetched fresh. - Email Profile - [Create a new email profile](https://developer.conga.com/platform/reference/post_api-email-v1-email-profiles.md): Validates and creates a new email profile. - [Update an email profile](https://developer.conga.com/platform/reference/put_api-email-v1-email-profiles-name.md): Validates and updates the email profile based on the email profile Name. - [Delete the email profile](https://developer.conga.com/platform/reference/delete_api-email-v1-email-profiles-name.md): Removes the email profile based on the email profile name. - [Get an email profile by name](https://developer.conga.com/platform/reference/get_api-email-v1-email-profiles-name.md): Validates and retrieves the email profile based on the email profile name. - Email Delivery Status - [Email Status by EmailSendId and Recipients](https://developer.conga.com/platform/reference/post_api-email-v1-emails-status-batch.md): Fetches delivery status based on EmailSendId and Recipients. - [Get delivery status of an email by JobId](https://developer.conga.com/platform/reference/get_api-email-v1-emails-jobs-jobid.md): Fetches delivery status based on JobId. ## API Reference: Localization - Translations Management Admin - [Automatically translate the schema of an object based on the provided metadata and target locale(s)](https://developer.conga.com/platform/reference/post_api-localization-admin-v1-translations-schema-auto-translate.md): This endpoint processes the given object metadata and generates translations for all translatable elements such as display names, descriptions, and field labels. The operation is executed… - [Automatically translate a set of text key-value pairs into the specified target locales](https://developer.conga.com/platform/reference/post_api-localization-admin-v1-translations-text-auto-translate.md): This endpoint processes the given text data and generates translations for target locales. - [Retrieve all defined translation modules for the specified translation type](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations-modules.md) - [Retrieve a paginated list of translations for a given Type(String/Schema), with optional locale, module, search and filtering](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations.md) - [Retrieve the total count of translations for a given type, with optional locale, module, and search filtering](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations-type-count.md) - [Retrieve translations using a cursor-based approach for a given type, with optional locale, module, and search filtering](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations-type.md) - [Bulk create translations for a specific locale](https://developer.conga.com/platform/reference/post_api-localization-admin-v1-translations-locales-locale.md) - [Bulk update translations for a specific locale](https://developer.conga.com/platform/reference/put_api-localization-admin-v1-translations-locales-locale.md) - [Bulk delete translations for a specific locale](https://developer.conga.com/platform/reference/delete_api-localization-admin-v1-translations-locales-locale.md) - [Configure locales in Organization Locales configuration](https://developer.conga.com/platform/reference/put_api-localization-admin-v1-translations-organization-locales.md) - [Get the current Organization Locales configuration](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations-organization-locales.md) - [Get the current Organization Locales Change Tracking Info](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations-organization-locales-tracking-trackingid-status.md) - [Export translations for the specified locale and modules as a CSV file](https://developer.conga.com/platform/reference/post_api-localization-admin-v1-translations-locales-locale-custom-export.md) - [Import translations from a file for the specified locale using the v2 import logic](https://developer.conga.com/platform/reference/post_api-localization-admin-v1-translations-locales-locale-custom-import.md) - Translation Management Runtime - [Get translations for multiple modules (Only supported for String type)](https://developer.conga.com/platform/reference/get_api-localization-v1-translations.md): Returns a dictionary of modules and their translations. - [Get translations for a given keys and modules (Only supported for String type)](https://developer.conga.com/platform/reference/post_api-localization-v1-translations.md): Allows fetching multiple translations in a single request. - Translation Runtime - [Get translated value for the user's locale](https://developer.conga.com/platform/reference/get_api-localization-v1-translations-module-key-1.md): Retrieves the translated value for the given module and key. - [Get translated values for the user's locale](https://developer.conga.com/platform/reference/post_api-localization-v1-translations-module-bulk.md): Retrieves the translated values for the given module and list of keys. - [Get translated values with parameters for the user's locale](https://developer.conga.com/platform/reference/post_api-localization-v1-translations-module-bulk-parameters.md): Retrieves the translated values with parameters for the given module and list of keys. - [Get translated value and user locale](https://developer.conga.com/platform/reference/get_api-localization-v1-translations-module-key-parameters-1.md): Retrieves the translated value based on the input combination (Module, Key, and Parameters) given in the parameters. - [Get translations by Module](https://developer.conga.com/platform/reference/get_api-localization-v1-translations-modules-module-bulk.md): Gets translations for the given module. ## API Reference: Extensibility - Custom Code - [Retrieve custom code by project name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-name.md): Retrieves custom code for the given project name. - [Delete a custom code by name](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-customcode-name-1.md): This endpoint validates and deletes the project Informations based on the name and returns OK response with string result otherwise returns exceptions. - [Enable debug log](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-name-debuglog-1.md): Sets the EnableDebugLog flag for custom code for the given project name. - [Get all custom codes](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode.md): Retrieves all available custom codes and their associated information. - [Execute the custom code](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-execute.md): Executes the custom code. - [Download the project](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-projectname-download.md): Downloads the custom code project with the given project name (in ZIP format). - [Export the Projects or Resources based on the specified Type](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-migration-export-type-1.md): Exports the Projects or Resources based on the given Type parameter. - [Import the Projects or Resources based on the specified Type](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-migration-import-type-1.md): Imports the Projects or Resources based on the given Type parameter. - [Add a trusted API configuration](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-trusted-apis.md): Adds a trusted API configuration and returns the status of the request. - [Get all trusted API configurations](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-apis.md): Retrieves a list of trusted API configurations. - [Update a trusted API configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-customcode-trusted-apis-name.md): Updates a trusted API configuration and returns the status of the request. - [Delete a trusted API configuration](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-customcode-trusted-apis-name.md): Deletes a trusted API configuration and returns the status of the request. - [Retrieve a trusted API configuration by name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-apis-name.md): Fetches trusted API configuration details based on the name. - [Retrieve a trusted API configuration by URI](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-apis-uri.md): Fetches trusted API configuration details based on the URI of the trusted API configuration. - [Retrieve all allowed HTTP verbs](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-apis-allowed-http-verbs.md): Fetches all allowed HTTP verbs. - [Add a trusted object configuration](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-trusted-objects.md): Adds a trusted out-of-the-box (OOTB) object configuration. - [List all trusted object configurations](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-objects.md): Returns a list of trusted out-of-the-box (OOTB) object configurations. - [Update a trusted object configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-customcode-trusted-objects-name.md): Updates an existing trusted out-of-the-box (OOTB) object configuration. - [Delete a trusted object configuration](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-customcode-trusted-objects-name.md): Removes an existing trusted out-of-the-box (OOTB) object configuration. - [Get a trusted object configuration by name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-objects-name.md): Returns the details of an existing trusted out-of-the-box (OOTB) object configuration. - [List allowed operations](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-objects-allowed-operations.md): Returns a list of allowed operations. - [Import project](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-projectname-import.md): Imports custom code project with the given project name. - [Creates or updates a custom code log level override.](https://developer.conga.com/platform/reference/patch_api-extensibility-v1-customcode-log-level.md): Creates a new log level override or updates an existing one for the specified custom code project, class, and method.. - [Retrieves configured log level settings for a custom code project.](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-name-log-levels.md): Returns all configured log level settings for the specified custom code project. - [Retrieves the configured log level setting for a custom code scope.](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-log-level-name.md): Returns the configured log level setting for the specified project, class, and method. - Callback - [Update callback contract mapping](https://developer.conga.com/platform/reference/put_api-extensibility-v1-callbacks.md): Updates the callback contract mapping with custom code project and class. - [Get all callback contracts](https://developer.conga.com/platform/reference/get_api-extensibility-v1-callbacks.md): Retrieves all callback contract and project mapping information for each callback contract. - [Get callback contract details](https://developer.conga.com/platform/reference/get_api-extensibility-v1-callbacks-name.md): Retrieves callback contract details and mapping information based on the module and callback contract names. - [Get callback custom code setting configuration](https://developer.conga.com/platform/reference/get_api-extensibility-v1-callbacks-settings.md): Fetches callback custom code setting configuration details. - [Upsert callback custom code setting configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-callbacks-settings.md): If a callback custom code setting is already configured, it is updated; otherwise, a new one is created. - [Get all modules](https://developer.conga.com/platform/reference/get_api-extensibility-v1-callbacks-modules.md): Retrieves a list of registered callback modules. - [Get all callback contracts by module name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-callbacks-modules-modulename.md): Retrieves callback contract details and project mapping information for each callback contract by module name. - Conga Hooks - [Retrieve a data change rule by name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-datachangerules-name.md): Retrieves the data change rule details for the given name. - [Update a data change rule](https://developer.conga.com/platform/reference/put_api-extensibility-v1-servicehooks-datachangerules-name.md): Validates and updates the data change rule and returns the updated rule information. - [Delete a data change rule](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-servicehooks-datachangerules-name.md): Validates and removes the given data change rule. - [Insert a new data change rule](https://developer.conga.com/platform/reference/post_api-extensibility-v1-servicehooks-datachangerules.md): Validates and inserts the data change rule and returns the rule information. - [Retrieve all data change rules](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-datachangerules.md): Returns data change rules that meet the parameter conditions. - [Retrieve all supported event types in service hook rules](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-datachangerules-supported-event-types-1.md): Fetches all supported event types. - [Get ServiceHooks cancellation token setting configuration](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-datachangerules-cancellation-settings-1.md): Fetches ServiceHooks cancellation token setting configuration details. - [Upsert ServiceHooks cancellation token setting configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-servicehooks-datachangerules-cancellation-settings-1.md): If a cancellation token setting is already configured, it is updated; otherwise, a new one is created. - API Resource - [Resolve a URI](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-api-resource-resolve-1.md): Resolves the API resource's URI entry information. - [Create a new API resource](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-api-resource-1.md): Creates a new API resource. - [Get all API resources](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-api-resource-1.md): Retrieves a list of all API resources. - [Get API resource information by resource name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-api-resource-name-1.md): Retrieves the API resource information for the given API resource name. - [Delete an API resource](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-customcode-api-resource-name-1.md): Validates and removes the API resource information based on the API resource name. - [Clone an API resource](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-api-resource-name-clone-1.md): Clones an existing (source) API resource and its associated URI entry information to a new API resource. - [Create an API resource URI](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-api-resource-name-uri-entries-1.md): Inserts a new API resource URI entry and returns new resource URI entry information. - [Get URIs by name or verb](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-api-resource-name-uri-entries-1.md): Retrieves URI entries by name or HTTP verb. - [Update URI entry information](https://developer.conga.com/platform/reference/put_api-extensibility-v1-customcode-api-resource-name-uri-entries-id-1.md): Updates a URI entry and returns updated URI entry information. - [Delete a URI](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-customcode-api-resource-name-uri-entries-id-1.md): Removes a URI entry based on the API resource name and URI entry ID. - [Get CustomAPI cancellation token setting configuration](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-api-resource-cancellation-settings-1.md): Fetches CustomAPI cancellation token setting configuration details. - [Upsert CustomAPI cancellation token setting configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-customcode-api-resource-cancellation-settings-1.md): If a cancellation token setting is already configured, it is updated; otherwise, a new one is created. - Conga Hooks Rules - [Retrieve a service hooks rule by name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-rules-name-1.md): Retrieves the service hooks rule details for the given name. - [Update a service hooks rule](https://developer.conga.com/platform/reference/patch_api-extensibility-v1-servicehooks-rules-name-1.md): Validates and updates the service hooks rule and returns the updated rule information. - [Delete a service hooks rule](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-servicehooks-rules-name-1.md): Validates and removes the given service hooks rule. - [Create a new service hooks rule](https://developer.conga.com/platform/reference/post_api-extensibility-v1-servicehooks-rules-1.md): Validates and creates the data change or schedule rule and returns the rule information. - [Retrieve all service hooks rules](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-rules-1.md): Returns service hooks rules that meet the parameter conditions. - [Retrieve all supported event types in service hook rules](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-rules-supported-event-types-1.md): Fetches all supported event types. - [Get service hooks cancellation token setting configuration](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-rules-cancellation-settings-1.md): Fetches service hooks cancellation token setting configuration details. - [Upsert service hooks cancellation token setting configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-servicehooks-rules-cancellation-settings-1.md): If a cancellation token setting is already configured, it is updated; otherwise, a new one is created. - Package Deployment - [Deploy source artifact package](https://developer.conga.com/platform/reference/post_api-extensibility-v2-deployment-package-deploy-1.md): Deploys the source artifact package asynchronously. **Note:** Package may contain CustomCode, Configuration, Schema. - [Promote a package to the target environment](https://developer.conga.com/platform/reference/post_api-extensibility-v2-deployment-package-promote-1.md): Promotes a package to a target environment using the provided integration user's credentials (client ID and secret) and Release URI information.Note: - Use the GET… - [Track package deployment status](https://developer.conga.com/platform/reference/get_api-extensibility-v2-deployment-deploymentid-status-1.md): Gets the status of the package and any available resource for the given deployment ID. - [Retrieve all data of deployment package history](https://developer.conga.com/platform/reference/get_api-extensibility-v2-deployment-history-1.md): Returns data of deployment package history that meet the parameter conditions. **isSnapshot=true** indicates that we want to fetch packages that are not eligible for promotion… - [Retrieve resource deployment information for the specified package](https://developer.conga.com/platform/reference/get_api-extensibility-v2-deployment-package-name-history-1.md): Returns resource deployments for the specified package that meets the parameter criteria. Note:** Package may contain CustomCode, Configuration, Schema. - [Retrieve package information for the specified package](https://developer.conga.com/platform/reference/get_api-extensibility-v2-deployment-package-name-info-1.md): Returns package's information along with ReleaseURI for the specified package that meets the parameter criteria. - [Revert a custom code deployment package with given name](https://developer.conga.com/platform/reference/post_api-extensibility-v2-deployment-package-name-rollback-1.md): Reverts all custom code projects deployed with the given package name to the latest available version in history or delete the custom code if no history found. **Note:** This will not revert… - [Get package deployment logs](https://developer.conga.com/platform/reference/get_api-extensibility-v2-deployment-deploymentid-logs-1.md): Retrieves package deployment's logs with a given deployment ID. ## API Reference: Search - Search Admin - [Get all search settings](https://developer.conga.com/platform/reference/get_api-search-v1-setting-1.md): Retrieves all objects' search settings. - [Create a search setting](https://developer.conga.com/platform/reference/post_api-search-v1-setting-1.md): Creates a search setting for a particular object. - [Update object search setting](https://developer.conga.com/platform/reference/put_api-search-v1-setting-objectname-1.md): Updates the search setting for a given object name. - [Delete object search setting](https://developer.conga.com/platform/reference/delete_api-search-v1-setting-objectname-1.md): Deletes the search setting for a given object name. - [Index a document](https://developer.conga.com/platform/reference/post_api-search-v1-document-index-1.md): Creates an index for the specified document. - [Get data sync status of an object](https://developer.conga.com/platform/reference/get_api-search-v1-objectname-datasyncstatus-1.md): Gets data sync status (Elasticsearch and database) of the given object. - [Get data sync status by tracking ID](https://developer.conga.com/platform/reference/get_api-search-v1-datasyncstatus-trackingid.md): Gets the data sync status for a specific tracking ID. - [Get the data sync status of all objects](https://developer.conga.com/platform/reference/get_api-search-v1-datasyncstatus-1.md): Lists all objects and their data sync status (Elasticsearch and database). - [Resync data for objects except Document](https://developer.conga.com/platform/reference/post_api-search-v1-resyncdata-1.md): Resync data of objects which have mismatch (Elasticsearch and database) count and their data sync will be initialized. Document object will not be processed here. to sync data of… - [Resync data for an object](https://developer.conga.com/platform/reference/post_api-search-v1-objectname-resyncdata-1.md): Resync data of an object which have mismatch (Elasticsearch and database) count and their data sync will be initialized. - [Migrate Search RBAC settings](https://developer.conga.com/platform/reference/post_api-search-v1-rbac-migrate.md): Migrates Search RBAC settings by identifying missing RBAC fields in search settings and publishing a migration message if required. - [Get field data types supported in global search configuration.](https://developer.conga.com/platform/reference/get_api-search-v1-global-search-data-types.md): Returns field data types supported in global search configuration. - Search Runtime - [Get search setting](https://developer.conga.com/platform/reference/get_api-search-v1-setting-objectname-1.md): Retrieves the search setting by object name. - [Search an object](https://developer.conga.com/platform/reference/post_api-search-v1-objects-objectname-query-1.md): Searches an object using various query parameters (for example, Advanced, Fulltext, and Typeahead) and returns the results along with a count.
**Note**: If no search settings are configured for… - [Search documents](https://developer.conga.com/platform/reference/post_api-search-v1-document-query-1.md): Searches an object using various query parameters (for example, Advanced, Fulltext, and Typeahead) and returns the results along with a count. - [Search objects](https://developer.conga.com/platform/reference/post_api-search-v1-objects-multiple-query-1.md): Searches over multiple objects using various query parameters (for example, Advanced, Fulltext, and Typeahead) and returns the results along with the record count.
When searching the text across…
- [Retrieve fields from the search settings or database](https://developer.conga.com/platform/reference/get_api-search-v1-objects-objectname-indexedfields-1.md): Retrieves the list of fields first from the [search settings](https://documentation.conga.com/congaplatform/latest/creating-and-managing-search-settings-222430006.html), and if no fields are enabled…
- [Get a list of objects for which the search setting is enabled](https://developer.conga.com/platform/reference/get_api-search-v1-setting-list-1.md): Retrieves a list of objects for which the search setting is enabled.
- GlobalSearch Runtime
- [Global Search on configured objects](https://developer.conga.com/platform/reference/post_api-search-v1-global-query.md)
## API Reference: Scheduler
- Scheduler
- [List scheduled jobs](https://developer.conga.com/platform/reference/get_api-scheduler-v1-jobs-1.md): Returns scheduled job details.
- [Get scheduled job details](https://developer.conga.com/platform/reference/get_api-scheduler-v1-jobs-jobname-1.md): Returns the scheduled job details based on the job name.
- [Delete a scheduled job](https://developer.conga.com/platform/reference/delete_api-scheduler-v1-jobs-jobname-1.md): Deletes a scheduled job and its execution history by job name.
- [Create a new cron scheduled job](https://developer.conga.com/platform/reference/post_api-scheduler-v1-jobs-cron-1.md): Creates a new cron scheduled job and returns the job name.
- [Create a one-time scheduled job](https://developer.conga.com/platform/reference/post_api-scheduler-v1-jobs-onetime-1.md): Creates a new scheduled job and returns the job's name.
- [Execute the scheduled job](https://developer.conga.com/platform/reference/post_api-scheduler-v1-jobs-jobname-execute-1.md): Executes and returns the executed scheduled job or an appropriate error message.
- [Update the scheduled job](https://developer.conga.com/platform/reference/put_api-scheduler-v1-jobs-jobname-cron-1.md): Updates and returns the scheduled job information or an appropriate error message.
- [Disable the scheduled job](https://developer.conga.com/platform/reference/put_api-scheduler-v1-jobs-jobname-disable-1.md): Disables a scheduled job by job name.
- [Enable scheduled job](https://developer.conga.com/platform/reference/put_api-scheduler-v1-jobs-jobname-enable-1.md): Enables a named scheduled job.
- [Get scheduled job execution history](https://developer.conga.com/platform/reference/get_api-scheduler-v1-jobs-jobname-execution-history-1.md): Returns the scheduled job execution history.
- [Export a scheduled job](https://developer.conga.com/platform/reference/get_api-scheduler-v1-jobs-jobname-export-1.md): Returns scheduled job information by name in a ZIP file.
- [Export all scheduled jobs](https://developer.conga.com/platform/reference/post_api-scheduler-v1-jobs-export-1.md): Exports all scheduled job information in a zip file, based on the appNamespace parameter.
## API Reference: Conversion Management
- Currency Admin
- [Retrieve a currency rate by ID](https://developer.conga.com/platform/reference/get_api-currency-management-v1-currency-rates-id-1.md): Retrieves a currency rate for the given currency rate ID.
- [Update a currency rate](https://developer.conga.com/platform/reference/put_api-currency-management-v1-currency-rates-id-1.md): Updates a currency rate for the given currency rate ID.
- [Delete currency rate by ID](https://developer.conga.com/platform/reference/delete_api-currency-management-v1-currency-rates-id-1.md): Deletes a currency rate.
- [Add a new currency rate](https://developer.conga.com/platform/reference/post_api-currency-management-v1-currency-rates-1.md): Creates a new currency rate.
- [Get all currency rates](https://developer.conga.com/platform/reference/get_api-currency-management-v1-currency-rates-1.md): Returns all currency rates that meet the criteria.
- [Add multiple currency rates](https://developer.conga.com/platform/reference/post_api-currency-management-v1-currency-rates-bulk-1.md): Creates multiple currency rates.
- [Update multiple currency rates](https://developer.conga.com/platform/reference/put_api-currency-management-v1-currency-rates-bulk-1.md): Update multiple currency rates and returns the request status.
- Currency Runtime
- [Retrieve effective currency rate](https://developer.conga.com/platform/reference/post_api-currency-management-v1-query-currency-rates-1.md): Retrieves the effective currency rate.
- [Retrieve effective currency rates](https://developer.conga.com/platform/reference/post_api-currency-management-v1-query-currency-rates-bulk-1.md): Retrieves the effective currency rates.
- [Retrieve converted currency](https://developer.conga.com/platform/reference/post_api-currency-management-v1-query-currency-conversion-1.md): Retrieves the converted currency.
- Frequency Conversion Admin
- [Retrieve a frequency conversion rate by ID](https://developer.conga.com/platform/reference/get_api-conversion-management-v1-frequency-conversion-rates-id-1.md): Retrieves a frequency conversion rate for the given frequency conversion rate ID.
- [Update a frequency conversion rate](https://developer.conga.com/platform/reference/put_api-conversion-management-v1-frequency-conversion-rates-id-1.md): Updates a frequency conversion rate for the given frequency conversion rate ID.
- [Delete frequency conversion rate by ID](https://developer.conga.com/platform/reference/delete_api-conversion-management-v1-frequency-conversion-rates-id-1.md): Deletes frequency conversion rate.
- [Get all frequency conversion rates](https://developer.conga.com/platform/reference/get_api-conversion-management-v1-frequency-conversion-rates-1.md): Returns all frequency conversion rates that meet the criteria.
- [Add a new frequency conversion rate](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-frequency-conversion-rates-1.md): Creates a new frequency conversion rate.
- [Add multiple Frequency conversion rates](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-frequency-conversion-rates-bulk-1.md): Creates multiple frequency conversion rates.
- [Update multiple frequency conversion rates](https://developer.conga.com/platform/reference/put_api-conversion-management-v1-frequency-conversion-rates-bulk-1.md): Updates multiple frequency conversion rates and returns the request status.
- Frequency Conversion Runtime
- [Retrieve effective frequency Conversion rate](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-frequency-conversion-rates-1.md): Retrieves the effective frequency conversion rate.
- [Retrieve effective frequency conversion rates in bulk](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-frequency-conversion-rates-bulk-1.md): Retrieves the effective frequency conversion rates in bulk.
- [Retrieve converted frequency value](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-frequency-conversion-1.md): Retrieves the converted frequency value.
- UOM Conversion Admin
- [Retrieve a UOM conversion rate by ID](https://developer.conga.com/platform/reference/get_api-conversion-management-v1-uom-conversion-rates-id-1.md): Retrieves a UOM conversion rate for the given UOM conversion rate ID.
- [Update a UOM conversion rate](https://developer.conga.com/platform/reference/put_api-conversion-management-v1-uom-conversion-rates-id-1.md): Updates a UOM conversion rate for the given UOM conversion rate ID.
- [Delete UOM conversion rate by ID](https://developer.conga.com/platform/reference/delete_api-conversion-management-v1-uom-conversion-rates-id-1.md): Deletes UOM conversion rate by ID.
- [Get all UOM conversion rates](https://developer.conga.com/platform/reference/get_api-conversion-management-v1-uom-conversion-rates-1.md): Returns all UOM conversion rates that meet the criteria.
- [Add a new UOM conversion rate](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-uom-conversion-rates-1.md): Creates a new UOM conversion rate.
- [Add multiple UOM conversion rates](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-uom-conversion-rates-bulk-1.md): Creates multiple UOM conversion rates.
- [Update multiple UOM conversion rates](https://developer.conga.com/platform/reference/put_api-conversion-management-v1-uom-conversion-rates-bulk-1.md): Updates multiple UOM conversion rates and returns the request status.
- UOM Conversion Runtime
- [Retrieve effective UOM conversion rate](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-uom-conversion-rates-1.md): Retrieves the effective UOM conversion rate.
- [Retrieve effective UOM conversion rates in bulk](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-uom-conversion-rates-bulk-1.md): Retrieves the effective UOM conversion rates in bulk.
- [Retrieve converted UOM value](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-uom-conversion-1.md): Retrieves the converted UOM value.
## API Reference: Audit
- Field History Tracking
- [Get audit history for a record](https://developer.conga.com/platform/reference/post_api-audit-v1-objects-objectname-records-recordid-field-history-tracking.md): Retrieves the audit history for a specific record. It returns a list of all changes made to the specified fields of the record.
- Translation Audit History Tracking
- [Retrieves the translation audit history for a specific locale, module, and key.](https://developer.conga.com/platform/reference/get_api-audit-v1-translations-locales-locale-modules-module-keys-key-audit-history.md): Fetches the audit history of translations based on the provided locale, module, key, and translation type. This allows users to track changes made to translations over time for auditing purposes.
- Field History Tracking Config
- [Add Fields to Field History Tracking](https://developer.conga.com/platform/reference/put_api-audit-v1-objects-objectname-field-history-tracking-config.md): Adds one or more fields to the specified object’s field history tracking configuration. This enables tracking changes to the added fields over time for auditing and reporting purposes.
- [Remove Object from Field History Tracking](https://developer.conga.com/platform/reference/delete_api-audit-v1-objects-objectname-field-history-tracking-config.md): Removes the specified object and all its associated fields from the field history tracking configuration. After removal, changes to these fields will no longer be tracked.
- [Get Field History Tracking Configuration](https://developer.conga.com/platform/reference/get_api-audit-v1-field-history-tracking-config.md): Retrieves all objects and their associated fields that are currently configured for field history tracking. Use this API to view which objects and fields have change tracking enabled.
- Database Field History Tracking Config
- [Bulk upsert Database Field History Tracking Configuration](https://developer.conga.com/platform/reference/put_api-audit-v1-database-field-history-tracking-config-bulk.md): Adds or updates objects and their fields in DataChangeTrackingConfig.
Enforces per-object field limit (default 30, max 100 via service quota).
Callers must provide the full field list for each…
- [Remove Object from Database Field History Tracking Configuration](https://developer.conga.com/platform/reference/delete_api-audit-v1-database-field-history-tracking-config-objects-objectname.md): Removes the specified object and all its associated fields from the database field history tracking configuration.
- [Get Database Field History Tracking Configuration](https://developer.conga.com/platform/reference/get_api-audit-v1-database-field-history-tracking-config.md): Retrieves all objects and their associated fields that are currently configured for database field history tracking.
- [Get Fields for a Specific Object in Database Field History Tracking Configuration](https://developer.conga.com/platform/reference/get_api-audit-v1-database-field-history-tracking-config-objects-objectname.md)
## API Reference: File Store
- File Store
- [Download a file using the specified file path and file name](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-filepath-filename-download-1.md): Retrieves a file from the file store and returns it as a downloadable response.
It handles the following:
- URL decoding of the file path to support special characters
- Determining the…
- [Provide time-based public access to a file](https://developer.conga.com/platform/reference/post_api-filestore-v1-files-shareduri-1.md): Generates a temporary URL that provides public access to a file for a limited time.
The URL will be valid for the duration specified in the request's TTLSeconds parameter.
- [Download multiple files as a ZIP archive](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-filepath-download-1.md): Retrieves multiple files based on their names and file path, packages them into a ZIP archive, and returns the file for download.
If any requested files are not found, appropriate error details are…
- [Get list of file names](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-filepath-filenames-list-1.md): Returns a paginated list of files available at the specified path in the file store.
It supports:
- Pagination through continuation tokens for efficient retrieval of large file sets
- Optional…
- [Retrieve detailed information about a specific file in the file store](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-filepath-filename-info-1.md): Returns metadata about a file including:
- Content type (MIME type)
- File tags/metadata
- File name and path information
It provides file information without downloading the full file content,…
- [Check if a file exists in the file store](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-filepath-filename-exists-1.md): Checks if a file exists at the specified path in the file store, ensuring availability before access.
Common use cases include:
- Validating file existence before performing operations on it
-…
- [Upload a file to the file store with specified metadata and settings](https://developer.conga.com/platform/reference/post_api-filestore-v1-files-filepath-filename-upload-1.md): Upload a file with additional configuration through form data:
- The file content is sent as a multipart form file
- The file name and path determine storage location
- Optional metadata tags can…
- [Upload multiple files](https://developer.conga.com/platform/reference/post_api-filestore-v1-files-bulk-1.md): Upload multiple files in a single request, including file contents and metadata.
Each file can have unique tags, expiration settings, and shared URI configuration.
Files are stored at the specified…
- [Delete multiple files from the file store](https://developer.conga.com/platform/reference/delete_api-filestore-v1-files-bulk-1.md): Deletes multiple files at the given path with partial success handling.
Found files are deleted, while missing files return detailed error information.
Each file’s deletion status is tracked in…
- [Delete a file from the file store](https://developer.conga.com/platform/reference/delete_api-filestore-v1-files-1.md): Validates if the specified file exists at the given path and deletes it if found.
- [Delete all files in a specified folder location](https://developer.conga.com/platform/reference/delete_api-filestore-v1-folders-1.md): Deletes all files in the specified folder path.
Note that this operation:
- Deletes only files in the specified folder (not nested folders).
- Is irreversible - deleted files cannot be recovered.…
- [Initiate a multipart upload process for a large file](https://developer.conga.com/platform/reference/post_api-filestore-v1-files-multipart-uploads-1.md): Starts a multipart upload by creating an upload session.
It returns an upload ID for use in subsequent API calls to:
- Upload individual parts of the file (UploadPartAsync)
- Complete the…
- [Upload a single part of a large file in a multipart upload process](https://developer.conga.com/platform/reference/put_api-filestore-v1-files-multipart-uploads-1.md): Uploads a single part of a large file in a multipart upload session and returns the ETag and part number.
This endpoint is used as part of the multipart upload workflow:
1. First, initialize a…
- [Abort an incomplete multipart upload process](https://developer.conga.com/platform/reference/delete_api-filestore-v1-files-multipart-uploads-1.md): Cancels an in-progress multipart upload operation and removes any parts
that have already been uploaded. Use this endpoint when you need to:
- Cancel an upload that is no longer needed
- Handle…
- [Complete a multipart upload process by combining all uploaded parts into the final file](https://developer.conga.com/platform/reference/post_api-filestore-v1-files-multipart-uploads-complete-1.md): This endpoint is the final step in the multipart upload workflow:
1. Start with InitiateMultipartUploadAsync to get an uploadId
2. Upload individual parts with UploadPartAsync
3. Complete the…
- [Retrieve file size limitation information](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-limits-1.md): This endpoint provides the current configuration limits for file operations:
- Maximum allowed payload size for standard file uploads
- Minimum file part size required for multipart uploads
This…
- [Create a new folder in the file store at the specified path](https://developer.conga.com/platform/reference/post_api-filestore-v1-folders-create-1.md): Creates a new folder structure within the file store.
The folder is created at the specified folder path with the given folder name.
If the parent path doesn't exist, it will give path does not…
- [Get all contents of a given folder](https://developer.conga.com/platform/reference/post_api-filestore-v1-folders-foldername-list-1.md): Returns details of files and folders for the given folder name and folder path.
This endpoint retrieves the direct contents (files and subfolders) of a specified folder.
The response includes…
- [Delete the contents of a specified folder in the file store](https://developer.conga.com/platform/reference/delete_api-filestore-v1-folders-delete-1.md): Deletes all contents within the specified folder path and folder name.
The operation is performed asynchronously and returns the status of the deletion.
- [Get status of a folder operation by tracking ID](https://developer.conga.com/platform/reference/get_api-filestore-v1-folder-operation-trackingid-status-1.md): Returns the current status and details of a folder operation (such as delete, copy, or move)
identified by the provided tracking ID. The response includes information such as the folder name, path,…
- CDN Store
- [Get the file from the CDN store](https://developer.conga.com/platform/reference/get_api-cdnstore-v1-files-filefullpath-1.md): Retrieves a file's details and contents from the CDN store.
- [Upload a file(upto 100 MB) to the CDN store](https://developer.conga.com/platform/reference/post_api-cdnstore-v1-files-filefullpath-1.md): Uploads a file (upto 100 MB) to the CDN store.
- [Delete a file](https://developer.conga.com/platform/reference/delete_api-cdnstore-v1-files-1.md): Validates if the specified file exists at the given path and deletes it if found.; otherwise, it returns an exception.
- [Delete multiple files](https://developer.conga.com/platform/reference/delete_api-cdnstore-v1-files-bulk-1.md): Validates if the specified files exist at the given path and deletes it if found.; otherwise, it returns an exception.
- Lifecycle Event Configuration
- [Set lifecycle event prefix configuration](https://developer.conga.com/platform/reference/put_api-filestore-v1-files-lifecycle-config.md)
- [Get lifecycle event prefix configuration](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-lifecycle-config.md)
- [Delete specific prefixes from lifecycle event configuration](https://developer.conga.com/platform/reference/delete_api-filestore-v1-files-lifecycle-config.md)
## API Reference: External Endpoint Configuration
- External Endpoint Auth Credentials
- [Create authentication configuration](https://developer.conga.com/platform/reference/post_api-external-endpoint-config-v1-credentials-1.md): Stores authentication credentials (OAuth2, Basic Auth, etc.) required to connect securely to an external platform such as Salesforce. Once created, these credentials can be referenced by endpoint…
- [Update authentication configuration](https://developer.conga.com/platform/reference/put_api-external-endpoint-config-v1-credentials-1.md): Updates stored authentication details, such as client secrets or passwords, for a specified external platform, such as Salesforce.
- [Retrieve authentication configuration](https://developer.conga.com/platform/reference/get_api-external-endpoint-config-v1-credentials-name-1.md): Returns the stored authentication details of a specific configuration used for securely connecting to an external service endpoint.
- [Delete authentication configuration](https://developer.conga.com/platform/reference/delete_api-external-endpoint-config-v1-credentials-name-1.md): Removes the stored authentication details for the specified configuration, preventing future connections to the external service endpoint.
- External Endpoint Configuration
- [Validate external endpoint schema](https://developer.conga.com/platform/reference/post_api-external-endpoint-config-v1-endpoints-validate-1.md): Validates the request and response metadata of an external endpoint against the expected JSON schema to ensure correct structure before execution.
- [Retrieve endpoint configuration](https://developer.conga.com/platform/reference/get_api-external-endpoint-config-v1-endpoints-id-1.md): Fetches the stored authentication details and configuration of an external service endpoint using its unique identifier, including URL, method, headers, and linked authentication.
- [Update endpoint configuration](https://developer.conga.com/platform/reference/put_api-external-endpoint-config-v1-endpoints-id-1.md): Updates the settings of a configured endpoint, such as changing the Salesforce API version, modifying the HTTP method, or adjusting headers and parameters.
- [Delete endpoint configuration](https://developer.conga.com/platform/reference/delete_api-external-endpoint-config-v1-endpoints-id-1.md): Deletes the specified external endpoint configuration and its stored authentication details.
- [Create endpoint configuration](https://developer.conga.com/platform/reference/post_api-external-endpoint-config-v1-endpoints-1.md): Creates a new external endpoint configuration by defining its URL, HTTP method, headers, parameters, request/response metadata, and linked authentication.
- [Retrieve all endpoint configurations](https://developer.conga.com/platform/reference/get_api-external-endpoint-config-v1-endpoints-1.md): Retrieves all stored authentication configurations used to connect to external service endpoints.
# Revenue Documentation
> CPQ and Digital Commerce
## Guides: Getting Started
- [CPQ API on Conga Platform - Use Cases](https://developer.conga.com/revenue/docs/cpq-api-on-conga-platform-use-cases.md)
- [User Authentication to Conga Platform](https://developer.conga.com/revenue/docs/user-authentication-to-conga-platform.md)
- [Getting the Application Context](https://developer.conga.com/revenue/docs/getting-the-application-context.md)
- [Retrieving Product Details](https://developer.conga.com/revenue/docs/retrieving-product-details.md)
## Guides: Authentication
- [Angular Applications](https://developer.conga.com/revenue/docs/angular-authentication.md): This page will help you authenticate your Angular application.
- [React Applications](https://developer.conga.com/revenue/docs/react-applications.md): This page will help you authenticate your React application.
## Guides: Basics
- [Filtering](https://developer.conga.com/revenue/docs/filtering.md)
- [Pagination](https://developer.conga.com/revenue/docs/pagination.md)
- [Includes](https://developer.conga.com/revenue/docs/includes.md)
- [Sorting](https://developer.conga.com/revenue/docs/sorting.md)
- [Status and Error Codes](https://developer.conga.com/revenue/docs/status-and-error-codes.md)
- [Content Type](https://developer.conga.com/revenue/docs/content-type.md)
## API Reference: Cart
- AdHocGroups
- [Get all AdHoc Groups.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-adhoc-groups.md): Returns list of AdHoc Groups for the specified cart.
- [Create multiple AdHoc Groups.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-adhoc-groups.md): Creates a list of AdHoc Groups for the specified cart. Validates for duplicate names and sequences within the cart. Returns the created groups or validation errors.
- [Update multiple AdHoc Groups.](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-adhoc-groups.md): Updates a collection of AdHoc Groups with new data. Returns the updated groups or validation errors.
- [Delete multiple AdHoc Groups.](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-adhoc-groups.md): Deletes a list of AdHoc Groups from the specified cart. Returns the result of the delete operation.
- [Get an AdHoc Group by its Id.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-adhoc-groups-adhocgroupid.md): Retrieves a single AdHoc Group by its unique Id. Returns 404 if the group does not exist.
- [Update a single AdHoc Group by its Id.](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-adhoc-groups-adhocgroupid.md): Updates the specified AdHoc Group with new data. Returns the updated group or validation errors.
- [Delete a single AdHoc Group by its Id.](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-adhoc-groups-adhocgroupid.md): Deletes the specified AdHoc Group from the cart. Returns the result of the delete operation.
- Adjustments
- [Get cart adjustments](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-adjustments-1.md): Retrieves the adjustments for the cart (by cart ID).
- [Create adjustments](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-adjustments-1.md): Creates one or more adjustments.
- [Update adjustments by cart](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-adjustments-1.md): Updates one or more adjustment records for the given cartId.
- [Delete cart adjustments](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-adjustments-1.md): Deletes one or more adjustments in a cart based on the cart ID in the endpoint request and the cart ID and adjustment IDs provided in the parameters.
- [Get cart adjustment details](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-adjustments-adjustmentid-1.md): Retrieves details of a cart's adjustments by adjustment ID.
- [Update adjustments by identifier](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-adjustments-adjustmentid-1.md): Update the adjustment fields for the cart and adjustment IDs given in the parameters.
- [Delete an adjustment by identifier](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-adjustments-adjustmentid-1.md): Deletes the adjustment record.
- [Delete adjustments for a line item](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-items-lineitemid-adjustments-1.md): Deletes adjustments for a specific line item.
- BusinessObject
- [Launches the cart for a given business object ID and business object type.](https://developer.conga.com/revenue/reference/post_api-cart-v1-business-objects-businessobjectid-carts-activate.md)
- [Returns the readonly cart for the given business object ID and business object type.](https://developer.conga.com/revenue/reference/get_api-cart-v1-business-objects-businessobjectid-carts-active.md)
- [Please use the endpoint `POST /api/cart/v1/business-objects/{businessObjectId}/carts/reactivate` instead. This is deprecated.](https://developer.conga.com/revenue/reference/post_api-cart-v1-business-objects-businessobjectid-reactivate.md): Syncs fields from quote to cart and re-evaluates config rule, pricing and formula for lineitems. Note: No OOTB field is getting updated as of now.
- [Reactivates the cart syncing the fields from quote to cart.](https://developer.conga.com/revenue/reference/post_api-cart-v1-business-objects-businessobjectid-carts-reactivate.md): Syncs fields from quote to cart and re-evaluates config rule, pricing and formula for lineitems. Supported OOTB fields to sync data from quote to cart are: Account, BillingPreferenc, BillToAccount,…
- CartActions
- [Activate a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-activate-1.md): Activates a cart associated with the cart ID provided in the parameters. Only a cart with a New and Saved status can be activated. Carts in such other statuses as Finalized, Superseded, Suspended,…
- [Migrate a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-migrate.md): Migrates a cart associated with the cart ID provided in the parameters. A cart with Abandoned or Superseded status cannot be migrated.
- [Get the latest active cart](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-active-1.md): Gets the latest active cart, filtering carts with New and Saved status by default. Pass the quote ID in the parameters. If the cart for the provided quote does not exist, this API creates a new cart.…
- [Clone a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-clone-1.md): Clones a cart according to the primary lines no. given by the user or else clones the cart creating an exact copy of the entire cart with all its contents. The cloned cart is created in the new…
- [Retrieve Cart status](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-status-1.md): Returns a cart's status, filtered by line number. **Note:** Use either primaryLineNumbers or lineNumbers to filter your API responses. If you specify both, the API fetches results according to the…
- [Retrieve Configuration status](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-configstatus-1.md): Returns config status of the cart associated with a given cart ID. **Note**: Use either primaryLineNumbers or lineNumbers to filter your API responses. If you specify both, the API fetches results…
- [Get cart line numbers](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-line-numbers-1.md): Fetches and validates the line numbers for a given cart ID.
- [Apply promotion to the cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-promotion-1.md): Validates and applies a promotion to the given cart.
- [Check the cart out](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-order-1.md): Checks out the cart to create an order and order line items based on the given cart ID. The cart does not have to be in Finalized status to check out and create an order: it can be checked out to…
- [Check the cart out to create a quote](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-quote-1.md): Checks out the finalized cart to create a new quote/proposal. This API validates the following during runtime. * The API finalizes the cart, validating all required configurations. If any condition…
- [Finalize a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-finalize-1.md): Finalizes the cart, completing product configuration. This API finalizes the cart when the final set of products and prices is confirmed. This API also validates the following during runtime: *…
- [Get finalized cart details](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-finalize-1.md): Validates and retrieves the finalized cart details for a given cart.
- [Validate the cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-validate-1.md): Validates a cart record for a given cartId and actionName.
- [Abandon a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-abandon-1.md): Validates and abandons a cart.
- [Ignore the rule action](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-rule-actions-ruleactionid-ignore-1.md): Validates and ignores a rule action for a given cart.
- [Get revalidation details](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-revalidation-1.md): Retrieves revalidation details for a given cart.
- [Apply revalidation](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-revalidation-1.md): Validates and applies the revalidation to a given cart.
- [Retrive display action details.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-displayaction-1.md): Fetches all display action details for the specified cart in the given flow.
- [GetConfigRulesOfCart](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-rule-actions-1.md): Gets all the config rules for a given cart ID.
- [Get the applied rule actions](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applied-rule-actions-1.md): Retrieves the applied rule action for a given cart ID and primary line number.
- [GetRuleAction](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-triggered-rule-actions.md)
- [Processes the totals.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-totals.md)
- [Gets the line items group metadata.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-group-status.md)
- [Clone lines into existing cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-clone-lines.md)
- CartItems
- [Add line items to a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-items-1.md): Adds one or more standalone, bundle, option product, or other assets to the cart and creates a line item for each based on the request body details.
- [Update line items](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-items-1.md): Updates multiple line items in a cart based on details provided in the request body.The cart ID is passed as a mandatory parameter. This API validates the following during runtime: * Validation…
- [Retrieve line items from a cart](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-items-1.md): Retrieves all line items associated with the cart ID provided in the parameters.The API returns: * Cart header fields * Primary line items * Secondary line items associated with the primary…
- [Delete line items from a cart](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-items-1.md): Deletes one or more line items associated with the cart ID passed in the parameter. Products cannot be deleted from a cart with Finalized, Superseded, or Deleted status. If line items are removed…
- [Clone cart line items](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-items-clone-1.md): Clones line items based on the primary line numbers passed in the request body. This API creates an exact copy of the lines along with the saved configuration. The cartId parameter is required. This…
- [Reprice cart items](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-reprice-1.md): Reprices one or more line items based on the primary line numbers passed in the request body and cart ID passed in the parameter.
- [Fetches the Cart Lineitem Persistance errors .](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-items-errors.md): This API provides detailed information on persistence failures within the system. Specifically, it retrieves a list of exceptions that have led to failures in the persistence flow, including issues…
- Carts
- [Get all carts](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-1.md): Retrieves the collection of all the carts.
- [Create carts](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-1.md): Creates multiple carts from a list.
- [Update carts](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-1.md): Updates multiple carts from a list.
- [Delete carts](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-1.md): Deletes multiple carts from a submitted list.
- [Get a cart](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-id-1.md): Retrieves a single cart by its identifier.
- [Update a cart](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-id-1.md): Updates a single cart by ID.
- [Delete a cart](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-id-1.md): Deletes a single cart by its identifier.
- CollaborationRequest
- [Add collaboration request.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-collaboration-request.md)
- [Get collaboration request details.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-collaboration-request.md)
- [Get collaboration request by ID.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-collaboration-request-id.md)
- [Update collaboration request.](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-collaboration-request-id.md)
- [Cancel/Delete collaboration request.](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-collaboration-request-id.md)
- [Merge collaboration request.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-collaboration-request-id-merge.md)
- [Submit for merge collaboration request.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-collaboration-request-id-submit-for-merge.md)
- Cart Analyzers
- [Gets the applicable rules.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applicable-rules.md)
- [Gets the applicable product attribute rules.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applied-rules.md)
- [Gets the applicable product attribute rules.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applicable-attribute-rules.md)
- [Gets the applied product attribute rules asynchronous.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applied-attribute-rules.md)
- [Gets the applicable field expression asynchronous.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applicable-field-expression.md)
- [Gets the applied field expression asynchronous.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applied-field-expression.md)
- Export
- [Export line items from a cart as a downloadable CSV file.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-export.md): Exports all line items associated with the specified cartId. The resulting CSV contains: For a leaf category, the API…
- [Retrieve all service products in a category](https://developer.conga.com/revenue/reference/post_categories-categoryid-services.md): Retrieves all active service products associated with the provided category ID and price list ID. This can be the ID of the leaf category, sub-category, or root category.
For a leaf category, the…
- [List categories](https://developer.conga.com/revenue/reference/get_categories-1.md): Retrieves all or a filtered list of categories based on provided parameters. For example, passing the price list ID retrieves all categories associated with that price list ID.
The API returns…
- [Get category details](https://developer.conga.com/revenue/reference/get_categories-categoryid-1.md): Retrieves the details of a category and its child categories by category ID and price list ID. The API returns such category details as category name, description, and hierarchy ID. The API also…
- Favorites
- [Fetch favorite by ID](https://developer.conga.com/revenue/reference/get_favorites-id-1.md)
- [Delete a favorite](https://developer.conga.com/revenue/reference/delete_favorites-id-1.md)
- [Update a favorite](https://developer.conga.com/revenue/reference/patch_favorites-id-1.md)
- [Preview favorite by ID](https://developer.conga.com/revenue/reference/get_favorites-id-preview.md)
- [List favorites by price list](https://developer.conga.com/revenue/reference/get_favorites-1.md): Retrieves a list of active favorites associated with the provided Price List ID.
- [Create favorites](https://developer.conga.com/revenue/reference/post_favorites-1.md): Creates favorites based on your business requirements.
- [Delete the favorite records](https://developer.conga.com/revenue/reference/delete_favorites-1.md)
- [Add favorite to a cart](https://developer.conga.com/revenue/reference/post_favorites-id-addtocart-cartid-1.md): Adds a favorite to the cart identified in cartId.
- [Publish favorite to a pricelist](https://developer.conga.com/revenue/reference/post_favorites-id-publish-1.md): Publishes a favorite for the given pricelist.
- [Delete the line-items from within the Favorite](https://developer.conga.com/revenue/reference/delete_favorites-id-items.md)
- JobStatus
- [Get job status](https://developer.conga.com/revenue/reference/get_job-status-jobid-1.md): Retrieves job status details for the given job.
- Locations
- [Get account locations](https://developer.conga.com/revenue/reference/get_locations-1.md)
- PriceLists
- [Retrieve a price list](https://developer.conga.com/revenue/reference/get_price-lists-active-1.md)
- Products
- [List products by price list](https://developer.conga.com/revenue/reference/get_products-1.md): Retrieves details of active products associated with the provided price list ID. The API only retrieves active products with an active price list and price list item. The API also applies visibility…
- [Get a product's details](https://developer.conga.com/revenue/reference/get_products-productid-1.md): Retrieves the details of a product (productId). The API only retrieves active products with an active price list and price list item.
The API returns details of the following fields, among…
- [Searches the search text in bundle context (option groups, options, attribute groups, attributes)](https://developer.conga.com/revenue/reference/get_products-productid-search.md): Retrieves the list where the search text matches.
- [Retrieve products by ID](https://developer.conga.com/revenue/reference/post_products-details-1.md): Retrieves product details for multiple products listed by product ID.
- [Compare products](https://developer.conga.com/revenue/reference/post_products-compare-1.md): Compares the attributes of a list of products by productId.
- Services
- [List service products](https://developer.conga.com/revenue/reference/post_services.md): Retrieves details of active service products associated with the provided price list ID. The API only retrieves active products with an active price list and price list item. The API also applies…
- SmartSearch
- [Search products](https://developer.conga.com/revenue/reference/post_search-1.md): Applies search filters in the catalog to retrieve one or more products that satisfy the search filter criteria provided in the parameters and the request body. To filter out a product you can use the…
- [Search products using typeahead](https://developer.conga.com/revenue/reference/get_search-typeahead-1.md): Searches for products using typeahead search, an autosuggest method that predicts search results and gives users suggestions when they enter one or more letters related to their search.
This API…
## API Reference: Quote
- JobStatus
- [Get job status](https://developer.conga.com/revenue/reference/get_job-status-jobid-2.md): Retrieves job status details for the given job.
- Quote
- [Accept a quote and create an order](https://developer.conga.com/revenue/reference/post_quotes-id-accept-1.md): Accepts a specified quote in any approval stage other than Accepted.
Creates an order and order line items based on the quote’s header and line item details.
Creates an order in draft stage with…
- [Upsert a quote](https://developer.conga.com/revenue/reference/post_quotes-upsert-quote-1.md): Upserts an existing quote.
- [Clone quote](https://developer.conga.com/revenue/reference/post_quotes-id-clone-1.md): Clones a quote based on the internal quote ID.
- [Clone external quote](https://developer.conga.com/revenue/reference/post_quotes-externalid-clone-quote-1.md): Clones a quote based on the external quote ID.
- [Retrieve quotes](https://developer.conga.com/revenue/reference/get_quotes-1.md): Retrieves list of quotes.
- [Create quotes](https://developer.conga.com/revenue/reference/post_quotes-1.md): Creates one or more quotes with details provided in the request body. The API returns the IDs of the newly created quotes and their structure.
- [Update quotes](https://developer.conga.com/revenue/reference/patch_quotes-1.md): Updates one or more quotes.
- [Delete quotes](https://developer.conga.com/revenue/reference/delete_quotes-1.md): Deletes one or more quote records.
- [Retrieve a quote](https://developer.conga.com/revenue/reference/get_quotes-id-1.md): Retrieves the details of a quote based on the quote ID provided in the parameters.
The API returns the details of quote object
- [Update a quote](https://developer.conga.com/revenue/reference/patch_quotes-id-1.md): Updates the quote with details provided in the request parameter. The API returns the ID of the updated quote and its structure.
- [Delete a quote](https://developer.conga.com/revenue/reference/delete_quotes-id-1.md): Deletes the quote where the quote ID matches the ID provided in the parameter.
- [Create agreement from a quote](https://developer.conga.com/revenue/reference/post_quotes-id-agreement-1.md): Create an agreement from a quote, where the quote ID matches the ID provided in the parameter.
## API Reference: Order
- Orders
- [Search and retrieve multiple orders](https://developer.conga.com/revenue/reference/get_orders.md): Retrieves a list of orders that match your search criteria. You can filter by customer, date range, order status, or other properties. Results are paginated to handle large data sets efficiently.
- [Add new orders to the system](https://developer.conga.com/revenue/reference/post_orders.md): Creates one or more new orders. This is typically used when importing orders from external systems or when manually entering orders into the system. The system will automatically set default values…
- [Modify multiple existing orders](https://developer.conga.com/revenue/reference/patch_orders.md): Updates information for multiple orders at once. Useful for bulk operations like updating order statuses, shipping information, or other properties. Note: External orders have restrictions on which…
- [Remove multiple orders from the system](https://developer.conga.com/revenue/reference/delete_orders.md): Permanently deletes multiple orders. Use with caution as this action cannot be undone. Typically used for cleaning up test orders or cancelled orders that should not be retained.
- [Retrieve a single order by its unique identifier](https://developer.conga.com/revenue/reference/get_orders-id.md): Gets complete details for a specific order. Use this when you know the exact order you want to view or when following up on a particular customer transaction.
- [Modify a single order](https://developer.conga.com/revenue/reference/patch_orders-id.md): Updates specific information for one order. Use this to change order details such as customer information, shipping address, or order notes. Some fields may be restricted for orders originating…
- [Remove a single order from the system](https://developer.conga.com/revenue/reference/delete_orders-id.md): Permanently deletes one order. Use with caution as this action cannot be undone.
- [Generate related records for order fulfillment](https://developer.conga.com/revenue/reference/post_orders-orderid-create-child-records.md): Creates all necessary downstream records for processing an order, such as subscriptions, billing schedules, or asset records. This is a critical step in the order-to-cash process. Can run…
- Order Actions
- [Accept Order Changes](https://developer.conga.com/revenue/reference/post_orders-id-accept-change.md): Finalizes and applies the changes made during the order amendment process. Once accepted, the modifications become permanent and replace the original order details. This action completes the change…
- [Activate an Order](https://developer.conga.com/revenue/reference/post_orders-id-activate.md): Activates an order, making it live and effective in the system. This typically means the order starts generating revenue, billing cycles begin, or services/products become available to the customer.…
- [Cancel an Order](https://developer.conga.com/revenue/reference/post_orders-id-cancel.md): Cancels an existing order, effectively voiding it and preventing further processing. This action is typically used when an order needs to be stopped due to customer request, inventory issues, or…
- [Initiate Order Amendment Process](https://developer.conga.com/revenue/reference/post_orders-id-change.md): Begins the process of modifying an existing active order by creating a change order. This allows you to adjust order details such as quantities, products, or terms without canceling the original…
- [Confirm an Order](https://developer.conga.com/revenue/reference/post_orders-id-confirm.md): Finalizes and confirms an order, transitioning it from draft or pending status to confirmed. Once confirmed, the order is locked and ready for the next stage of processing. This action typically…
- [Revert Order Changes](https://developer.conga.com/revenue/reference/post_orders-id-revert-change.md): Discards all changes made during the order amendment process and restores the order to its original state before modifications were initiated. This action cancels the change order workflow without…
- [Split an Order into Multiple Orders](https://developer.conga.com/revenue/reference/post_orders-orderid-split.md)
- [Bulk Activate Multiple Orders](https://developer.conga.com/revenue/reference/post_orders-activate.md): Activates multiple orders simultaneously in a single operation, improving efficiency when processing large numbers of orders. Each order becomes live and effective based on its individual activation…
- Order Line Items
- [Retrieves all line items associated with a specific order.](https://developer.conga.com/revenue/reference/get_order-parentid-orderlineitems.md): Use this endpoint to view all products and services that have been added to an order. Results are automatically sorted by item sequence number to maintain the order in which items were added. You…
- [Updates multiple order line items in a single operation.](https://developer.conga.com/revenue/reference/patch_order-parentid-orderlineitems.md): Use this endpoint to efficiently update several line items at once, such as adjusting quantities across multiple products or updating billing dates for a group of items. Important restrictions: -…
- [Adds one or more new line items to an order.](https://developer.conga.com/revenue/reference/post_order-parentid-orderlineitems.md): Use this endpoint to add products or services to an existing order. The system automatically assigns unique identifiers to new line items and inherits default values from the parent order (such as…
- [Retrieves detailed information about a specific order line item.](https://developer.conga.com/revenue/reference/get_order-parentid-orderlineitems-id.md): Use this endpoint to view complete details about a single product or service on an order, including pricing, quantity, billing information, and fulfillment status.
- [Updates information for a single order line item.](https://developer.conga.com/revenue/reference/patch_order-parentid-orderlineitems-id.md): Use this endpoint to modify details of an existing line item, such as quantity, pricing, or dates. Note: Line items can only be updated when they are in certain statuses (e.g., Draft, Pending). For…
- Order Line Item Actions
- [Activates specific items within an order so they can be fulfilled, billed, and tracked for revenue.](https://developer.conga.com/revenue/reference/post_order-parentid-orderlineitems-activate.md)
- [Activates items across many orders at once - perfect for processing monthly contract starts, scheduled go-lives, or end-of-quarter activations.](https://developer.conga.com/revenue/reference/post_orders-orderlineitems-activate.md)
- Job Status
- [Retrieves the current status of a job or operation](https://developer.conga.com/revenue/reference/get_job-status-id.md): Use this endpoint to check the status of a previously submitted operation. Provide either the job identifier that was returned when you started the operation, or the record identifier associated…
- [Retrieves the current status of a batchable job or operation, along with its child jobs if applicable.](https://developer.conga.com/revenue/reference/get_job-status-batch-id.md)
- Split Criteria Setup
- [Gets a list of split criteria setups based on the provided query parameters.](https://developer.conga.com/revenue/reference/get_split-criteria-1.md)
- [Creates a new split criteria setup based on the provided request data.](https://developer.conga.com/revenue/reference/post_split-criteria-1.md)
- [Updates multiple split criteria setups based on the provided request data.](https://developer.conga.com/revenue/reference/patch_split-criteria-1.md): Partial success is supported; if some records are invalid or fail to update, the response will include details for each record and use status code 207 (Multi-Status). The order of…
- [Gets a split criteria setup by its unique identifier.](https://developer.conga.com/revenue/reference/get_split-criteria-id-1.md)
- [Activates the split criteria setup identified by the specified ID.](https://developer.conga.com/revenue/reference/patch_split-criteria-id-activate-1.md)
- [Toggles the active status of the specified split criteria setups.](https://developer.conga.com/revenue/reference/patch_split-criteria-activate-1.md): This method processes the provided requests to toggle the active status of the specified split criteria setups. It returns a 207 Multi Status code on partial success or a 400 Bad Request…
## API Reference: Asset
- AssetActions
- [Change a cart's assets](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-change-1.md): Changes the list of assets provided for a given cart.
- [Terminate a cart's assets](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-terminate-1.md): Terminates the assets listed for a given cart.
- [Renew a cart's assets](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-renew-1.md): Renews the listed assets for a given cart.
- [Configure an asset](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-change-configuration-1.md): Changes the configuration of an asset provided for a given cart.
- [Get termination date](https://developer.conga.com/revenue/reference/get_api-asset-v1-assets-cartid-termination-date-1.md): Gets the default asset termination date based on the callback.
- [Change quantity](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-change-quantity-1.md): Updates the quantity characteristic of assets in a given cart's asset list. This API updates the associated or implied quantity that any asset has. The AssetChangeQuantityRequest request parameter…
- [Suspend assets](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-suspend-1.md): Suspends the listed assets by date. This API suspends an existing asset based on the suspension date. It remains suspended until the suspension end date.
- [Resume assets](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-resume-1.md): Resumes the listed assets.
- [Restore line items](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-restore-1.md): Restores line-item fields to their original values from the asset line item.
- [Swap an asset](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-swap-1.md): Swaps an asset with any eligible replacement product, effective a given date.
- Assets
- [Calculates metrics for asset termination based on the provided termination date](https://developer.conga.com/revenue/reference/post_api-asset-v1-terminate-preview-1.md)
- [List asset line items](https://developer.conga.com/revenue/reference/get_api-asset-v1-assets-cartid-1.md): Retrieves all asset line items for the given account(s).
- [List asset line items](https://developer.conga.com/revenue/reference/get_api-asset-v1-assets-1.md): Retrieves all asset line items for the given account(s).
- [Fetch grouping summary of asset line items](https://developer.conga.com/revenue/reference/get_api-asset-v1-assets-group-summary-1.md): Retrieves Grouped summary of asset line items for the given account(s) based on the grouping field.
- [Get child asset line items](https://developer.conga.com/revenue/reference/get_api-asset-v1-parentassetid-assets-1.md): Retrieves all the child asset line items (primary, secondary, and option) associated with a parent bundle (excluding the parent bundle record).
- [Get assets by co-termination criteria](https://developer.conga.com/revenue/reference/get_api-asset-v1-assetid-coterm-1.md): Retrieves assets with identical values in specified criteria fields within the same account. Primarily used to amend asset co-termination during quantity changes.
- [List related purchased assets for given asset ids](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-related-purchases.md): Retrieves all related purchased assets for the given assetId(s).
- Products
- [/api/asset/v1/product/{productId}/replacement-products](https://developer.conga.com/revenue/reference/get_api-asset-v1-product-productid-replacement-products-1.md)
## API Reference: Administration
- Attributes
- [Retrieve attributes](https://developer.conga.com/revenue/reference/get_attributes-1.md): Retrieves the collection of attributes.
- [Create attributes](https://developer.conga.com/revenue/reference/post_attributes-1.md): Creates attributes based on the details provided in the request.
- [Update attributes](https://developer.conga.com/revenue/reference/patch_attributes-1.md): Updates one or more attribute records.
- [Delete attributes](https://developer.conga.com/revenue/reference/delete_attributes-1.md): Deletes one or more attributes based on the attribute IDs provided in the request body.
This API returns one or more records with each record ID's delete status.
- [Retrieve an attribute](https://developer.conga.com/revenue/reference/get_attributes-id-1.md): Retrieves a single attribute record.
- [Update an attribute](https://developer.conga.com/revenue/reference/patch_attributes-id-1.md): Updates a single attribute record.
- [Delete an attribute](https://developer.conga.com/revenue/reference/delete_attributes-id-1.md): Deletes an attribute based on the attribute ID provided in the parameters.
This API returns record ID's delete status.
- JobStatus
- [Get job status](https://developer.conga.com/revenue/reference/get_job-status-jobid-3.md): Retrieves job status details for the given job.
If includeChildJobs is true then it will return all the child jobs for the given jobId.
OperationType
ValidateBatchData -> Detailed…
- [Get multiple job status](https://developer.conga.com/revenue/reference/post_job-status.md): Retrieves all job status details for the given jobIds.
If includeChildJobs is true then it will return all the child jobs for the given jobId.
OperationType
ValidateBatchData -> Detailed…
- [Delete job by JobId and also its associated child jobs](https://developer.conga.com/revenue/reference/delete_job-status.md): Delete job by JobId and also delete its child jobs
- Accounts
- [Retrieve active account](https://developer.conga.com/revenue/reference/accounts-3.md): Retrieves active account pricelist
- Attribute Constraint Rule Entries
- [Retrieve AttributeConstraintRuleEntries](https://developer.conga.com/revenue/reference/get_attribute-constraint-rules-parentid-entries.md): Retrieves the list of AttributeConstraintRuleEntries.
- [Create AttributeConstraintRuleEntries](https://developer.conga.com/revenue/reference/post_attribute-constraint-rules-parentid-entries.md): Creates multiple AttributeConstraintRuleEntries.
- [Update AttributeConstraintRuleEntries](https://developer.conga.com/revenue/reference/patch_attribute-constraint-rules-parentid-entries.md): Updates multiple AttributeConstraintRuleEntries.
- [Delete AttributeConstraintRuleEntries](https://developer.conga.com/revenue/reference/delete_attribute-constraint-rules-parentid-entries.md): Deletes multiple AttributeConstraintRuleEntries.
- [Retrieve an AttributeConstraintRuleEntry](https://developer.conga.com/revenue/reference/get_attribute-constraint-rules-parentid-entries-id.md): Retrieves a single AttributeConstraintRuleEntry by ID.
- [Update an AttributeConstraintRuleEntry](https://developer.conga.com/revenue/reference/patch_attribute-constraint-rules-parentid-entries-id.md): Updates an existing AttributeConstraintRuleEntry.
- [Delete an AttributeConstraintRuleEntry](https://developer.conga.com/revenue/reference/delete_attribute-constraint-rules-parentid-entries-id.md): Deletes an AttributeConstraintRuleEntry.
- [Create AttributeConstraintRuleEntries using a CSV file.](https://developer.conga.com/revenue/reference/post_attribute-constraint-rules-parentid-entries-import.md)
- [Get the list of AttributeConstraintRuleEntries as a CSV file.](https://developer.conga.com/revenue/reference/get_attribute-constraint-rules-parentid-entries-export.md)
- Attribute Constraint Rules
- [Retrieve AttributeConstraintRules](https://developer.conga.com/revenue/reference/get_attribute-constraint-rules.md): Retrieves all Attribute Constraint Rules existing in the system.
The API returns the list of Attribute Constraint Rules.
- [Create AttributeConstraintRules](https://developer.conga.com/revenue/reference/post_attribute-constraint-rules.md): Creates one or more Attribute Constraint Rules based on the details provided in the request body.
The API returns the structure of newly created Attribute Constraint Rules.
- [Update AttributeConstraintRules](https://developer.conga.com/revenue/reference/patch_attribute-constraint-rules.md): Updates one or more Attribute Constraint Rules based on the details provided in the request body.
When executed, the API returns the ID and the structure of the updated Attribute Constraint Rules.
- [Delete AttributeConstraintRules](https://developer.conga.com/revenue/reference/delete_attribute-constraint-rules.md): Deletes one or more AttributeConstraintRules based on the list of AttributeConstraintRule Ids provided in the request body.
- [Retrieve an AttributeConstraintRule](https://developer.conga.com/revenue/reference/get_attribute-constraint-rules-id.md): Retrieves a single AttributeConstraintRule record.
- [Update an AttributeConstraintRule](https://developer.conga.com/revenue/reference/patch_attribute-constraint-rules-id.md): Updates a single AttributeConstraintRule by its identifier.
- [Delete an AttributeConstraintRule.](https://developer.conga.com/revenue/reference/delete_attribute-constraint-rules-id.md): Deletes a single AttributeConstraintRule by its identifier.
- Attribute Group Members
- [Retrieve attribute group members](https://developer.conga.com/revenue/reference/get_attribute-groups-parentid-attributes-1.md): Retrieves a collection of attribute group members based on the parent attribute group.
- [Create attribute group members](https://developer.conga.com/revenue/reference/post_attribute-groups-parentid-attributes-1.md): Creates one or more attribute group members to the collection. The parent attribute group is automatically filled.
- [Update attribute group members](https://developer.conga.com/revenue/reference/patch_attribute-groups-parentid-attributes-1.md): Updates one or more attribute group members in the collection. Parent reassignment is not allowed.
- [Delete attribute group members](https://developer.conga.com/revenue/reference/delete_attribute-groups-parentid-attributes-1.md): Deletes one or more attribute group members from the collection.
- [Retrieve attribute group member](https://developer.conga.com/revenue/reference/get_attribute-groups-parentid-attributes-id-1.md): Retrieves a single attribute group member of an attribute group record.
- [Update an attribute group member](https://developer.conga.com/revenue/reference/patch_attribute-groups-parentid-attributes-id-1.md): Updates a single attribute group member of an attribute group record.
- [Delete an attribute group member](https://developer.conga.com/revenue/reference/delete_attribute-groups-parentid-attributes-id-1.md): Deletes a single attribute group member of an attribute group record.
- Attribute Groups
- [Retrieve attribute groups](https://developer.conga.com/revenue/reference/get_attribute-groups-1.md): Retrieves the collection of attribute groups.
- [Create attribute groups](https://developer.conga.com/revenue/reference/post_attribute-groups-1.md): Creates mone or more attribute groups based on the details provided in the request body.
When executed, the API returns the ID and the structure of the newly created attribute group.
- [Update attribute groups](https://developer.conga.com/revenue/reference/patch_attribute-groups-1.md): Updates one or more attribute groups based on the details provided in the request body.
When executed, the API returns the ID and the structure of the updated attribute group.
- [Delete attribute groups](https://developer.conga.com/revenue/reference/delete_attribute-groups-1.md): Deletes one or more attribute groups based on the input provided in the request body. Upon deletion of an attribute group, the API deletes the records of association between attribute group with…
- [Retrieve an attribute group](https://developer.conga.com/revenue/reference/get_attribute-groups-id-1.md): Retrieves a single attribute group record.
- [Update an attribute group](https://developer.conga.com/revenue/reference/patch_attribute-groups-id-1.md): Updates a single attribute group record.
- [Delete an attribute group](https://developer.conga.com/revenue/reference/delete_attribute-groups-id-1.md): Deletes a single attribute group record.
- Attribute Matrices
- [Retrieve attribute matrices](https://developer.conga.com/revenue/reference/get_attribute-matrices-1.md): Retrieves all attribute matrices existing in the system. If a product ID or an attribute ID is specified, the API retrieves attribute matrices associated with them.
The API returns the list of…
- [Create attribute matrices](https://developer.conga.com/revenue/reference/post_attribute-matrices-1.md): Creates one or more attribute matrices based on the details provided in the request body. The attribute matrix can be created for product scope, and it can be active or deactivated upon creation.…
- [Update attribute matrices](https://developer.conga.com/revenue/reference/patch_attribute-matrices-1.md): Updates one or more attribute matrices based on the details provided in the request body.
When executed, the API returns the ID and the structure of the updated attribute matrices.
- [Delete attribute matrices](https://developer.conga.com/revenue/reference/delete_attribute-matrices-1.md): Deletes one or more attribute matrices based on the list of attribute matrix IDs provided in the request body.
- [Retrieve an attribute matrix](https://developer.conga.com/revenue/reference/get_attribute-matrices-id-1.md): Retrieves a single attribute matrix record.
- [Update an attribute matrix](https://developer.conga.com/revenue/reference/patch_attribute-matrices-id-1.md): Updates a single attribute matrix by its identifier.
- [Delete an attribute matrix](https://developer.conga.com/revenue/reference/delete_attribute-matrices-id-1.md): Deletes a single attribute matrix by its identifier.
- Attribute Matrix Entries
- [Retrieve attribute matrix entries](https://developer.conga.com/revenue/reference/get_attribute-matrices-parentid-entries-1.md): Retrieves the list of attribute matrix entries.
- [Create attribute matrix entries](https://developer.conga.com/revenue/reference/post_attribute-matrices-parentid-entries-1.md): Creates multiple attribute matrix entries.
- [Update attribute matrix entries](https://developer.conga.com/revenue/reference/patch_attribute-matrices-parentid-entries-1.md): Updates multiple attribute matrix entries.
- [Delete attribute matrix entries](https://developer.conga.com/revenue/reference/delete_attribute-matrices-parentid-entries-1.md): Deletes multiple attribute matrix entries.
- [Retrieve an attribute matrix entry](https://developer.conga.com/revenue/reference/get_attribute-matrices-parentid-entries-id-1.md): Retrieves a single attribute matrix entry by ID.
- [Update an attribute matrix entry](https://developer.conga.com/revenue/reference/patch_attribute-matrices-parentid-entries-id-1.md): Updates an existing attribute matrix entry.
- [Delete an attribute matrix entry](https://developer.conga.com/revenue/reference/delete_attribute-matrices-parentid-entries-id-1.md): Deletes an attribute matrix entry.
- [Create AttributeMatrixEntries using a CSV file.](https://developer.conga.com/revenue/reference/post_attribute-matrices-parentid-entries-import-1.md): This API imports attribute matrix entries from a CSV file. The CSV file should have attribute names as column headers in the first row, followed by rows containing the corresponding attribute values.…
- [Get the list of AttributeMatrixEntries as a CSV file.](https://developer.conga.com/revenue/reference/get_attribute-matrices-parentid-entries-export-1.md): Exports attribute matrix entries to a CSV file. Retrieves all entries for the specified parent attribute matrix and generates a CSV file with attribute names as headers and corresponding values in…
- Categories
- [Retrieve a category](https://developer.conga.com/revenue/reference/get_categories-id-1.md): Retrieves a single category record.
- [Update a category](https://developer.conga.com/revenue/reference/patch_categories-id-1.md): Updatess a single category record.
- [Delete a category](https://developer.conga.com/revenue/reference/delete_categories-id-1.md): Deletes a single category based on the category ID provided in the parameter. The API deletes the specific category record and records of association of the specific category with its products.
- [Retrieve categories](https://developer.conga.com/revenue/reference/get_categories-2.md): Retrieves a list of all categories that exist in the system. The "filter" parameter only supports category name and category id for this API.
- [Create categories](https://developer.conga.com/revenue/reference/post_categories-1.md): Creates one or more category based on the input provided in the request body.
The API returns structure of each category created, with details provided in the request body.
- [Update categories](https://developer.conga.com/revenue/reference/patch_categories-1.md): Updates one or more categories based on the details provided in the request body.
- [Delete categories](https://developer.conga.com/revenue/reference/delete_categories-1.md): Deletes one or more categories based on the list of category IDs provided in the request body.
The API deletes category records and records of association of category with products and price…
- [Add an existing category along with child categories and product associations under given destination category id.](https://developer.conga.com/revenue/reference/post_categories-id-add.md): Add an existing category along with child categories and product associations under given destination category id.
- [Add multiple existing categories under another category](https://developer.conga.com/revenue/reference/post_categories-category-bulk.md): Add multiple existing categories under given category id.
- [Get price lists](https://developer.conga.com/revenue/reference/get_categories-categoryid-price-lists-1.md): Gets price list records for a given category. Your request can set
the number of records returned per page and the total number of pages.
- [Retrieve a product category](https://developer.conga.com/revenue/reference/get_categories-id-products-1.md): Retrieves a single product category.
- [Retrieve product categories](https://developer.conga.com/revenue/reference/get_categories-parentid-product-categories-1.md): Retrieves the product category records for a category.
- [Create product categories](https://developer.conga.com/revenue/reference/post_categories-parentid-product-categories-1.md): Creates multiple product categories.
- [Update product categories](https://developer.conga.com/revenue/reference/patch_categories-parentid-product-categories-1.md): Updates multiple product categories.
- [Delete product categories](https://developer.conga.com/revenue/reference/delete_categories-parentid-product-categories-1.md): Deletes one or more product categories from a specified product based on the parameters and request body.
- [Retrieve a product category](https://developer.conga.com/revenue/reference/get_categories-parentid-product-categories-id-1.md): Retrieves a product category by ID.
- [Update a product category](https://developer.conga.com/revenue/reference/patch_categories-parentid-product-categories-id-1.md): Updates a product category.
- [Delete a product category](https://developer.conga.com/revenue/reference/delete_categories-parentid-product-categories-id-1.md): Deletes a product category by ID.
- Clone
- [Retrieve deep clone status](https://developer.conga.com/revenue/reference/get_clone-status-id-1.md): Retrieves deep clone status.
- [List related cloneable objects](https://developer.conga.com/revenue/reference/get_clone-objectname-supported-objects-1.md): Gets a list of related cloneable objects for a given source entity.
- [Create a clone of an object](https://developer.conga.com/revenue/reference/post_objectname-objectid-clone-1.md): Creates a clone of the object with the specified identifier.
- Constraint Rule Actions
- [Get constraint rule actions](https://developer.conga.com/revenue/reference/get_constraint-rules-parentid-actions-1.md): Retrieves all constraint rule actions in a constraint rule, with their details. Use query parameters to narrow the results further.
When executed, this API returns all constraint rule actions in…
- [Create constraint rule actions](https://developer.conga.com/revenue/reference/post_constraint-rules-parentid-actions-1.md): Creates one or more constraint rule actions in a specific constraint rule. It can create a maximum of 100 constraint rule actions.
When executed, this API returns a unique constraint rule action…
- [Update constraint rule actions](https://developer.conga.com/revenue/reference/patch_constraint-rules-parentid-actions-1.md): Updates specific fields on one or more constraint rule actions. It can update any field except the constraint rule action ID, and returns the updated constraint rule action or actions.
- [Delete constraint rule actions](https://developer.conga.com/revenue/reference/delete_constraint-rules-parentid-actions-1.md): Deletes multiple constraint rule actions.
- [Get a constraint rule action](https://developer.conga.com/revenue/reference/get_constraint-rules-parentid-actions-id-1.md): Retrieves a single constraint rule action in a constraint rule, with its details.
- [Update a constraint rule action](https://developer.conga.com/revenue/reference/patch_constraint-rules-parentid-actions-id-1.md): Updates a single constraint rule action in a constraint rule.
- [Delete a constraint rule action](https://developer.conga.com/revenue/reference/delete_constraint-rules-parentid-actions-id-1.md): Deletes a single constraint rule action in a constraint rule.
- [Retrieve ConstraintRuleActionExpression](https://developer.conga.com/revenue/reference/get_constraint-rule-actions-parentid-constraint-rule-action-expressions.md): Retrieves all ConstraintRuleActionExpressions in a ConstraintRuleAction, with their details. Use query parameters to further narrow the results.
When executed, this API returns all…
- [Create ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/post_constraint-rule-actions-parentid-constraint-rule-action-expressions.md): creates one or more ConstraintRuleActionExpressions in a specific ConstraintRuleAction. It can create a maximum of 1000 ConstraintRuleActionExpressions. It can create multiple…
- [Update ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/patch_constraint-rule-actions-parentid-constraint-rule-action-expressions.md): Updates specific fields on one or more ConstraintRuleActionExpressions. It can update any field except the ConstraintRuleActionExpressions ID.
When executed, this API returns the updated…
- [Delete ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/delete_constraint-rule-actions-parentid-constraint-rule-action-expressions.md): Delete ConstraintRuleActionExpressions
- [Retrieve a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/get_constraint-rule-actions-parentid-constraint-rule-action-expressions-id.md): Retrieves a ConstraintRuleActionExpressions in a ConstraintRuleAction, with their details. Use query parameters to further narrow the results.
When executed, this API returns a…
- [Update a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/patch_constraint-rule-actions-parentid-constraint-rule-action-expressions-id.md): Updates specific fields on specified ConstraintRuleActionExpressions. It can update any field except the ConstraintRuleActionExpressions ID.
When executed, this API returns the updated…
- [Delete a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/delete_constraint-rule-actions-parentid-constraint-rule-action-expressions-id.md): Deletes a specified ConstraintRuleActionExpressions in a ConstraintRuleAction.
When executed, this API returns the delete status of associated record ID.
- [Retrieve lookup records for FieldExpression](https://developer.conga.com/revenue/reference/get_constraint-rule-actions-id-field-expressions.md): Retrieves the lookup records for a specific FieldExpression based on the identifier.
- Constraint Rule Conditions
- [Retrieve constraint rule conditions](https://developer.conga.com/revenue/reference/get_constraint-rules-parentid-conditions-1.md): Retrieves all constraint rule conditions in a constraint rule, with their details. Use query parameters to further narrow down the retrieved results.
When executed, this API returns all…
- [Create constraint rule conditions](https://developer.conga.com/revenue/reference/post_constraint-rules-parentid-conditions-1.md): Creates one or more constraint rule conditions in a specific constraint rule. It can create a maximum of 100 constraint rule conditions.
When executed, this API returns a unique constraint rule…
- [Update constraint rule conditions](https://developer.conga.com/revenue/reference/patch_constraint-rules-parentid-conditions-1.md): Updates specific fields on one or more constraint rule conditions. It can update any fields except the constraint rule condition ID.
When executed, this API returns the updated constraint rule…
- [Delete constraint rule conditions](https://developer.conga.com/revenue/reference/delete_constraint-rules-parentid-conditions-1.md): Deletes one or more constraint rule conditions from a constraint rule.
When executed, this API returns one or more records with each record ID's delete status.
- [Retrieve a constraint rule condition](https://developer.conga.com/revenue/reference/get_constraint-rules-parentid-conditions-id-1.md): Retrieve a single constraint rule condition in a constraint rule, with its details.
- [Update a constraint rule condition](https://developer.conga.com/revenue/reference/patch_constraint-rules-parentid-conditions-id-1.md): Updates a single constraint rule condition in a constraint rule.
- [Delete a constraint rule condition](https://developer.conga.com/revenue/reference/delete_constraint-rules-parentid-conditions-id-1.md): Deletes a single constraint rule condition in a constraint rule.
- Constraint Rules
- [Retrieve constraint rules](https://developer.conga.com/revenue/reference/get_constraint-rules-1.md): Retrieves all constraint rules with their details. Use query parameters to further narrow the results.
When executed, this API returns all constraint rules.
- [Create constraint rules](https://developer.conga.com/revenue/reference/post_constraint-rules-1.md): one or more constraint rules. It can create a maximum of 1000 constraint rules. To create multiple constraint rules, pass multiple arrays of code in the API request (one array for each constraint…
- [Update constraint rules](https://developer.conga.com/revenue/reference/patch_constraint-rules-1.md): Updates a specific fields on one or more constraint rules. It can update any fields except the constraint rule ID.
When executed, this API returns the updated constraint rules or constraint rules.
- [Delete constraint rules](https://developer.conga.com/revenue/reference/delete_constraint-rules-1.md): Deletes one or more constraint rules. It can delete 1000 constraint rules in one go. If a constraint rule is deleted, the constraint rule conditions and actions associated with it are also deleted.…
- [Retrieve a constraint rule](https://developer.conga.com/revenue/reference/get_constraint-rules-id-1.md): Retrieves a constraint rule based on the constraint rule ID passed in the path parameter.
- [Update a constraint rule](https://developer.conga.com/revenue/reference/patch_constraint-rules-id-1.md): Updates a specific fields on a constraint rule based on the constraint rule ID passed in the path parameter.
When executed, this API returns the updated constraint rule.
- [Delete a constraint rule](https://developer.conga.com/revenue/reference/delete_constraint-rules-id-1.md): Deletes a constraint rule based on the constraint rule ID passed in the path parameter. Permissions are required to delete a constraint rule.
When executed, this API returns one or more records…
- Field Expressions
- [Retrieve ConstraintRuleActionExpression](https://developer.conga.com/revenue/reference/get_field-expressions-parentid-constraint-rule-action-expressions.md): Retrieves all ConstraintRuleActionExpressions in a ConstraintRuleAction, with their details. Use query parameters to further narrow the results.
When executed, this API returns all…
- [Create ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/post_field-expressions-parentid-constraint-rule-action-expressions.md): creates one or more ConstraintRuleActionExpressions in a specific ConstraintRuleAction. It can create a maximum of 1000 ConstraintRuleActionExpressions. It can create multiple…
- [Update ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/patch_field-expressions-parentid-constraint-rule-action-expressions.md): Updates specific fields on one or more ConstraintRuleActionExpressions. It can update any field except the ConstraintRuleActionExpressions ID.
When executed, this API returns the updated…
- [Delete ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/delete_field-expressions-parentid-constraint-rule-action-expressions.md): Delete ConstraintRuleActionExpressions
- [Retrieve a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/get_field-expressions-parentid-constraint-rule-action-expressions-id.md): Retrieves a ConstraintRuleActionExpressions in a ConstraintRuleAction, with their details. Use query parameters to further narrow the results.
When executed, this API returns a…
- [Update a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/patch_field-expressions-parentid-constraint-rule-action-expressions-id.md): Updates specific fields on specified ConstraintRuleActionExpressions. It can update any field except the ConstraintRuleActionExpressions ID.
When executed, this API returns the updated…
- [Delete a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/delete_field-expressions-parentid-constraint-rule-action-expressions-id.md): Deletes a specified ConstraintRuleActionExpressions in a ConstraintRuleAction.
When executed, this API returns the delete status of associated record ID.
- [Retrieve lookup records for ConstraintRuleAction](https://developer.conga.com/revenue/reference/get_field-expressions-id-constraint-rule-actions.md): Retrieves the lookup records for a specific ConstraintRuleAction based on the identifier.
- [Retrieve field expressions](https://developer.conga.com/revenue/reference/get_field-expressions-1.md): Retrieves the collection of field expressions.
- [Create field expressions](https://developer.conga.com/revenue/reference/post_field-expressions-1.md): Creates multiple field expressions.
- [Update field expressions](https://developer.conga.com/revenue/reference/patch_field-expressions-1.md): Updates multiple field expressions.
- [Delete field expressions](https://developer.conga.com/revenue/reference/delete_field-expressions-1.md): Deletes multiple field expressions.
- [Retrieve a field expression](https://developer.conga.com/revenue/reference/get_field-expressions-id-1.md): Retrieves a single field expression by its identifier.
- [Update a field expression](https://developer.conga.com/revenue/reference/patch_field-expressions-id-1.md): Updates a single field expression.
- [Delete a field expression](https://developer.conga.com/revenue/reference/delete_field-expressions-id-1.md): Deletes a single field expression by its identifier.
- CustomSettings
- [List flows](https://developer.conga.com/revenue/reference/get_flows.md): Retrieves the list of the flows.
- [Create flows](https://developer.conga.com/revenue/reference/post_flows.md): Creates one or more custom flows based on the request body.The API also creates display action settings and display column settings with default values, which can be overriden or updated using the…
- [Get a flow by name](https://developer.conga.com/revenue/reference/get_flows-flowname.md): This API can be used to retrieve a single flow record.
- [Update a flow](https://developer.conga.com/revenue/reference/put_flows-flowname-1.md): updates a flow based on the flow name provided in the parameter.
- [Delete a flow](https://developer.conga.com/revenue/reference/delete_flows-flowname.md): Deletes a flow based on the flow name provided in the parameter.
- [Create flow actions](https://developer.conga.com/revenue/reference/post_flows-flowname-actions.md): Creates 1 or more flow actions.
- [Update flow actions](https://developer.conga.com/revenue/reference/put_flows-flowname-actions.md): Creates, updates, and deletes flow actions based on the request body, for the flow passed in the parameter.
- [Retrieve actions associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-actions.md): Retrieves actions for the flow passed in the parameter, based on the display action settings configured and the display type. The actions are defined for the following Display Types which…
- [Create flow displays](https://developer.conga.com/revenue/reference/post_flows-flowname-displays.md): Creates 1 or more displays for a flow.
- [Update flow displays](https://developer.conga.com/revenue/reference/put_flows-flowname-displays.md): Updates 1 more displays for a flow record.
- [Retrieve column displays associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-displays.md): Retrieves column displays for the flow passed in the parameter, based on the display column settings configured and the display type. The columns are defined for the following Display Types…
- [Create settings](https://developer.conga.com/revenue/reference/post_flows-flowname-settings-settingname-1.md): Creates a setting or child setting for a flow.
- [Update custom settings associated with a flow](https://developer.conga.com/revenue/reference/put_flows-flowname-settings-settingname-1.md): Updates the following categories of setting associated with a flow name provided in the parameters.
The above-mentioned…
- [Retrieve custom settings associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-settings-settingname-1.md): Retrieves the following categories of setting associated with a flow name provided in the parameters.
The above-mentioned…
- [Delete settings](https://developer.conga.com/revenue/reference/delete_flows-flowname-settings-settingname-1.md): Deletes a setting or child setting for a flow.
- [Create settings](https://developer.conga.com/revenue/reference/post_flows-flowname-settings-settingname-childsettingname.md): Creates a setting or child setting for a flow.
- [Update custom settings associated with a flow](https://developer.conga.com/revenue/reference/put_flows-flowname-settings-settingname-childsettingname.md): Updates the following categories of setting associated with a flow name provided in the parameters.
The above-mentioned…
- [Retrieve custom settings associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-settings-settingname-childsettingname.md): Retrieves the following categories of setting associated with a flow name provided in the parameters.
The above-mentioned…
- [Delete settings](https://developer.conga.com/revenue/reference/delete_flows-flowname-settings-settingname-childsettingname-1.md): Deletes a setting or child setting for a flow.
- [Retrieve custom setting defined for a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-settings.md): Retrieves the custom settings defined for a flow name provided in the parameter. When custom settings are defined at both flow-level and global-level, flow-level take precedence over global settings…
- [Create views](https://developer.conga.com/revenue/reference/post_flows-flowname-views-1.md): Creates views for a flow.
- [Update flow views](https://developer.conga.com/revenue/reference/put_flows-flowname-views-1.md): Updates one or more views for a flow record.
- [Retrieve column displays associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-views-1.md): Retrieves the column displays for the flow passed in the parameter, based on the Display Column Settings configured and the Display Type. The columns are defined for the following Display…
- [Retrieve views associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-views-viewname-1.md): Retrieves the views that are associated with the flow.
- [Delete flow views](https://developer.conga.com/revenue/reference/delete_flows-flowname-views-viewname-1.md): Deletes the views for a flow.
- Deal Color Bands
- [Retrieve deal color bands](https://developer.conga.com/revenue/reference/get_deal-guidance-color-bands-1.md): Retrieves a list of color bands by deal guidance rule. Use query parameters to further narrow the results.
- [Create deal color bands](https://developer.conga.com/revenue/reference/post_deal-guidance-color-bands-1.md): Creates one or more color bands and assigns shapes and colors to them. You can use color bands to differentiate deals and define margins intelligently.
Defining a color band is an initial,…
- [Update deal color bands](https://developer.conga.com/revenue/reference/patch_deal-guidance-color-bands-1.md): Updates specific fields on one or more color bands based on the details provided in the request body. It can update any field except the color band ID.
- [Delete deal color bands](https://developer.conga.com/revenue/reference/delete_deal-guidance-color-bands-1.md): Deletes one or more color bands based on the details provided in the request body.
- [Retrieve a deal color band](https://developer.conga.com/revenue/reference/get_deal-guidance-color-bands-id-1.md): Retrieves a single color band record based on the color band ID passed in the path parameter.
- [Update a deal color band](https://developer.conga.com/revenue/reference/patch_deal-guidance-color-bands-id-1.md): Updates specific fields on a single color band based on the color band ID passed in the path parameter.
- [Delete a deal color band](https://developer.conga.com/revenue/reference/delete_deal-guidance-color-bands-id-1.md): Deletes a color band record based on the color band ID passed in the path parameter.
- Deal Guidance Dimension Set Members
- [Retrieve deal guidance dimension set members](https://developer.conga.com/revenue/reference/get_deal-guidance-dimension-sets-parentid-dimensions-1.md): Retrieves the list of dimension set members.
- [Create deal guidance dimension set members](https://developer.conga.com/revenue/reference/post_deal-guidance-dimension-sets-parentid-dimensions-1.md): Creates the dimensions for a dimension set.
- [Update deal guidance dimension set members](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimension-sets-parentid-dimensions-1.md): Updates dimension for a dimension set.
- [Delete deal guidance dimension set members](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimension-sets-parentid-dimensions-1.md): Deletes dimension for a dimension set.
- [Retrieve a deal guidance dimension set member](https://developer.conga.com/revenue/reference/get_deal-guidance-dimension-sets-parentid-dimensions-id-1.md): Retrieves a dimension record for a given dimension set.
- [Update a deal guidance dimension set member](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimension-sets-parentid-dimensions-id-1.md): Updates a dimension record for a given dimension set.
- [Delete a deal guidance dimension set member](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimension-sets-parentid-dimensions-id-1.md): Deletes a dimension record for a given dimension set.
- Deal Guidance Dimension Sets
- [Retrieve deal guidance dimension sets](https://developer.conga.com/revenue/reference/get_deal-guidance-dimension-sets-1.md): Retrieves the list of the dimension sets for a pricing deal.
- [Create deal guidance dimension sets](https://developer.conga.com/revenue/reference/post_deal-guidance-dimension-sets-1.md): Creates the list of the dimension sets for a pricing deal.
- [Update deal guidance dimension sets](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimension-sets-1.md): Updates the list of the dimension sets for a pricing deal.
- [Delete deal guidance dimension sets](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimension-sets-1.md): Deletes the list of the dimension sets for a pricing deal.
- [Retrieve a deal guidance dimension set](https://developer.conga.com/revenue/reference/get_deal-guidance-dimension-sets-id-1.md): Retrieves a single dimension set record.
- [Update a deal guidance dimension set](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimension-sets-id-1.md): Updates one or more dimension set records based on the details provided in the request body.
- [Delete a deal guidance dimension set](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimension-sets-id-1.md): Deletes a single Deal Guidance Dimension Set by its identifier.
- Deal Guidance Dimensions
- [Retrieve deal guidance dimensions](https://developer.conga.com/revenue/reference/get_deal-guidance-dimensions-1.md): Retrieves a the list of dimensions.
- [Create deal guidance dimensions](https://developer.conga.com/revenue/reference/post_deal-guidance-dimensions-1.md): Creates one or more dimensions on a field so that you can set deal rule criteria based on the defined dimensions for a deal evaluation.
After creating dimensions, create a dimension set and make…
- [Update deal guidance dimensions](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimensions-1.md): Updates one or more dimensions based on the payload passed.
- [Delete deal guidance dimensions](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimensions-1.md): Deletes one or more dimensions based on the payload passed.
- [Retrieve a deal guidance dimension](https://developer.conga.com/revenue/reference/get_deal-guidance-dimensions-id-1.md): Retrieves a single deal guidance dimension by its identifier.
- [Update a deal guidance dimension](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimensions-id-1.md): Updates the details of a dimension record.
- [Delete a deal guidance dimension](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimensions-id-1.md): Deletes a details of a dimension record.
- Deal Guidance Rule Entries
- [Retrieve deal guidance rule entries](https://developer.conga.com/revenue/reference/get_deal-guidance-rules-parentid-entries-1.md): Retrieves the list of rules entries for deal guidance rules.
- [Create deal guidance rule entries](https://developer.conga.com/revenue/reference/post_deal-guidance-rules-parentid-entries-1.md): Creates one or more rule entries for a deal guidance rule.
- [Update deal guidance rule entries](https://developer.conga.com/revenue/reference/patch_deal-guidance-rules-parentid-entries-1.md): Update one or more rule entries for a deal guidance rule.
- [Delete deal guidance rule entries](https://developer.conga.com/revenue/reference/delete_deal-guidance-rules-parentid-entries-1.md): Delete one or more rule entries for a deal guidance rule.
- [Retrieve a deal guidance rule entry](https://developer.conga.com/revenue/reference/get_deal-guidance-rules-parentid-entries-id-1.md): Retrieves a single rule entry for a deal guidance rule.
- [Update a deal guidance rule entry](https://developer.conga.com/revenue/reference/patch_deal-guidance-rules-parentid-entries-id-1.md): Updates a single rule entry for a deal guidance rule.
- [Delete a deal guidance rule entry](https://developer.conga.com/revenue/reference/delete_deal-guidance-rules-parentid-entries-id-1.md): Delete a single rule entry for a deal guidance rule.
- Deal Guidance Rules
- [Retrieve deal guidance rules](https://developer.conga.com/revenue/reference/get_deal-guidance-rules-1.md): Retrieves the list of rules for a deal.
- [Create deal guidance rules](https://developer.conga.com/revenue/reference/post_deal-guidance-rules-1.md): Creates one or more deal guidance rules based on details provided in the request body.
- [Update deal guidance rules](https://developer.conga.com/revenue/reference/patch_deal-guidance-rules-1.md): Updates one or more deal guidance rules based on the details provided in the request body.
- [Delete deal guidance rules](https://developer.conga.com/revenue/reference/delete_deal-guidance-rules-1.md): Deletes one or more deal guidance rules based on the Ids provided in the request body.
- [Retrieve a deal guidance rule](https://developer.conga.com/revenue/reference/get_deal-guidance-rules-id-1.md): Retrieves a single deal guidance rule record.
- [Update a deal guidance rule](https://developer.conga.com/revenue/reference/patch_deal-guidance-rules-id-1.md): Updates a single deal guidance rule record.
- [Delete a deal guidance rule](https://developer.conga.com/revenue/reference/delete_deal-guidance-rules-id-1.md): Deletes a single deal guidance rule record.
- Feature
- [Retrieve features](https://developer.conga.com/revenue/reference/get_feature-sets-parentid-features-1.md): Retrieves a collection of features based on the parent feature set.
- [Create features](https://developer.conga.com/revenue/reference/post_feature-sets-parentid-features-1.md): Adds one or more features to the feature set collection. The parent feature set is automatically filled.
- [Update features](https://developer.conga.com/revenue/reference/patch_feature-sets-parentid-features-1.md): Updates one or more features in the feature set collection. Parent reassignment is not allowed.
- [Delete features](https://developer.conga.com/revenue/reference/delete_feature-sets-parentid-features-1.md): Deletes one or more features from the feature set collection.
- [Retrieve a feature](https://developer.conga.com/revenue/reference/get_feature-sets-parentid-features-id-1.md): Retrieves a single feature document based on the identifier and parent feature set.
- [Update a feature](https://developer.conga.com/revenue/reference/patch_feature-sets-parentid-features-id-1.md): Updates a single feature document based on the identifier and parent feature set.
- [Delete a feature](https://developer.conga.com/revenue/reference/delete_feature-sets-parentid-features-id-1.md): Deletes a single feature document based on the identifier and parent feature set.
- Feature Sets
- [Retrieve feature sets](https://developer.conga.com/revenue/reference/get_feature-sets-1.md): Retrieves the collection of feature sets.
- [Create feature sets](https://developer.conga.com/revenue/reference/post_feature-sets-1.md): Creates multiple feature sets.
- [Update feature sets](https://developer.conga.com/revenue/reference/patch_feature-sets-1.md): Updates multiple feature sets.
- [Delete feature sets](https://developer.conga.com/revenue/reference/delete_feature-sets-1.md): Deletes multiple feature sets.
- [Retrieve a feature set](https://developer.conga.com/revenue/reference/get_feature-sets-id-1.md): Retrieves a single feature set by its identifier.
- [Update a feature set](https://developer.conga.com/revenue/reference/patch_feature-sets-id-1.md): Updates a single feature set.
- [Delete a feature set](https://developer.conga.com/revenue/reference/delete_feature-sets-id-1.md): Deletes a single feature set by its identifier.
- [Retrieve product features](https://developer.conga.com/revenue/reference/get_feature-sets-parentid-product-features-1.md): Retrieves a list of junction records.
- [Create product features](https://developer.conga.com/revenue/reference/post_feature-sets-parentid-product-features-1.md): Creates multiple junction records.
- [Update product features](https://developer.conga.com/revenue/reference/patch_feature-sets-parentid-product-features-1.md): Updates multiple junction records.
- [Delete product features](https://developer.conga.com/revenue/reference/delete_feature-sets-parentid-product-features-1.md): Deletes multiple junction records.
- [Retrieve a product feature](https://developer.conga.com/revenue/reference/get_feature-sets-parentid-product-features-id-1.md): Retrieves a specific junction record.
- [Update a product feature](https://developer.conga.com/revenue/reference/patch_feature-sets-parentid-product-features-id-1.md): Updates a specific junction record.
- [Delete a product feature](https://developer.conga.com/revenue/reference/delete_feature-sets-parentid-product-features-id-1.md): Deletes a specific junction record.
- Hierarchies
- [Update hierarchies](https://developer.conga.com/revenue/reference/patch_hierarchies-1.md): Updates one or more hierarchy records.
- [Retrieve hierarchies](https://developer.conga.com/revenue/reference/get_hierarchies-1.md): Retrieves the hierarchy records.
- [Create hierarchies](https://developer.conga.com/revenue/reference/post_hierarchies-1.md): Creates one or more hierarchy records.
- [Delete hierarchies](https://developer.conga.com/revenue/reference/delete_hierarchies-1.md): Deletes one or more hierarchy records.
- [Update a hierarchy](https://developer.conga.com/revenue/reference/patch_hierarchies-id-1.md): Updates a single hierarchy record.
- [Retrieve a hierarchy](https://developer.conga.com/revenue/reference/get_hierarchies-id-1.md): Retrieves a single hierarchy record.
- [Delete a hierarchy](https://developer.conga.com/revenue/reference/delete_hierarchies-id-1.md): Deletes a single hierarchy record.
- [Retrieve price list categories](https://developer.conga.com/revenue/reference/get_hierarchies-parentid-price-list-categories-1.md): Retrieve price list categories
- [Create price list categories](https://developer.conga.com/revenue/reference/post_hierarchies-parentid-price-list-categories-1.md): Create price list categories
- [Update price list categories](https://developer.conga.com/revenue/reference/patch_hierarchies-parentid-price-list-categories-1.md): Update price list categories
- [Delete price list categories](https://developer.conga.com/revenue/reference/delete_hierarchies-parentid-price-list-categories-1.md): Delete price list categories
- [Retrieve a price list category](https://developer.conga.com/revenue/reference/get_hierarchies-parentid-price-list-categories-id-1.md): Retrieve a price list category
- [Update a price list category](https://developer.conga.com/revenue/reference/patch_hierarchies-parentid-price-list-categories-id-1.md): Update a price list category
- [Delete a price list category](https://developer.conga.com/revenue/reference/delete_hierarchies-parentid-price-list-categories-id-1.md): Delete a price list category
- Incentive Coupons
- [Retrieve incentive coupons](https://developer.conga.com/revenue/reference/get_incentives-parentid-coupons-1.md): Retrieves a collection of incentive coupons based on the parent incentive.
- [Create incentive coupons](https://developer.conga.com/revenue/reference/post_incentives-parentid-coupons-1.md): Adds one or more incentive coupons to the collection. The parent incentive is automatically filled.
- [Update incentive coupons](https://developer.conga.com/revenue/reference/patch_incentives-parentid-coupons-1.md): Updates one or more incentive coupons in the collection. Parent reassignment is not allowed.
- [Delete incentive coupons](https://developer.conga.com/revenue/reference/delete_incentives-parentid-coupons-1.md): Deletes one or more incentive coupons from the collection.
- [Retrieve an incentive coupon](https://developer.conga.com/revenue/reference/get_incentives-parentid-coupons-id-1.md): Retrieves a single incentive coupon document based on the identifier and parent incentive.
- [Update an incentive coupon](https://developer.conga.com/revenue/reference/patch_incentives-parentid-coupons-id-1.md): Updates a single incentive coupon document based on the identifier and parent incentive.
- [Delete an incentive coupon](https://developer.conga.com/revenue/reference/delete_incentives-parentid-coupons-id-1.md): Deletes a single incentive coupon document based on the identifier and parent incentive.
- [Auto generates specified number of incentive coupons](https://developer.conga.com/revenue/reference/post_incentives-parentid-coupons-generate-numberofcoupons-1.md): Auto generates specified number of incentive coupons. The parent incentive is automatically filled.
- Incentive Limits
- [Retrieve incentive limits](https://developer.conga.com/revenue/reference/get_incentives-parentid-limits-1.md): Retrieves a collection of incentive limits based on the parent incentive.
- [Create incentive limits](https://developer.conga.com/revenue/reference/post_incentives-parentid-limits-1.md): Adds one or more incentive limits to the collection. The parent incentive is automatically filled.
- [Update incentive limits](https://developer.conga.com/revenue/reference/patch_incentives-parentid-limits-1.md): Updates one or more incentive limits in the collection. Parent reassignment is not allowed.
- [Delete incentive limits](https://developer.conga.com/revenue/reference/delete_incentives-parentid-limits-1.md): Deletes one or more incentive limits from the collection.
- [Retrieve an incentive limit](https://developer.conga.com/revenue/reference/get_incentives-parentid-limits-id-1.md): Retrieves a single incentive limit document based on the identifier and parent incentive.
- [Update an incentive limit](https://developer.conga.com/revenue/reference/patch_incentives-parentid-limits-id-1.md): Updates a single incentive limit document based on the identifier and parent incentive.
- [Delete an incentive limit](https://developer.conga.com/revenue/reference/delete_incentives-parentid-limits-id-1.md): Deletes a single incentive limit document based on the identifier and parent incentive.
- Incentive Rule Entries
- [Retrieve incentive rule entries](https://developer.conga.com/revenue/reference/get_incentive-rules-parentid-entries-1.md): Retrieves a collection of incentive rule entries based on the parent incentive rule.
- [Create incentive rule entries](https://developer.conga.com/revenue/reference/post_incentive-rules-parentid-entries-1.md): Adds one or more incentive rule entries to the collection. The parent incentive rule is automatically filled.
- [Update incentive rule entries](https://developer.conga.com/revenue/reference/patch_incentive-rules-parentid-entries-1.md): Updates one or more incentive rule entries in the collection. Parent reassignment is not allowed.
- [Delete incentive rule entries](https://developer.conga.com/revenue/reference/delete_incentive-rules-parentid-entries-1.md): Deletes one or more incentive rule entries from the collection.
- [Retrieve an incentive rule entry](https://developer.conga.com/revenue/reference/get_incentive-rules-parentid-entries-id-1.md): Retrieves a single incentive rule entry document based on the identifier and parent incentive rule.
- [Update an incentive rule entry](https://developer.conga.com/revenue/reference/patch_incentive-rules-parentid-entries-id-1.md): Updates a single incentive rule entry document based on the identifier and parent incentive rule.
- [Delete an incentive rule entry](https://developer.conga.com/revenue/reference/delete_incentive-rules-parentid-entries-id-1.md): Deletes a single incentive rule entry document based on the identifier and parent incentive rule.
- Incentive Rules
- [Retrieve incentive rules](https://developer.conga.com/revenue/reference/get_incentives-parentid-rules-1.md): Retrieves a collection of incentive rules based on the parent incentive.
- [Create incentive rules](https://developer.conga.com/revenue/reference/post_incentives-parentid-rules-1.md): Adds one or more incentive rules to the collection. The parent incentive is automatically filled.
- [Update incentive rules](https://developer.conga.com/revenue/reference/patch_incentives-parentid-rules-1.md): Updates one or more incentive rules in the collection. Parent reassignment is not allowed.
- [Delete incentive rules](https://developer.conga.com/revenue/reference/delete_incentives-parentid-rules-1.md): Deletes one or more incentive rules from the collection.
- [Retrieve an incentive rule](https://developer.conga.com/revenue/reference/get_incentives-parentid-rules-id-1.md): Retrieves a single incentive rule document based on the identifier and parent incentive.
- [Update an incentive rule](https://developer.conga.com/revenue/reference/patch_incentives-parentid-rules-id-1.md): Updates a single incentive rule document based on the identifier and parent incentive.
- [Delete an incentive rule](https://developer.conga.com/revenue/reference/delete_incentives-parentid-rules-id-1.md): Deletes a single incentive rule document based on the identifier and parent incentive.
- Incentives
- [Retrieve incentives](https://developer.conga.com/revenue/reference/get_incentives-1.md): Retrieves the collection of incentives.
- [Create incentives](https://developer.conga.com/revenue/reference/post_incentives-1.md): Creates multiple incentives.
- [Update incentives](https://developer.conga.com/revenue/reference/patch_incentives-1.md): Updates multiple incentives.
- [Delete incentives](https://developer.conga.com/revenue/reference/delete_incentives-1.md): Deletes multiple incentives.
- [Retrieve an incentive](https://developer.conga.com/revenue/reference/get_incentives-id-1.md): Retrieves a single incentive by its identifier.
- [Update an incentive](https://developer.conga.com/revenue/reference/patch_incentives-id-1.md): Updates a single incentive.
- [Delete an incentive](https://developer.conga.com/revenue/reference/delete_incentives-id-1.md): Deletes a single incentive by its identifier.
- Lookup Field Settings
- [Retrieve lookup field settings](https://developer.conga.com/revenue/reference/get_lookupfield-settings-1.md): Retrieves the collection of lookup field settings.
- [Create lookup field settings](https://developer.conga.com/revenue/reference/post_lookupfield-settings-1.md): Creates multiple lookup field settings.
- [Update lookup field settings](https://developer.conga.com/revenue/reference/patch_lookupfield-settings-1.md): Updates multiple lookup field settings.
- [Delete lookup field settings](https://developer.conga.com/revenue/reference/delete_lookupfield-settings-1.md): Deletes multiple lookup field settings.
- [Retrieve a lookup field setting](https://developer.conga.com/revenue/reference/get_lookupfield-settings-id-1.md): Retrieves a single lookup field setting by its identifier.
- [Update a lookup field setting](https://developer.conga.com/revenue/reference/patch_lookupfield-settings-id-1.md): Updates a single lookup field setting.
- [Delete a lookup field setting](https://developer.conga.com/revenue/reference/delete_lookupfield-settings-id-1.md): Deletes a single lookup field setting by its identifier.
- OpenSearchSyncAudit
- [Get OpenSearchSyncAudit Records](https://developer.conga.com/revenue/reference/get_open-search-sync-audit-1.md): Retrieves OpenSearch synchronization audit records with optional filtering. Supports filtering by entity name, record IDs, and date range (start and end dates). Results are paginated with 500 records…
- Option Group Members
- [Retrieve option group members](https://developer.conga.com/revenue/reference/get_option-groups-parentid-products-1.md): Retrieves one or more products for an option group.
- [Create option group members](https://developer.conga.com/revenue/reference/post_option-groups-parentid-products-1.md): Creates one or more products to an option group by creating option group members.
- [Update option group members](https://developer.conga.com/revenue/reference/patch_option-groups-parentid-products-1.md): Updates one or more options associated with an option group. This API adds or removes options or updates option details in an option group.
- [Delete option group members](https://developer.conga.com/revenue/reference/delete_option-groups-parentid-products-1.md): Deletes one or more Products from an option group.
- [Retrieve an option group member](https://developer.conga.com/revenue/reference/get_option-groups-parentid-products-id-1.md): Retrieves a single product for an option group.
- [Update an option group member](https://developer.conga.com/revenue/reference/patch_option-groups-parentid-products-id-1.md): Updates a single product for an option group.
- [Delete an option group member](https://developer.conga.com/revenue/reference/delete_option-groups-parentid-products-id-1.md): Deletes a single product for an option group.
- Option Groups
- [Retrieve an option group](https://developer.conga.com/revenue/reference/get_option-groups-id-1.md): Retrieves details of a single option group.
- [Delete an option group](https://developer.conga.com/revenue/reference/delete_option-groups-id-1.md): Deletes a single option group record.
- [Update an option group](https://developer.conga.com/revenue/reference/patch_option-groups-id-1.md): Updates a single option group record.
- [Create an option group clone](https://developer.conga.com/revenue/reference/post_option-groups-id-clone-1.md): Creates a clone of the Option Group with the specified identifier.
- [Retrieve option groups](https://developer.conga.com/revenue/reference/get_option-groups-1.md): Retrieves details of one or more option groups.
The API returns the structure of each option group which includes the following details among others: When executed, this API returns all constraint rules. **Note:** There can be only one default preference record.
Accepted values for Origin:
dynamics
sharepoint
…
- [Creates a new callback for a specified connector.](https://developer.conga.com/doc-automation/reference/callback_addconnectorcallback-1.md): Creates a new callback for a specified connector, such as a SalesforceOauth2 connector, or a Microsoft CRM connector.
Accepted values for Origin:
dynamics
sharepoint
dynamics2011…
- ComprehensiveHealthCheck
- [Checks for comprehensive health](https://developer.conga.com/doc-automation/reference/comprehensivehealthcheck_checkcomprehensivehealth.md)
- CustomerOnboarded
- [Get Customer Onboarded](https://developer.conga.com/doc-automation/reference/customeronboarded_get-1.md)
- CustomerRegistration
- [CONGA-ONLY
Delete OneSpanCallback Customer Registration](https://developer.conga.com/doc-automation/reference/customerregistration_delete-1.md)
- [CONGA-ONLY
Register OneSpanCallback Customer Information](https://developer.conga.com/doc-automation/reference/customerregistration_post-1.md)
- [CONGA-ONLY
Get OneSpanCallback Customer Information](https://developer.conga.com/doc-automation/reference/customerregistration_get.md)
- CustomFields
- [Create a custom field](https://developer.conga.com/doc-automation/reference/customfields_createcustomfield-1.md)
- [List all custom fields. Query parameters "to" and "from" are expected to navigate pages.](https://developer.conga.com/doc-automation/reference/customfields_listcustomfields-1.md)
- [Update a custom field](https://developer.conga.com/doc-automation/reference/customfields_updatecustomfield-1.md)
- [Delete a custom account field by ID](https://developer.conga.com/doc-automation/reference/customfields_deletecustomfield-1.md)
- [Retrieve an account specified custom field](https://developer.conga.com/doc-automation/reference/customfields_getcustomfield-1.md)
- DataManagement
- [Retrieve the data management policy for the account](https://developer.conga.com/doc-automation/reference/datamanagement_getdatamanagementpolicy-1.md): Retrieves the data management policy for the account.
- [Update the account's data management policy](https://developer.conga.com/doc-automation/reference/datamanagement_updatedatamanagementpolicy-1.md): Updates data management policy for the account.
- [Retrieve the expiry configurations defined for the account](https://developer.conga.com/doc-automation/reference/datamanagement_getexpirytimeconfiguration-1.md): Retrieves the expiry configurations defined for the account. A value of 0 indicates unlimited.
- [Update the expiry configurations defined for the account](https://developer.conga.com/doc-automation/reference/datamanagement_updateexpirytimeconfiguration-1.md): Updates the expiry configurations defined for the account. For unlimited data retention, assign the “Expiry date” the value 0.
- Documents
- [Retrieve the specified document](https://developer.conga.com/doc-automation/reference/documents_getdocument-1.md): Retrieves all information related to a given document, including ID, name, description, presentation index, any associated data elements, approvals and fields.
- [Update a document](https://developer.conga.com/doc-automation/reference/documents_updatedocument-1.md): Updates a single, specified document. This endpoint accepts multi-part data, or the JSON structure of a document.
- [Update the specified document](https://developer.conga.com/doc-automation/reference/documents_updatedocumentput-1.md): Updates the specified document.
- [Delete a document from a package](https://developer.conga.com/doc-automation/reference/documents_deletedocument-1.md): Deletes a document from a specified package.
- [Retrieve zipped documents](https://developer.conga.com/doc-automation/reference/documents_getzip-1.md): Retrieves a zipped file that contains all documents that were added to the package.
- [Retrieve document visibility information](https://developer.conga.com/doc-automation/reference/documents_getdocumentvisibility-1.md): Retrieves information about which recipients can view specific documents in a package during a Signing Ceremony.
- [Update document visibility](https://developer.conga.com/doc-automation/reference/documents_updatedocumentsvisibility-1.md): Retrieves information about which recipients can view specific documents in a package during a Signing Ceremony. The response is a Document Visibility object that contains a list of configurations.…
- [Retrieve an original PDF document](https://developer.conga.com/doc-automation/reference/documents_getoriginaldocument-1.md): Retrieves the original PDF document that was included in a package.
- [Retrieve a specific document in PDF form](https://developer.conga.com/doc-automation/reference/documents_getpdfdocument-1.md): Retrieves a specific document. This function always returns the PDF version of the document, even if the document was originally submitted in a different format.
- [Retrieve a page](https://developer.conga.com/doc-automation/reference/documents_getdocumentpagebyindex-1.md): Retrieves the document page you specify, returning it as a .png image file.
- [Add a new document to an existing package](https://developer.conga.com/doc-automation/reference/documents_createdocument-1.md): Adds a new document to an existing package by using a document resource.
- [Update documents](https://developer.conga.com/doc-automation/reference/documents_updatedocuments-1.md): Updates the documents in a package. For example, to re-order them.
- [Delete multiple documents from a package](https://developer.conga.com/doc-automation/reference/documents_deletedocuments-1.md): Deletes multiple documents, identified by their documentID, from a specified package.
- [Create a signature confirmation](https://developer.conga.com/doc-automation/reference/documents_createsignatureconfirmation-1.md): Confirms that the application can execute the signing process on the document.
- [Sign all documents in a package](https://developer.conga.com/doc-automation/reference/documents_signalldocuments-1.md): Signs all documents in a specified package.
- [Apply a layout to a document](https://developer.conga.com/doc-automation/reference/documents_applylayouttodocument-1.md): Applies a specific layout to a specified document. At least one parameter needs to be applied, either layoutID, or layoutName.
- [Retrieve zipped file containing all documents including supporting documents](https://developer.conga.com/doc-automation/reference/documents_getalldocumentszip.md): Retrieves a zipped file that contains both signable documents and Supporting Documents. This differs from the /zip endpoint which only returns signable documents.
- [Replace approvals and imprint fields for a document](https://developer.conga.com/doc-automation/reference/documents_replacedocumentfields.md): Replaces approvals and imprint fields with those provided in the request. - If an array is not provided then nothing will be updated for that field type. - If an empty array is provided then all…
- [Update document custom metadata](https://developer.conga.com/doc-automation/reference/documents_updatedocumentmetadata.md): Updates the document custom metadata by overriding it with those in the payload. Internal metadata defined by OneSpan cannot be updated and will be ignored if included in the payload. Metadata is…
- ExternalAuthentication
- [Retrieve external authentication options](https://developer.conga.com/doc-automation/reference/externalauthentication_getexternalauthenticationoptions.md): Retrieves the external authentication options configured for the current account, including available SSO providers and authentication methods.
- FileAttachment
- [Download all attachments](https://developer.conga.com/doc-automation/reference/fileattachment_getzipattachment-1.md): Compresses all attachments into a zip file, which is then downloaded.
- [Download all attachments for a specific role](https://developer.conga.com/doc-automation/reference/fileattachment_getzipattachmentbyrole-1.md): Compresses all attachments into a zip file and then downloads it. Only attachments for the specified role are included.
- [Download an attachment](https://developer.conga.com/doc-automation/reference/fileattachment_getattachmentbyid-1.md): Downloads the specified attachment.
- [Add an attachment](https://developer.conga.com/doc-automation/reference/fileattachment_addattachment-1.md): Uploads an attachment to the specified package.
- [Delete an attachment file](https://developer.conga.com/doc-automation/reference/fileattachment_deleteattachmentfile-1.md): Deletes specific attachment file.
- [Download an attachment](https://developer.conga.com/doc-automation/reference/fileattachment_getattachmentfile-1.md): Downloads a specified attachment from a package.
- [Check for a specific attachment](https://developer.conga.com/doc-automation/reference/fileattachment_checkattachmentfileexists-1.md): Checks whether or not the specified attachment exists in the package.
- [Check for signer uploads](https://developer.conga.com/doc-automation/reference/fileattachment_checkattachmentexists-1.md): Verifies whether or not the specified attachment contains any uploads from the Signer.
- [Check for attachments and uploads by role](https://developer.conga.com/doc-automation/reference/fileattachment_checkzipattachmentbyroleexists-1.md): Verifies whether or not there are any attachments for the specified role, and whether or not those attachments contain uploads from a Signer.
- IdvEvidenceSummary
- [Get IDV evidence summary](https://developer.conga.com/doc-automation/reference/idvevidencesummary_getidvevidencesummary.md): Retrieves IDV Evidence Summary in Json format when package id is provided.
- [Get IDV evidence summary image URLs](https://developer.conga.com/doc-automation/reference/idvevidencesummary_getidvevidencesummaryimages.md): Gets a list of image in Detailed Verification Report when package id is provided.
- [Get IDV evidence summary signer image](https://developer.conga.com/doc-automation/reference/idvevidencesummary_getidvevidencesummarysignerimage.md): Downloads selected IDV image in binary format when package id, idv transaction id and image urls are provided.
- IdvWorkflow
- [Retrieve the IDV authentication workflow](https://developer.conga.com/doc-automation/reference/idvworkflow_getidvworkflowconfigs-1.md): Retrieves the IDV workflow configurations as JSON. The IDV workflow configuration is the secure agreement automation workflow that integrates with Conga Sign. This must be set in the back office.
- [Create an IDV authentication workflow configuration](https://developer.conga.com/doc-automation/reference/idvworkflow_createidvworkflowconfigs-1.md): Creates a workflow configuration for IDV authentication. The following types of workflow configurations can be created: DV and DVF. The IDV workflow configuration is the secure agreement automation…
- [Update IDV workflow configuration](https://developer.conga.com/doc-automation/reference/idvworkflow_updateidvworkflowconfigs-1.md): Updates the IDV workflow configuration. The IDV workflow configuration is the secure agreement automation workflow that integrates with Conga Sign. This must be set in the back office.
- [Delete IDV workflow configuration](https://developer.conga.com/doc-automation/reference/idvworkflow_deleteidvworkflowconfigs-1.md): Deletes the IDV workflow configuration. The IDV workflow configuration is the secure agreement automation workflow that integrates with Conga Sign. This must be set in the back office.
- IFWorkflowConfiguration
- [Retrieve IF workflow configuration information](https://developer.conga.com/doc-automation/reference/ifworkflowconfiguration_getifworkflowconfiguration.md): Retrieves IF workflow configuration information for the current account.
- ImprintFields
- [Creates new imprint field with an autogenerated id.](https://developer.conga.com/doc-automation/reference/imprintfields_postimprintfield.md): Creates new imprint field with an autogenerated id.
- [Deletes all imprint fields assigned to the document.](https://developer.conga.com/doc-automation/reference/imprintfields_deleteimprintfields.md): Deletes all imprint fields assigned to the document.
- [Replaces all imprint fields with those provided in the request.](https://developer.conga.com/doc-automation/reference/imprintfields_updateimprintfields.md): Replaces all imprint fields with those provided in the request. If an empty array is provided then all fields will be deleted. Only the editable imprint fields will be replaced.
- [Retrieves existing imprint field.](https://developer.conga.com/doc-automation/reference/imprintfields_getexistingimprintfield.md): Retrieves existing imprint field.
- [Deletes existing imprint field.](https://developer.conga.com/doc-automation/reference/imprintfields_deleteimprintfields2.md): Deletes existing imprint field.
- [Update existing imprint field.](https://developer.conga.com/doc-automation/reference/imprintfields_updateexistingimprintfield.md): Updates existing imprint field. Note that the JSON Field ID will be ignored and replaced by the one from the query parameter.
- [Copies the imprint field to the other documents in the package.](https://developer.conga.com/doc-automation/reference/imprintfields_imprintfieldcopies.md): Copies the imprint field to the other documents in the package. When it is not possible to add a field due to the lack of a given page number, the field will be added on the last page of this…
- InAppReports
- [Retrieve reports by date and type](https://developer.conga.com/doc-automation/reference/inappreports_getallinappreports-1.md): Retrieves reports for the specified dates and report type for all accounts.
- [Delete the specified report files (csv)](https://developer.conga.com/doc-automation/reference/inappreports_deleteallinappreports-1.md): Deletes the specified report files (csv).
- [Retrieve report summaries by date and report type](https://developer.conga.com/doc-automation/reference/inappreports_getallinappreportsummaries-1.md): Retrieves report summaries for the specified dates and report type for all accounts.
- [Retrieve a report file (csv)](https://developer.conga.com/doc-automation/reference/inappreports_getinappreportbyid-1.md): Retrieves the specified report file (csv).
- [Delete a report file by ID (csv)](https://developer.conga.com/doc-automation/reference/inappreports_deleteinappreportbyid-1.md): Deletes the specified report file by ID (csv).
- [Retrieve zipped csv reports](https://developer.conga.com/doc-automation/reference/inappreports_getinappreportaszip-1.md): Retrieves the specified report files (csv) as a zip file.
- Layout
- [List available layouts](https://developer.conga.com/doc-automation/reference/layout_getlayouts-1.md): Retrieves a list of available layouts, which you can filter and sort. By default, this call returns the API caller's layouts. When specifying either the ownerUserId or ownerEmail query parameter,…
- [Create a new layout](https://developer.conga.com/doc-automation/reference/layout_createlayout-1.md): Creates a new layout.
- Notification
- [Re-send a notification to a signer](https://developer.conga.com/doc-automation/reference/notification_resendsmscodeforsigner-1.md): Resends a notification to a signer.
- [Re-send a notification to a signer](https://developer.conga.com/doc-automation/reference/notification_resendnotificationsforpackage-1.md): Resends a notification to a signer.
- [Send an SMS notification to signers linked to a role](https://developer.conga.com/doc-automation/reference/notification_resendnotificationsforpackageandrole-1.md): Sends an SMS notification to the signers linked to a role.
- [Send an SMS notification to signers linked to a role](https://developer.conga.com/doc-automation/reference/notification_resendsmsnotificationsforpackageandrole-1.md): Sends an SMS notification to the signers linked to a role.
- [Send mobile notification](https://developer.conga.com/doc-automation/reference/notification_resendmobilenotificationsforpackagedocumentapproval-1.md): Sends a notification to yourself. Included in the notification is a mobile-device signing link to an approval.
- OAuth2
- [List all OAuth2 clients](https://developer.conga.com/doc-automation/reference/oauth2_listoauth2clients.md): Retrieves a list of all OAuth2 clients associated with the authenticated account. This endpoint returns basic information about each OAuth2 client, including the account UID, client alias, client ID,…
- [Create a new OAuth2 client](https://developer.conga.com/doc-automation/reference/oauth2_createoauth2client.md): Creates a new OAuth2 client for the authenticated account. The client will be assigned a unique client ID and client secret that can be used for OAuth2 authentication flows. The client secret is only…
- [Delete an OAuth2 client](https://developer.conga.com/doc-automation/reference/oauth2_deleteoauth2client.md): Permanently deletes an OAuth2 client from the authenticated account. Once deleted, the client ID and secret will no longer be valid for authentication. This action cannot be undone. Any existing…
- [Regenerate OAuth2 client secret](https://developer.conga.com/doc-automation/reference/oauth2_regenerateoauth2clientsecret.md): Generates a new client secret for an existing OAuth2 client. The old client secret will be immediately invalidated and any existing access tokens generated with the old secret will be revoked. The…
- [Generate an OAuth2 access token](https://developer.conga.com/doc-automation/reference/oauth2_generateoauth2token.md): Standard OAuth2 token endpoint for obtaining access tokens using the client credentials grant flow. This endpoint is used to exchange OAuth2 client credentials for an access token that can be used to…
- OneSpanPackage
- [List packages](https://developer.conga.com/doc-automation/reference/onespanpackage_listpackages-1.md): Retrieves a list of document packages in an account. By default, this call returns the API caller's packages. When either the ownerUserId or ownerEmail query parameter is specified, this call returns…
- OneSpanUrl
- [Retrieves OneSpan BaseURL for different regions](https://developer.conga.com/doc-automation/reference/onespanurl_get-1.md): Retrieves OneSpan BaseURL for different regions
- Package
- [List packages](https://developer.conga.com/doc-automation/reference/package_listpackages-1.md): Retrieves a list of document packages in an account. By default, this call returns the API caller's packages. When either the ownerUserId or ownerEmail query parameter is specified, this call returns…
- [Create a package](https://developer.conga.com/doc-automation/reference/package_createpackage-1.md): Creates a new package or a template with no attachments. To create a template, set Type to Template. To create a package with attachments, see "Create a package with attachments".
- [Get package information](https://developer.conga.com/doc-automation/reference/package_getpackagebyid-1.md): Retrieves information about a document package.
- [Update a package](https://developer.conga.com/doc-automation/reference/package_updatepackage-1.md): Updates the information pertaining to a specified package.
- [Delete a package](https://developer.conga.com/doc-automation/reference/package_deletepackagebyid-1.md): Deletes a specified package or template.
- [Get package readiness](https://developer.conga.com/doc-automation/reference/package_getpackagereadiness-1.md): Retrieves a package's readiness to be sent for signature. This API returns a True status when the package is ready to send.
- [Get package audit details](https://developer.conga.com/doc-automation/reference/package_getpackageaudit-1.md): Retrieves a package's audit details. The audit trail is embedded directly in the package and can be viewed any time.
- [Summarize package evidence](https://developer.conga.com/doc-automation/reference/package_getpackageevidencesummary-1.md): Retrieves summary evidence information for a specified package.
- [List package fields](https://developer.conga.com/doc-automation/reference/package_getpackagefieldsummary-1.md): Retrieves a list of form fields in a package. Fields are grouped by document and by signer.
- [/v1/cs-packages/{packageId}/referencedConditions](https://developer.conga.com/doc-automation/reference/package_getpackagereferencedconditions-1.md)
- [Retrieve all approvals by signer](https://developer.conga.com/doc-automation/reference/package_getpackagesignerapprovals-1.md): Retrieves all approvals for a specified signer in a specific package.
- [Get package signing status](https://developer.conga.com/doc-automation/reference/package_getpackagesigningstatus-1.md): Retrieves the signing status of a package. Retrieved information can be filtered by signer or by document.
- [Get package signature URL](https://developer.conga.com/doc-automation/reference/package_getsigningurlbyroleid-1.md): Retrieves the URL that a signer can use to sign a package. This can only be done to a package that is not modifiable (e.g., a sent package). It cannot be done to a package in a draft state.
- [Create packages](https://developer.conga.com/doc-automation/reference/package_createpackagesusingbulksend-1.md): Create and send packages using bulk send. The package ID must be of type template. **Prerequisites** * Enable the bulk send feature in your account. * Create an eligible template. A…
- [Re-create a package or template](https://developer.conga.com/doc-automation/reference/package_createpackageclone-1.md): Creates a package or template from an existing package or template. To create a template, set type in the request body to "TEMPLATE".
- PasswordPolicy
- [Retrieve password policy information](https://developer.conga.com/doc-automation/reference/passwordpolicy_getpasswordpolicy.md): Retrieves the password policy configuration for the current account.
- [Update password policy configuration](https://developer.conga.com/doc-automation/reference/passwordpolicy_updatepasswordpolicy.md): Updates the password policy configuration for the current account.
- Reminder
- [Retrieve a package's reminder schedule](https://developer.conga.com/doc-automation/reference/reminder_getreminders-1.md): Retrieves the reminder schedule of a package. A reminder schedule for the package must already exist.
- [Create a reminder schedule](https://developer.conga.com/doc-automation/reference/reminder_createreminders-1.md): The user can only create a reminder schedule on packages that are not yet sent. All reminders are created automatically by the system when a package is sent.
- [Update a reminder schedule](https://developer.conga.com/doc-automation/reference/reminder_updatereminders-1.md): Updates the specified package's reminder schedule. This resource is not available for packages whose status is SENT.
- [Delete a reminder schedule](https://developer.conga.com/doc-automation/reference/reminder_deletereminders-1.md): Deletes the reminder schedule of the specified package.
- Reports
- [Report this sender's usage](https://developer.conga.com/doc-automation/reference/reports_getusagereport-1.md): Retrieves a usage report for the sender currently logged into the account.
- [Report completions by sender](https://developer.conga.com/doc-automation/reference/reports_getcompletionreport-1.md): Retrieves a completion report for the specified sender.
- [Report senders' usage for this account](https://developer.conga.com/doc-automation/reference/reports_getsendertransactionsummaryreport-1.md): Retrieves a paginated usage report for the sender currently logged into the account.
- [Retrieve a usage report of transactions](https://developer.conga.com/doc-automation/reference/reports_gettransactionsummaryreport-1.md): Retrieves a paginated usage report for the current account.
- [Report transaction details for transactionId](https://developer.conga.com/doc-automation/reference/reports_gettransactiondetailreportbyid-1.md): Retrieves a transaction details report for a specified transaction ID.
- [Report current sender's usage](https://developer.conga.com/doc-automation/reference/reports_getdelegationreport-1.md): Retrieves a usage report for the sender currently logged into the account.
- Role
- [Retrieve all package roles](https://developer.conga.com/doc-automation/reference/role_listroles-1.md): Retrieves all roles for the package.
- [Add new role](https://developer.conga.com/doc-automation/reference/role_createrole-1.md): Adds a new role to an existing package.
- [Reorder package roles](https://developer.conga.com/doc-automation/reference/role_reorderroles-1.md): Reorders the roles in a specified package.
- [Adds a new ad hoc group to a transaction](https://developer.conga.com/doc-automation/reference/role_createadhocgroup.md): Adds a new ad hoc group and its members to an existing transaction. An ad hoc group allows multiple signers to be grouped together, where only one member needs to sign on behalf of the entire…
- [Updates a transaction's existing ad hoc group](https://developer.conga.com/doc-automation/reference/role_updateadhocgroup.md): Updates an existing ad hoc group, for a specified transaction, including any changes to the group's members. The request body structure is the same as creation: - Array of member Role objects…
- [Deletes a specified ad hoc group](https://developer.conga.com/doc-automation/reference/role_deleteadhocgroup.md): Deletes a specified ad hoc group from a transaction. This will remove: - The ad hoc group role - All member roles that were created for this group Note: If member roles are used elsewhere in the…
- [Retrieve a role](https://developer.conga.com/doc-automation/reference/role_getrole-1.md): Retrieves a single role associated with a package.
- [Update roles in the package](https://developer.conga.com/doc-automation/reference/role_updaterole-1.md): Updates a single Role by overriding its existing values with those in the JSON payload.
- [Delete a role](https://developer.conga.com/doc-automation/reference/role_deleterole-1.md): Deletes a specified role.
- [Unlock a role](https://developer.conga.com/doc-automation/reference/role_unlockrole-1.md): Unlocks a specified role.
- RolesVerification
- [Retrieve information on verification types being used](https://developer.conga.com/doc-automation/reference/rolesverification_getroleverification-1.md): If an advanced form of verification is used, such as an external verification method, then this call retrieves information about that verification method for the specified role.
- [Update an advanced verification method](https://developer.conga.com/doc-automation/reference/rolesverification_updateroleverification-1.md): Updates an existing advanced form of verification, such as an external verification method, for the specified role.
- [Create advanced verification](https://developer.conga.com/doc-automation/reference/rolesverification_createroleverification-1.md): Creates an advanced form of verification for a role, such as an external verification method role.
- [Delete an advanced verification method](https://developer.conga.com/doc-automation/reference/rolesverification_deleteroleverification-1.md): If an advanced form of verification is used, such as an external verification method, then this call deletes that verification method for the specified role.
- [Retrieve advanced verification types](https://developer.conga.com/doc-automation/reference/rolesverification_getaccountverificationtypes-1.md): Retrieves a list of verification types that are available in the account.
- Sender
- [List users in an account](https://developer.conga.com/doc-automation/reference/sender_listsenders-1.md): Retrieves a list of the users in an account. Optional query parameters can be used to filter the list. By default, only one sender is retrieved. To retrieve additional users you must modify the "to"…
- [Create a user](https://developer.conga.com/doc-automation/reference/sender_createsender-1.md): Creates a new user in an account.
- [Retrieve a user's detailed account information](https://developer.conga.com/doc-automation/reference/sender_getsender-1.md): Retrieves detailed account information of a specified user.
- [Update a sender's details](https://developer.conga.com/doc-automation/reference/sender_updatesender-1.md): Updates or modifies detail information for a specified Sender.
- [Delete a sender](https://developer.conga.com/doc-automation/reference/sender_deletesender-1.md): Deletes a specified sender from an account.
- [Invites a user to join the account.](https://developer.conga.com/doc-automation/reference/sender_invitesender.md): Sends an email invitation to a user. The user will receive an invitation link and a token identifying the account. Note: OneSpan returns 200 OK with empty body, which is automatically converted to…
- [Updates a Sender's password.](https://developer.conga.com/doc-automation/reference/sender_updatepassword.md): Helps users update or change their account password. Users can only modify their own password.
- [Resets the password for a specified user.](https://developer.conga.com/doc-automation/reference/sender_resetpassword-1.md): Sends an email to a specified user, so that they can set a new password.
- [Retrieve a user's signature](https://developer.conga.com/doc-automation/reference/sender_getsenderssignatureimage-1.md): Retrieves the image that is being used by a recipient as their default signature when signing a transaction.
- [Upload a signature image](https://developer.conga.com/doc-automation/reference/sender_uploadsendersignatureimage-1.md): Uploads an image to be used by a recipient as their default signature when signing a transaction.
- [Delete a signature image](https://developer.conga.com/doc-automation/reference/sender_deletesendersignatureimage-1.md): Deletes the image being used by a recipient as their default transaction signature.
- Session
- [Retrieve session object](https://developer.conga.com/doc-automation/reference/session_getsession-1.md): Retrieves the session object.
- SignatureImage
- [Retrieve signature image for a package role](https://developer.conga.com/doc-automation/reference/signatureimage_getsignatureimage.md): Retrieves the signature image for a specific role within a package.
- SignatureLayout
- [Retrieve signature layout configuration](https://developer.conga.com/doc-automation/reference/signaturelayout_getsignaturelayout.md): Retrieves the current signature layout configuration for the account, including logo and capture layout settings.
- [Update signature layout configuration](https://developer.conga.com/doc-automation/reference/signaturelayout_updatesignaturelayout.md): Updates the signature layout configuration for the account, including logo image and capture layout settings.
- SubAccounts
- [List sub-accounts](https://developer.conga.com/doc-automation/reference/subaccounts_listaccessiblesubaccounts-1.md): Sub-accounts enable an organization to create child accounts within its master account. For example, an organization might want to create child accounts on the basis of its departments,…
- [List API keys for the current sub-account user](https://developer.conga.com/doc-automation/reference/subaccounts_listsubaccountapikeys-1.md): Retrieves a list of API keys for the current user in the sub-accounts. This current user must have user management, sub-account management and API access permissions in a different…
- [List sub-accounts](https://developer.conga.com/doc-automation/reference/subaccounts_listsubaccounts-1.md): Retrieves a list of accounts that are sub-accounts of the current account.
- [Create a new sub-account](https://developer.conga.com/doc-automation/reference/subaccounts_createsubaccount-1.md): Sub-accounts enable an organization to create child accounts within the organization's master account. For example, an organization might want to create child accounts on the basis of its…
- [Update a sub-account](https://developer.conga.com/doc-automation/reference/subaccounts_updatesubaccount-1.md): Updates a sub-account with information specified in the parameters.
- VirtualRoom
- [Retrieve a virtual room configuration](https://developer.conga.com/doc-automation/reference/virtualroom_getvirtualroomconfig-1.md): Virtual rooms give you the ability to support your business using remote and online tools. Virtual rooms allow you to help your signers complete their transactions with the same level of support that…
- [Update a virtual room configuration](https://developer.conga.com/doc-automation/reference/virtualroom_putvirtualroomconfig-1.md): Update the configuration of virtual room for specific package.
- [List masked fields](https://developer.conga.com/doc-automation/reference/virtualroom_getvirtualroommaskedfields-1.md): In a virtual-room transaction, returns a list of field ID's that are masked. These fields cannot be seen by other signers in the Virtual Room transaction. Returns a list of fields in…
- [Define fields to be masked](https://developer.conga.com/doc-automation/reference/virtualroom_postvirtualroommaskedfields-1.md): In a Virtual Room transaction, returns a list of field id's that are masked. This means that these fields cannot be seen by other signers in the Virtual Room transaction. Returns a list…
- [Add a masked field](https://developer.conga.com/doc-automation/reference/virtualroom_putvirtualroommaskedfieldsbyid-1.md): Adds a field to a list of masked fields in a Virtual Room transaction.
- [Delete a masked field](https://developer.conga.com/doc-automation/reference/virtualroom_deletevirtualroommaskedfieldsbyid-1.md): In a Virtual Room transaction, deletes a specified field from a list of other masked fields.
- [List available virtual room recordings](https://developer.conga.com/doc-automation/reference/virtualroom_getvirtualroomrecording-1.md): Retrieves a list of available virtual room session recordings for a given package.
- [Fetch a video file](https://developer.conga.com/doc-automation/reference/virtualroom_getvirtualroomrecordingbyid-1.md): Fetches a video file by recording ID.
## Changelog
- [Welcome to Conga Approvals](https://developer.conga.com/doc-automation/changelog/welcome-to-conga-approvals.md)
# Contracts Documentation
> CLM, X-Author for Contracts, and Contract Intelligence
## API Reference: Contracts
- Accounts
- [Get contract hierarchy for an account using query](https://developer.conga.com/contracts/reference/post_api-clm-v1-accounts-accountid-contracts-hierarchy-query.md)
- [Get hierarchy starting from a specific contract under an account](https://developer.conga.com/contracts/reference/post_api-clm-v1-accounts-accountid-contracts-contractid-hierarchy-query.md)
- Contract Type Document Requirement Settings
- [Get a document requirement setting by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-settings-documents-contract-type-requirements-id.md): Fetches a single document requirement setting record.
- [Query document requirement settings](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-contract-type-requirements-query.md): Retrieves document requirement settings based on query parameters such as Limit, Skip, Sort, GroupBy, etc.
- [Query document requirement settings by contract type and action](https://developer.conga.com/contracts/reference/get_api-clm-v1-settings-documents-contract-type-requirements.md): Retrieves document requirement settings filtered by a specific contract type and action.
- [Update document requirement settings](https://developer.conga.com/contracts/reference/put_api-clm-v1-settings-documents-contract-type-requirements.md): Updates existing document requirement settings records. Each record must include an Id field.
- Conversation Thread
- [Get thread records](https://developer.conga.com/contracts/reference/post_api-clm-v1-conversation-threads-query.md): Returns thread records matching the query request.
- [Search conversation threads](https://developer.conga.com/contracts/reference/post_api-clm-v1-conversation-threads-search.md): Searches conversation threads by keyword across subjects, message content, participant names, and optionally document names.
**Required Parameters**:
- `searchText`: Keyword to search for
-…
- Obligations
- [Get activated contracts with obligations](https://developer.conga.com/contracts/reference/post_api-clm-v1-obligations-activated-contracts-1.md): Fetches contracts that have status as "Activated" with their associated obligations.
- Review Group
- [Initiate a group review](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-review-groups.md): Sends contract documents for group review and initiates a review by sending contract documents to reviewers.
Two types of reviews are available in CLM, "Simple Review" and "Microsoft 365 Review".…
- [Get all review groups for a contract](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-review-groups.md): Returns all review cycle groups associated with the specified contract,
including each group's nested review cycles and their current status.
- [Get a review group by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-review-groups-reviewgroupid.md): Returns the review group matching the specified group ID,
including its nested review cycles and their current status.
- [End a group review](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-review-groups-reviewgroupid-reviews-reviewid-end.md): Ends the specified review group, optionally uploading a reviewed document and suppressing email notifications.
- [Cancel a group review](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-review-groups-reviewgroupid-reviews-reviewid-cancel.md): Cancels the specified review within a review group.
- [Add reviewers to a review within a review group](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-review-groups-reviewgroupid-reviews-reviewid-reviewers.md): Adds one or more reviewers to an existing review within the specified review group.
- [End a specific reviewer's participation in a review within a review group](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-review-groups-reviewgroupid-reviews-reviewid-reviewers-reviewerid-end.md): Marks the specified reviewer as completed for the given review cycle within a review group.
Optionally accepts a reviewed document upload. If no document is provided the request still succeeds.
- [Cancel a specific reviewer's participation in a review within a review group](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-review-groups-reviewgroupid-reviews-reviewid-reviewers-reviewerid-cancel.md): Cancels the specified reviewer's access and marks their participation as cancelled
for the given review cycle within a review group.
- [Search users for a group review](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-review-groups-reviewtype-searchstring.md): Searches users by name or email ID to add as reviewers for a group review, scoped by review scope (Internal/External).
- Sign
- [End wet signature flow](https://developer.conga.com/contracts/reference/post_api-clm-v1-sign-esignatures-wetsign-transactionid-end-1.md): Ends a wet signature flow by its ID and attaches the given signed document with the contract.
- Template
- [Find template records](https://developer.conga.com/contracts/reference/post_api-clm-v1-templates-query-1.md): Fetches template records that match a query.
- ActivityHistory
- [Get activity history records](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-activityhistory-query-1.md): Fetches activity history records.
- [Get the activity feed for the current user's contracts](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-activityhistory-feed.md): Returns the latest activity recorded against contracts where the current user is the owner or the creator.
Entries are ordered by timestamp descending and are restricted to the requested time…
- Bulk Import
- [Create a bulk import job](https://developer.conga.com/contracts/reference/post_api-clm-v1-import-jobs-1.md): The API allows you to upload .CSV files and import bulk data into Conga CLM. You can upload accounts, contacts, and agreements in bulk by creating and uploading a .CSV file. This creates a record for…
- [List bulk import jobs](https://developer.conga.com/contracts/reference/post_api-clm-v1-import-jobs-query-1.md): Retrieves all bulk import job records.
- [Get bulk import job result](https://developer.conga.com/contracts/reference/get_api-clm-v1-import-jobs-jobid-1.md): Gets the result (failure or success) for a given job.
- [Delete a bulk import job](https://developer.conga.com/contracts/reference/delete_api-clm-v1-import-jobs-jobid-1.md): Permanently deletes record of the given job ID from the system.
- [Get uploaded file details](https://developer.conga.com/contracts/reference/get_api-clm-v1-import-jobs-jobid-batch-batchid-1.md): Fetches contents of the file uploaded for bulk data creation based on jobID and batchID.
- [Get bulk import templates](https://developer.conga.com/contracts/reference/get_api-clm-v1-import-templates-format-1.md): The API fetches bulk import templates for the provided objectName and format. Templates are required for uploading .CSV files to import bulk data into Conga CLM. A template comprises columns…
- Clause Obligations
- [Create a clause obligation request](https://developer.conga.com/contracts/reference/post_api-clm-v1-clauses-clauseid-obligations-1.md): Creates a clause obligation record in CLM. Makes Obligation entry in Master Obligation and makes entry of Clause Id and Obligation Id in Clause Obligation table.
The required fields to create a…
- [Delete clause obligations](https://developer.conga.com/contracts/reference/delete_api-clm-v1-clauses-clauseid-obligations-1.md): Deletes clause obligations based on the provided clause obligation IDs for the specified clause ID.
If clause obligation IDs are not provided, all clause obligations associated with the provided…
- [Get all clause obligations](https://developer.conga.com/contracts/reference/post_api-clm-v1-clauses-clauseid-obligations-query-1.md): Fetches all clause obligations with respect to clause Id.
You can filter and sort the results by defining query parameters.
- [Get a clause obligation by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-clauses-clauseid-obligations-obligationid-1.md): Fetches a clause obligation by its ID.
- [Update a clause obligation](https://developer.conga.com/contracts/reference/put_api-clm-v1-clauses-clauseid-obligations-obligationid-1.md): Updates a clause obligation record.
- [Delete a clause obligation by ID](https://developer.conga.com/contracts/reference/delete_api-clm-v1-clauses-clauseid-obligations-obligationid-1.md): Deletes a clause obligation by its ID.
- Configurations
- [Get configuration](https://developer.conga.com/contracts/reference/get_api-clm-v1-configurations-category-category-name-name.md): Fetches CLM configuration settings by category and name. All CLM-related configurations are available in the CLM category.
- Contract
- [Create a contract record](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-1.md): Creates a contract record in CLM. Name and Record Type are the required fields to create a contract.
CLM auto-populates the system fields, such as Status Category and Status fields, which help…
- [Delete contracts](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-1.md): Permanently deletes the contract records of the provided contract IDs from the system.
- [Update a contract record](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-1.md): Updates a contract record in CLM. The Name and Record Type fields are required update a contract.
You can also update the contract with these additional and custom fields.
* Name
* Account
*…
- [Get a contract's details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-1.md): Fetches contract details of the provided contract ID. The API returns values of all contract fields including any configured custom fields.
- [Delete a contract](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-1.md): Permanently deletes the record of the provided contract ID from the system.
- [Update a contract's signature status](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-signstatus-1.md): Updates a contract's signature status (signed, declined, or out for signature). For consumption by the eSign Service API.
- [Get contract records](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-query-1.md): Returns contract records matching the query request. Contracts created from contract requests are included in the result only if their contract status is "Request". Contracts with an "In Progress" or…
- Contract Clause
- [Get contract clause details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-clauses-contractclauseid-1.md): Fetches contract clause details based on contract clause ID.
- [Get all contract clauses](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-clauses-1.md): Fetches all contract clauses and groups them by Clause and DocumentVersionId fields. This API also processes the contract clauses to return the most recent version of each clause along with the total…
- [Create a new contract clause](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-clause-1.md): Creates a new contract clause for the specified contract.
- [Update an existing contract clause](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-clause-contractclauseid-1.md): Updates a contract clause with the provided data.
- [Delete a contract clause](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-clauses-contractclauseid-1.md): Deletes the specified clause from the contract.
- [Create multiple clauses for a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-clauses-bulk-1.md): Creates multiple clauses for the specified contract in a single request.
- [Update multiple clauses of a contract](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-clauses-bulk-1.md): Updates multiple clauses of a contract with the provided data in a single request. Each clause in the request must include an ID field.
- [Delete multiple contract clauses](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-clauses-bulk-1.md): Deletes multiple clauses associated with the specified contract in a single request.
- Contract Cycle Time
- [Get a cycle-time group record by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-cycletimes-cycletimegroupid-1.md): Gets a record from a cycle-time group object by its ID.
- [Update a cycle-time group record](https://developer.conga.com/contracts/reference/put_api-clm-v1-cycletimes-cycletimegroupid-1.md): Updates a record in a cycle-time group object.
- [Delete a cycle-time group record](https://developer.conga.com/contracts/reference/delete_api-clm-v1-cycletimes-cycletimegroupid-1.md): Deletes a record from a cycle-time group object.
- [List all of a contract's or contract object's fields](https://developer.conga.com/contracts/reference/get_api-clm-v1-cycletimes-contractfields-1.md): Fetches a contract or contract object using metadata that can be used in a cycle-time group record.
- [Create a cycle-time group record](https://developer.conga.com/contracts/reference/post_api-clm-v1-cycletimes-1.md): Creates a record in a cycle-time group object.
- [Get cycle-time group data](https://developer.conga.com/contracts/reference/get_api-clm-v1-cycletimes-dashboard-1.md): Gets cycle-time group data for the predefined out-of-the-box status category and status for the past 12 months.
- Contract Documents
- [Create a new contract document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-1.md): Creates a new contract document for the provided contract ID.
On success, the contract status changes to "Author Contract" if the contract's previous status was "Request".
- [Delete documents by contract ID](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-documents-1.md): Deletes one or more documents associated with a specific contract. You can provide a list of document IDs to delete specific documents, or omit the list to delete all documents linked to the…
- [Get document details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-documents-documentid-1.md): Fetches document details for the provided document ID.
- [Update a contract](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-documents-documentid-1.md): Updates the contract document for the provided document ID.
This API creates a new version ID with the same document ID and retains the previous version.
- [Query contract documents](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-query-1.md): Executes a query request against document records, returning matching records.
- [Query contract documents for status and version](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-querywithreview-1.md): Executes a query request against the document records and returns matching records with review status and document versions.
- [Get document by ID and version](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-documents-documentid-versions-documentmetadataid-1.md): Fetches document details for the provided document ID and version ID.
- [Delete document versions](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-documents-documentid-versions-1.md): Deletes documents based on provided document version IDs for a specified contract ID.
This API permanently deletes the document data but document metadata is retained in the system with the…
- [Get a contract's related documents](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-documents-relateddocuments-1.md): Fetches all related documents for the provided contract ID.
- [Import an offline contract document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-importoffline-1.md): Creates a new contract document for the provided contract ID based on imported third-party paper.
On success, the contract status changes to "Author Contract".
- [Create an offline contract document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-createoffline-1.md): Creates a new contract record based on an imported third-party contract document and attaches the original document to the new contract.
On success, the contract status changes to "Author…
- [Create a contract from an executed contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-storeexecuted-1.md): Creates a new contract record from the provided executed contract document.
On success, the contract status changes to "Activated".
- [Import a large document.](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-importoffline-large-1.md): Imports a large document for the specified contract ID. This operation allows the user to upload or reference
a document that is already uploaded to a filestore, and it links the document to the…
- [Store an executed large document.](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-storeexecuted-large-1.md): Stores an executed large document for the specified contract ID. This operation allows the user to upload or reference
a document that is already uploaded to a filestore, and it links the document…
- [Creates an offline contract and imports a large document linked to it.](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-createoffline-large-1.md): Creates a new contract record based on an imported third-party contract document and attaches the original document to the new contract.
On success, the contract status changes to "Author…
- [Upload a large contract document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-large-1.md): Uploads a large document to the specified contract ID.
This API allows you to reference a document that is already uploaded to the filestore and link it to the contract.
Provide the file name,…
- [Protect a document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-documentid-protect-1.md): Protects a document. This API takes a copy of the document with the provided document ID, applies the respective document protection based on the given action, and returns the copy.
Document…
- [Query contract documents with compliance status](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-querywithcompliance.md): Executes a query request against the document records and returns matching records with compliance status.
- Contract Lifecycle
- [Activate a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-activate-1.md): Activates a contract or brings it into effect after it has been finalized and signed by stakeholders.
Activating a contract ensures that key dates and events are monitored by the system and that all…
- [Amend a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-amend-1.md): Amends a contract. During the term of a contract, there may be a need to modify its language or terms. This API creates a new version of the contract record after amendment. The new, amended record…
- [Renew a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-renew-1.md): Renews a contract at the end of the term. The renewed contract (new contract) shares the same base contract number as the original contract with an incremented decimal. All data from the original is…
- [Clone a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-clone-1.md): Clones an existing contract, creating a new contract version. All data from the original version is copied to the new version. The status of the original contract does not change.
- [Terminate a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-terminate-1.md): Terminates an executed contract. To be terminated, a contract must have an Activated status. On contract termination, any related amended and renewed agreements are terminated along with the…
- [Expire a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-expire-1.md): Expires a contract when the contract term ends. To mark a contract as expired, its status must be Activated, Superseded, or Being Terminated. On expiration, the contract's status is changed to…
- [Cancel a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-cancel-1.md): Cancels a contract. To cancel a contract, the status category of the contract must be Request, In Authoring, In Signatures or In Filing. On cancellation, the contract status is changed to Canceled.
- [Submit Request](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-submitrequest-1.md): Submits a request to process the contract based on the steps defined in the agreement rule.
- [Update contract status by lifecycle action](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-update-contract-lifecycle-status-1.md): Updates the contract's status and status category based on the specified lifecycle action and record type.
- Contract Obligations
- [Create an obligation for a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-1.md): Creates an obligation record for the specified Contract ID. Name is a required field to create an obligation.
You can specify values for the following additional fields for the obligation.
*…
- [Delete contract obligations](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-obligations-1.md): Deletes obligations associated with the specified contractID. If contractObligationIds are provided, only those specific obligations are deleted; otherwise, all obligations linked to the contract are…
- [Get all contract obligations](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-query-1.md): Fetches all contract obligations associated with a specified contract ID.
You can refine the results by applying filters and sorting options using query parameters.
- [Get a contract obligation by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-obligations-obligationid-1.md): Fetches a contract obligation by its ID.
- [Update a contract obligation](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-obligations-obligationid-1.md): Updates a contract obligation record.
- [Delete a contract obligation by ID](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-obligations-obligationid-1.md): Deletes a contract obligation by its ID.
- [Create a contract obligation document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-obligationid-documents-1.md): Creates a new document for the specified contract obligation.
- [Get contract obligation document details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-obligations-obligationid-documents-documentid-1.md): Fetches document details for the provided document ID within a specific contract obligation.
- [Delete a contract obligation document](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-obligations-obligationid-documents-documentid-1.md): Deletes a document based on the provided document ID for the specified contract obligation.
- [Get the obligation and fulfillment details of the contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligation-fulfillments-1.md): Fetches the obligation and fulfillment details of the contract with document details
- Contract Obligations Fulfillment
- [Get a contract obligation fulfillment by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-obligations-obligationid-fulfillments-fulfillmentid-1.md): Fetches a contract obligation fulfillment by its ID.
- [Update a contract obligation fulfillment](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-obligations-obligationid-fulfillments-fulfillmentid-1.md): Modifies an existing contract obligation fulfillment by updating the provided field values.
- [Get fulfillment history](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-obligationid-fulfillments-fulfillmentid-history-query-1.md): Fetches fulfillment history for a contract obligation.
- [Perform an action on a contract obligation fulfillment](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-obligationid-fulfillments-fulfillmentid-fulfillmentaction-1.md): Executes the specified action on a contract obligation fulfillment.
- Contract Related List
- [Create records](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-objectname-1.md): Creates one or more records for the named object.
- [Delete an object's records](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-objectname-1.md): Deletes one or more records for a named object.
- [Update an object's details](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-objectname-objectid-1.md): Updates the details for a named object (by objectName and objectId), if such an object exists.
- [Get an object's details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-objectname-objectid-1.md): Retrieves details for a named object (by objectName and objectId).
- [Delete an object's details](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-objectname-objectid-1.md): Deletes the details for a named object (by objectName and objectId).
- [Filter an object's records](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-objectname-query-1.md): Retrieves all records for a named object and sorts the results per the query parameters.
- Contract Relationship
- [Link contracts by relationship](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-relationships-1.md): Links one contract to another. Contracts can be linked using IsAmendmentFor, IsAmendedBy, IsRenewalFor, and IsRenewedBy relationships.
When you amend or renew a contract, the original and the new…
- [Get contract relationship details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-relationships-1.md): Gets relationship details of the provided contract ID if a contract has linked contracts.
- [Link contracts using RelationshipFromType and RelationshipToType](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-relationships-link-1.md): Links one contract to another by creating the specified relationship. Provide the source contractId and a ContractRelationshipRequest containing the RelatedContractId, RelationshipFromType and…
- [Unlink related contracts](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-relationships-relationshipid-1.md): Unlinks one contract from another.
- [Get hierarchy of a contract](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-hierarchy-1.md): Gets the contract hierarchy for the provided contract ID and fetches the contract's child and descendant contracts.
- [Query a contract relationship](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-relationships-query-1.md): Fetches the list of related contracts for the given contract ID.
- Contract Request
- [Get the contract request details](https://developer.conga.com/contracts/reference/get_api-clm-v1-requests-id-1.md): Fetches the contract request details for the provided contract request ID
- [Update a contract request record](https://developer.conga.com/contracts/reference/put_api-clm-v1-requests-id-1.md): Updates a contract request record for the provided contract ID in CLM.
The required fields to update a contract request record are:
* Name
* Account
* RecordType
- [Delete a contract request](https://developer.conga.com/contracts/reference/delete_api-clm-v1-requests-id-1.md): Deletes a contract request in Draft status.
When the request is part of a bundle (parent with AdditionalContractRequestTypes, or child with ParentContractRequest),
all related…
- [Create a contract request](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-1.md): Creates a contract request record in CLM.
The required fields to create a contract request record are:
* Name
* RecordType
- [Upload documents to a contract request](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-id-documents-1.md): Uploads documents to a contract request record.
- [Delete documents by contract request ID](https://developer.conga.com/contracts/reference/delete_api-clm-v1-requests-id-documents-1.md): Deletes one or more documents associated with a specific contract request. You can provide a list of document IDs to delete specific documents, or omit the list to delete all documents linked to the…
- [Get a contract request's related documents metadata](https://developer.conga.com/contracts/reference/get_api-clm-v1-requests-id-documents-1.md): Fetches all the related documents for the provided contract ID.
- [Get contract request records](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-query-1.md): Executes the query request against the contract request records and returns the matching records.
- [Convert a contract request to an agreement](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-contractrequestid-convert-1.md): Converts a contract request into an agreement in CLM.
Optionally processes DAI (Document AI) on copied documents when useDai is true and worksheetId is provided.
- [Get incoming contract requests](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-incoming-requests.md): Retrieves contract requests that are pending approval and assigned to the current user or their groups.
Supports filtering, sorting, and pagination through the CustomQuery parameter.
- [Get a user's contract request authority](https://developer.conga.com/contracts/reference/get_api-clm-v1-requests-id-action-eligibility.md): Checks if the current user has the permissions and role to approve, reject, or convert for a given contract, based on the user role (for example, Approver, contract Manager), association with the…
- Contract Request Team Members
- [Add contract request team members](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-contractrequestid-teammembers.md): Adds one or more team members to a contract request and assigns them a team role.
- [Update contract request team member details](https://developer.conga.com/contracts/reference/put_api-clm-v1-requests-contractrequestid-teammembers-teammemberid.md): Updates the details of a specific team member assigned to a contract request.
- [Get contract request team member details](https://developer.conga.com/contracts/reference/get_api-clm-v1-requests-contractrequestid-teammembers-teammemberid.md): Retrieves details of a specific team member assigned to a contract request, including their associated team role.
- [Remove a team member from a contract request](https://developer.conga.com/contracts/reference/delete_api-clm-v1-requests-contractrequestid-teammembers-teammemberid.md)
- [Get contract request team members by action](https://developer.conga.com/contracts/reference/get_api-clm-v1-requests-contractrequestid-teammembers-by-action-actionname.md): Retrieves a list of team members assigned to a contract request who are associated with a specific contract action.
- [Get all team members of a contract request](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-contractrequestid-teammembers-query.md)
- Contract Team Members
- [Add contract team members](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-teammembers-1.md): Adds one or more team members to a contract and assigns them a team role.
- [Update contract team member details](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-teammembers-teammemberid-1.md): Updates the details of a specific team member assigned to a contract.
- [Get contract team member details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-teammembers-teammemberid-1.md): Retrieves details of a specific team member assigned to a contract, including their associated team role.
- [Remove a team member from a contract](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-teammembers-teammemberid-1.md)
- [Get contract team members by action](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-teammembers-by-action-actionname-1.md): Retrieves a list of team members assigned to a contract who are associated with a specific contract action.
- [Get all team members of a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-teammembers-query-1.md)
- Document Generation
- [Generate a document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-generate-1.md): Generates a new contract document using an existing template. Templates can be created using X-Author for Contracts.
On generating a new document, the contract status changes to "Author Contract".
- [Regenerate a document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-regenerate-1.md): Regenerates a contract document using an existing template. Templates can be created using X-Author for Contracts.
The contract status does not change.
- [Generate a supporting document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-supportingdocument-1.md): Generates a new supporting document using an existing template. Templates can be created using X-Author for Contracts.
The contract status does not change.
- [Join documents](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-joindocuments-1.md): Merges multiple documents into a single document based on the provided document IDs. All documents to be joined must be associated with the same contract.
- [Preview a document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-previewdocument-1.md): Generate a preview contract document from an existing template. Templates can be created using X-Author for Contracts.
- [Compare documents](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-compare.md): Compares two document versions and returns the generated comparison document as a base64 encoded PDF.
- Document Settings
- [Create a document output format](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-output-formats-1.md): Creates a new record for a document's output format (doc, docx, pdf, or rtf), along with other options like adding a watermark.
- [Update document output format](https://developer.conga.com/contracts/reference/put_api-clm-v1-settings-documents-output-formats-1.md): Updates a document output format and its properties based on the document output format ID.
- [Get a document output format](https://developer.conga.com/contracts/reference/get_api-clm-v1-settings-documents-output-formats-id-1.md): Gets document output format details based on the document output format ID.
- [Delete a document output format](https://developer.conga.com/contracts/reference/delete_api-clm-v1-settings-documents-output-formats-id-1.md): Deletes a document output format based on the provided ID.
- [Show document output format records](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-output-formats-query-1.md): Queries document output format records for matching details.
- [Add a document protection setting](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-protections-1.md): Adds a document protection setting for a user role and a contract type.
- [Update a document protection setting](https://developer.conga.com/contracts/reference/put_api-clm-v1-settings-documents-protections-1.md): Updates a list of fields in a document protection setting.
- [Copy document protection settings](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-protections-clone-1.md): Copies document protection settings that do not exist in destination roles from the source role.
- [Get a document protection setting](https://developer.conga.com/contracts/reference/get_api-clm-v1-settings-documents-protections-documentprotectionid-1.md): Fetches a document protection setting.
- [Delete a document protection setting](https://developer.conga.com/contracts/reference/delete_api-clm-v1-settings-documents-protections-documentprotectionid-1.md): Deletes a document protection setting.
- [Query document protection settings](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-protections-query-1.md): Retrieves multiple document protection settings based on query parameters such as Limit, Skip, Sort, GroupBy, etc.
- Contract Obligations Fulfillment
- [Get all active obligation fulfillments for the Manage Fulfillment listing](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-obligations-fulfillments-query.md): Fetches all active obligation fulfillment records excluding Canceled and Superseded status records at database level.
For Recurring Obligations (Monthly, Quarterly, Custom):
- Excludes terminal…
- [Get activity history for all fulfillments of a contract obligation](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-obligationid-activityhistory-query.md): Fetches the combined activity history across all fulfillments of a specific obligation.
Each row includes FulfillmentName, FulfillmentNumber, Comments, Date, User, Action, Status, and…
- [Get all fulfillments for a contract obligation](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-obligationid-fulfillments-query.md): Fetches fulfillment records for a specific obligation in a contract.
- Contract Related List
- [Update multiple object records](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-objectname.md): Updates one or more records for a named object. Each record in the request body must include an 'Id' field.
- Export
- [Export query results to Excel/CSV](https://developer.conga.com/contracts/reference/post_api-clm-v1-objects-export-filename-format-1.md): Executes a query against a single object type and exports the results to the specified format (Excel or CSV).
The query supports filtering, sorting, and field selection.
- [Export search results to Excel/CSV](https://developer.conga.com/contracts/reference/post_api-clm-v1-objects-multiple-export-filename-format-1.md)
- In-Effect View
- [Get in-effect view of contract detail changes](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-in-effect-view-details-1.md): Fetches contract detail changes that occurred during an amendment, enabling a comparison of the amendment's change history.
- [Get in-effect view of contract document changes](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-in-effect-view-documents-1.md): Fetches contract document changes that occurred during an amendment, enabling a comparison of the amendment's change history.
- [Get in-effect view of contract clause changes](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-in-effect-view-clauses-1.md): Fetches contract clause changes that occurred during an amendment, enabling a comparison of the amendment's change history.
- Review
- [Initiate a review](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-1.md): Sends contract documents for review and initiates a review by sending contract documents to reviewers.
Two types of reviews are available in CLM, "Simple Review" and "Microsoft 365 Review".
*…
- [Get contract review details in CLM](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-reviews-1.md): Retrieves details of any active review cycle for the specified contract. Provide the contractId to return the review cycle with metadata such as reviewId, status, reviewers, documents, timestamps and…
- [End a review](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-reviewid-end-1.md): Ends a review and marks it as completed.
* For Simple Review, the contract status changes to Ready for Signature.
* For Microsoft 365 Review, in addition to the status change to Ready for…
- [Cancel a review](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-reviewid-cancel-1.md): Cancels a review and marks it as canceled.
* This API is not applicable to Simple Review.
* For Microsoft 365 Review, the contract status changes to Author Contract. Microsoft 365 document access…
- [Add reviewers to a review cycle in CLM](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-reviewid-reviewers-1.md): Adds one or more reviewers to an active review for the specified contract. Provide the contractId, reviewId, externalReviewToken for Microsoft 365 review and ReviewersAddRequest containing reviewer…
- [End review of reviewers](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-reviewid-reviewers-end-1.md): Ends a review for one or more reviewers. You cannot end a review that was canceled or ended.
An email notification is sent to all reviewers when the review ends. Changes made to the review document…
- [Remove reviewers](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-reviewid-reviewers-cancel-1.md): Removes one or more reviewers from an active review. You cannot remove reviewers from a canceled or ended review. When you remove reviewers from an active review, Microsoft 365 document access is…
- [Search users for document review in CLM](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-reviews-reviewtype-searchstring-1.md): Searches users by name or email ID, for adding as reviewers to inititiate review cycle for a contract. Provide the contractId, reviewType, and searchString. The API returns a list of users with their…
- [Get Active Directory access token](https://developer.conga.com/contracts/reference/post_api-clm-v1-reviews-token-1.md): Gets an Active Directory access token for Microsoft 365 Review to test Microsoft 365 SharePoint configurations.
- Team Role
- [Create a team role](https://developer.conga.com/contracts/reference/post_api-clm-v1-teamroles-1.md): Creates a new team role in the CLM system to assign people to duties relating to contract negotiation, management, or enforcement.
Team roles support mapping of both standard actions and custom…
- [Delete team roles](https://developer.conga.com/contracts/reference/delete_api-clm-v1-teamroles-1.md): Permanently deletes the records of the provided team role IDs from the system.
- [Update an existing team role](https://developer.conga.com/contracts/reference/put_api-clm-v1-teamroles-teamroleid-1.md): Updates an existing team role record.
- [Get a team role by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-teamroles-teamroleid-1.md): Returns a team role record by ID.
- [Delete a team role](https://developer.conga.com/contracts/reference/delete_api-clm-v1-teamroles-teamroleid-1.md): Permanently deletes the record of the provided team role ID from the system.
- [Query team role records](https://developer.conga.com/contracts/reference/post_api-clm-v1-teamroles-query-1.md): Returns team role records matching the query request.
## API Reference: Review
- Authorization
- [Get user profile authorization](https://developer.conga.com/contracts/reference/get_api-review-v1-reviewtype-authorize-1.md): Gets a review service auth URL or auth token based on your administrator settings.
- [Get an auth token for Google service account flow](https://developer.conga.com/contracts/reference/post_api-review-v1-google-authorize-1.md): Receives encrypted JSON for the Google service account, decrypts it, generates an access token, and returns the token.
- [Get an auth token for delegated flow](https://developer.conga.com/contracts/reference/get_api-review-v1-reviewtype-delegated-token-1.md): Gets an auth token based on your administrator settings, review type, and auth code. This endpoint is only for delegated flow.
- Review
- [Get review details](https://developer.conga.com/contracts/reference/get_api-review-v1-reviewtype-reviewid-1.md): This API retrieves the review ID, which includes associated review status information and properties.
- [Cancel a review process](https://developer.conga.com/contracts/reference/delete_api-review-v1-reviewtype-reviewid-1.md): Cancels a review process you started. You must identify the review with the reviewID parameter and you can invoke an existing email template using emailTemplateId.
- [Get reviews](https://developer.conga.com/contracts/reference/get_api-review-v1-objecttype-objectid-reviews-1.md): This API retrieves reviews based on a Review's parent object ID.
- [Send a document for review](https://developer.conga.com/contracts/reference/post_api-review-v1-reviewtype-start-1.md): Sends a document for review to your selected approvers.
- [End my review](https://developer.conga.com/contracts/reference/post_api-review-v1-reviewtype-reviewid-end-1.md): Ends a review process you started. You must pass the reviewId of the process you will end. Passing EmailTemplateId enables you to designate an existing email template to send ending a review. The…
- Reviewer
- [Get reviewers](https://developer.conga.com/contracts/reference/get_api-review-v1-reviewtype-reviewid-reviewers-1.md): This API retrieves the status details of all the reviewers and assocated details corresponding to a review request.
- [Add reviewers](https://developer.conga.com/contracts/reference/post_api-review-v1-reviewtype-reviewid-reviewers-1.md): Adds reviewers to a review process that has already started. You must identify the review and pass an addreviewerrequest parameter. The API returns a list of reviewer IDs.
- [Cancel a reviewer](https://developer.conga.com/contracts/reference/delete_api-review-v1-reviewtype-reviewid-reviewers-reviewerid-1.md): Cancels the review process for an individual reviewer and revokes their permission to review the document. You must pass the IDs of the review and the reviewer and you can designate an email template…
- [End a reviewer's review](https://developer.conga.com/contracts/reference/post_api-review-v1-reviewtype-reviewid-reviewers-reviewerid-end-1.md): This API ends the review process for an individual user and revokes permission to review a document. You must pass the reviewID and reviewerID parameters to identify the review and the reviewer. You…
- ReviewSites
- [Validate Sharepoint site](https://developer.conga.com/contracts/reference/get_api-review-v1-office365-sites-sitename-validate-1.md): Checks if the custom-created Sharepoint site is valid.
- User
- [Search users](https://developer.conga.com/contracts/reference/get_api-review-v1-reviewtype-reviewers-query-1.md): Retreives user details matching your search string. You must pass a search string in the searchText parameter.
- [Gets existing users from search text](https://developer.conga.com/contracts/reference/get_api-review-v1-office365-active-directory-users-1.md)
## API Reference: X-Author
- ConfigurationManagement
- [Toggle connect to CRM flag](https://developer.conga.com/contracts/reference/put_api-xauthor-v1-config-management-crm-connection-1.md)
- FeatureSettings
- [Get AI feature settings](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-feature-settings-ai-1.md): Retrieves AI feature setting details, specifically whether the Copilot, Clause Semantic, and Redline AI feature bits are enabled.
- [Get external connection status](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-feature-settings-1.md): Returns the status of the isExternalDataConnectionEnabled Boolean, indicating the status of the external data connection.
- [Get all feature settings](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-feature-settings-all.md)
- GoogleConfig
- [Gets the information of google drive support and service account configurations in clm](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-google-config-1.md)
- Layout
- [Retrieves the page field definitions and configuration metadata for the specified layout.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-layouts-layoutname-1.md)
- Reconciliation
- [Process document to prepare data for reconciliation preview](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-reconcile-preview-data-1.md): This includes field validation, field reconciliation and clause reconciliation. Short ciruiting execution if validation have some invalid field
- [/api/xauthor/v1/reconcile/preview-data/sametagfields](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-reconcile-preview-data-sametagfields-1.md)
- Playbook
- [Get the list of playbooks based upon contract type, source and legal entity.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-playbooks.md)
- [Get the list of rules matched for the playbook based upon contract type, source and legal entity.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-playbooks-playbookid-rules.md)
- [Retrieves the list of matched available playbooks for the specified contract.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-playbooks-match.md)
- PlaybookExecution
- [Executes the specified playbook with the provided input document and returns the execution details.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-playbooks-playbookid-execute.md)
- [Retrieves the playbook execution results including clause rule and document rule outcomes.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-playbooks-playbookid-executions-executionid-results.md)
- RedlineExecutionStatus
- [s
Retrieves the current execution status of a redline operation, including extraction and redlining progress.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-redlines-executions-executionid-status.md)
- RuleExecution
- [Executes a rule against a contract document using the document content.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-playbooks-playbookid-rules-ruleid-content-run.md)
- [Executes a rule against a contract document using pre-extracted rule text.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-playbooks-playbookid-rules-ruleid-run.md)
- [Retrieves the clause rule execution result for a specific execution.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-playbooks-playbookid-rules-clause-rule-executionid-results.md)
- [Retrieves the document rule execution result for a specific execution.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-playbooks-playbookid-rules-document-rule-executionid-results.md)
- DataCorrection
- [Convert RecordType to ContractType](https://developer.conga.com/contracts/reference/put_api-xauthor-v1-data-correction-template-field-record-type-1.md): Updates existing records for a schema change, renaming the RecordType field ContractType.
After the update, existing records have a new ContractType key with the existing RecordType field data.
- Analytics
- [Add application usage data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-analytics-1.md)
- Log
- [Applications exception logging.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-logs-1.md)
- [To Log the custom metrics for the XA user](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-logs-custommetrics-1.md)
- SchemaMetadata
- [Retrieves the entities.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-schema-metadata-1.md)
- ClauseMetadata
- [Get a template clause's metadata](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clauses-metadata-1.md)
- [Get mark clause metadata](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clauses-mark-metadata-contractid-1.md)
- PackageMigration
- [Export package](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-template-migration-export-1.md)
- [Import package](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-template-migration-import-1.md)
- TemplateMigrate
- [Export a template](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-templates-export-1.md): Exports the selected template into a .zip file containing metadata and related clauses.
- [Import a template](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-templates-import-1.md): Imports the selected template using the .zip file created during the export process.
- AgreementMetadata
- [Get fields](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-metadata-1.md)
- AgreementReview
- [/api/xauthor/v1/contracts/{contractId}/reviews](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-reviews-1.md)
- AdminSettings
- [Get administrator settings](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-admin-settings-1.md): Retrieves all application-related information, like the user profile and org details.
- [Get Google account configuration](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-admin-settings-google-service-config-1.md): Retrieves Google Drive service account and folder configuration information.
- Agreement
- [Get agreements](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-query-1.md): Gets one or more agreements based on the parameters provided in the request body.
- [Get agreements owned by current logged in user](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-query-me-1.md): Gets one or more agreements based on the parameters provided in the request body.
- [List recently viewed agreements](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-recently-viewed-1.md): Gets one or more recently viewed agreements.
- [Get agreement details by contract](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-1.md)
- [Get agreement record type](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-record-type-1.md)
- [Create an agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-1.md)
- [Filter agreements with advanced search criteria](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-advance-query.md): Gets one or more agreements based on the advanced search filters provided in the request body.
Supports complex filter expressions, field selection, sorting, pagination via offset and limit.
- AIRedline
- [This method is to process the check-in or publish of the document based on the AI suggestion and the details provided in the request.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-ai-redline-check-in-1.md)
- [This method to generate a preview of the updated contentbased on the AI suggestion and other details provided in the request](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-ai-redline-preview-1.md)
- [/api/xauthor/v1/contracts/{contractId}/AI/redline/risks/{attachmentId}](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-ai-redline-risks-attachmentid-1.md)
- [/api/xauthor/v1/contracts/{contractId}/AI/redline/risks](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-ai-redline-risks-1.md)
- Document
- [Get document content by attachment](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-content-1.md): Gets the document content by attachment ID. Responses are curated for Windows and Mac.
- [Get document content body](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-content-body-1.md): Gets the document content as string and as content bytes for the given attachment ID.
- [Get document or attachment by ID](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-1.md): Gets document/attachment for the given attachment ID.
- [Get file size in MB of the attachment by ID](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-size-1.md)
- [Get the docx octet stream](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-content-stream-1.md)
- [Get document in Word online](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-attachmentid-content-onedrive-stream-1.md)
- [Convert SDT elements to text](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-content-no-datepicker-1.md): This API checks the document for SDT (Structured Document Tag) elements like date pickers or drop-down lists from Microsoft Word's Developer tab,
removes such content controls, and converts them to…
- [Get the name of a document file](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-suggested-filename-1.md)
- [/api/xauthor/v1/documents/{attachmentId}/content-body-metadata-extracted](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-content-body-metadata-extracted-1.md)
- [Get content metadata](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-content-metadata-1.md)
- [Get agreement details](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-metadata-1.md)
- [Get document Clauses by attachment ID](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-clauses-1.md): Gets Clauses in a document/attachment for the given attachment ID.
- [Convert document content from OPC XML format to HTML](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-content-convert-opcxml-to-html.md)
- DocumentMetadata
- [Get metadata and custom properties](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-document-properties-1.md): Gets metadata with document's custom properties
- [Get document metadata](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-metadata-1.md)
- [Get fields and clauses from document metadata](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-smart-elements-1.md)
- [Get V2 metadata JSON](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-metadata-v2-1.md)
- [Get V2 metadata JSON](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-gdocs-gdocfileid-metadata-1.md)
- DocumentProtection
- [Remove document protection](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-unprotect.md): The unprotect an agreement document feature lets you to unprotect an agreement document without entering the password. This way, you can prevent sharing of passwords and unauthorized access to the…
- [Add document protection](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-protect.md): The protect an agreement document feature lets you to protect the agreement document without entering the password. This way, you can prevent sharing of passwords and unauthorized access to the…
- [Get the protection level of document.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-saveoption-protection-1.md)
- [Get the protection type of document.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-currentprotection-protections-1.md)
- DocumentReview
- [Check Send For Review status.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-reviews-details-1.md)
- [Check review cycle is pending or not.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-reviews-status-1.md)
- DocumentSync
- [Sync the document.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-document-sync-1.md)
- [Update the document Properties](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-document-sync-update-document-properties-1.md)
- [Gets the attachment id by external id](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-document-sync-externalid-attachment-id-1.md)
- Account
- [Get accounts](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-accounts-name-1.md)
- Authorization
- [Get token information](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-authorization-token-info-1.md): Extracts the token after logging in, verifies the token on whether the user is verified on the Conga Platform or Salesforce platform, and returns this information.
- Contact
- [Get contacts](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contacts-name-1.md)
- Encryption
- [Encrypt provided text](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-encryption-encrypt-1.md)
- Query
- [Retrieve dynamic lookup data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-query-objectname.md): This API query retrieves dynamic lookup data containing dynamic fields and dynamic entities. Provide the objectName in the parameters.
- RecordType
- [Retrieve record type](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-record-types-1.md): Retrieves the list of record types available in the document.
- AlternateClause
- [Reorder alternate clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-clauseid-configurations-configurationid-alternates-re-order-1.md): Reorder clause configuration's alternate clauses
- [Link alternate clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-clauseid-alternates-link-1.md): Links alternate clauses to a clause configuration. Alternate clause IDs are passed in the the alternate clause mapping's clause-ranking order.
The clauseConfigurationId parameter is optional.
- [Unlink alternate clauses](https://developer.conga.com/contracts/reference/delete_api-xauthor-v1-clauses-clauseid-alternates-alternateclausemappingid-1.md): Unlinks alternate clauses from a clause configuration.
- ClauseComparison
- [The Api is used to initiate the clause semantic comparison request](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clause-compare-1.md)
- [The API is used to get the comparison status on the basis of comparison id , it can give for multiple ids](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clause-compare-statuses-1.md)
- [The API is used to get the comparison status on the basis of comparison id](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clause-compare-comparisonid-status-1.md)
- [It returns the result after the semantic comparison is completed](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clause-compare-comparisonid-results-1.md)
- ClauseContent
- [Mark plain text as a clause](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clause-content-mark.md): Use this API to mark plain text as a clause. When you post to this endpoint, it applies the clause's clause boundary and smartness properties to the text.
- [Get clause content for document insertion](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clause-content-clauseid-1.md)
- [Get the markup clause details for both template and agreement in encoded format](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clause-content-markup-metadata-1.md)
- Clause
- [List alternate clauses and sub-clauses](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clauses-configurations-clauseconfigid-1.md)
- [Get alternate clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-alternate-1.md): Gets alternate clauses for use in contract negotiations.
- [Get a clause bundle](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clauses-bundles-name-1.md)
- [Validate alternate clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-alternates-check-1.md)
- ClauseLibrary
- [Get clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-query.md): The clause library contains clauses or clause templates that contain modular blocks of contractual language. These blocks can be reused across agreement templates. Using this API, you can fetch all…
- [Filter clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-advance-query-1.md)
- [Promote a clause](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-promote.md): This API promotes a marked clause from an agreement to the clause library, entering that clause into the clause library's clause repository. Once the clause is available in the clause library, you…
- ClauseVersion
- [Get clause content as text or HTML](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clauses-clauseid-versions-clauseversionid-richtext-content-1.md)
- AgreementClause
- [Create agreement clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-clauses-original-1.md): Creates one or more records of agreement clauses based on the agreementId provided in the parameters.
- [Create agreement clauses as final](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-clauses-final-1.md): Creates one or more records of agreement clauses as final based on the agreementId provided in the parameters.
- [Finalize a document's clause entries](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-documentid-clauses-final-1.md)
- [Create agreement clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-documentversionid-files-fileid-clauses-original-1.md): Creates one or more records of agreement clauses based on the agreementId provided in the parameters.
- [Create original entries for the agreement clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-documentversionid-metadata-metadatafileid-clauses-original-1.md)
- [Retrieves the list of agreement clause entries which are revertible.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-documents-documentversionid-clauses-revertible-1.md): Returns all agreement clauses that have latest action as modified and are revertible.
- AgreementDocumentCheckin
- [Check in a document specific to an agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-check-in-1.md)
- AgreementDocument
- [Get agreement document versions](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-versions-1.md): Gets all the document versions associated with a specific agreement based on the agreement ID provided in the parameters.
- [Regenerate an agreement document with the selected template](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-regenerate-1.md)
- [Compare and merge documents](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-compareandmerge-1.md)
- [Get agreement tags](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-documents-documentid-tags-1.md)
- AgreementLock
- [Get lock status](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-lock-status-1.md): When an agreement is open, it is locked by the specific user for editing and cannot be checked out by anyone else. This API gets the current lock status of the agreement based on the agreement ID…
- [Release an agreement lock](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-release-lock-1.md): Releases the agreement's lock based on the agreement ID provided in the parameters. After the lock is released, the user cannot edit the agreement or check it in.
- [Lock an agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-documentid-acquire-lock-1.md): Locks the agreement identified in the parameters. With the lock acquired, the user can edit the agreement document and check it in.
- AgreementOffline
- [Import an offline agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-import-offline-1.md): Imports a contract document into an existing contract record. You must pass the agreement information in the request body to attach a document to an agreement. Fields passed in the request body…
- [Create an offline agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-documents-create-offline-1.md): Creates a new contract document and affixes it to a new contract record. Pass the agreement information in the request body to attach a document to an agreement. Fields passed in the request body…
- [Create offline Agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-documents-create-offline-multipart-1.md): Creates a new contract document and affixes it into a new contract record. Pass the Agreement information in the request body to attach a document to an agreement. Fields passed in the request body…
- [Import an offline agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-import-offline-multipart-1.md): Imports a contract document into an existing contract record. You must pass the agreement information in the request body to attach a document to an agreement. Fields passed in the request body…
- [Create store executed agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-documents-store-executed-multipart-1.md): Creates a new contract document and affixes it into a new contract record. Pass the agreement information in the request body to attach a document to an agreement. Fields passed in the request body…
- AgreementTemplate
- [Get a template for an agreement](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-templates-1.md)
- ContractCheckin
- [Performs post checkin activity like reconcilation / pdf file creation / metadata processing.
File content wont be read as part of this process.Request contains all the information related to file content which is required during checkin](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-check-in-1.md)
- DAI
- [Get IDE job status](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-discovery-ai-contracts-contractid-documents-attachmentid-status-1.md): - Null if IDE import request is not made
- Complete or Job type is In-Review and status Pending
- If job status is complete then we will retrive field and clause in next request and mean while we…
- [Extract and mark the clauses and fields in the request document and also update the metadata](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-discovery-ai-contracts-contractid-documents-attachmentid-markup-document-1.md)
- FieldData
- [Get Locale Based Formatted Field Values](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-metadata-1-fields-retrieve-data-1.md)
- FieldDataRetrieval
- [Get field data with locale based formatted values](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-metadata-2-fields-retrieve-data-1.md)
- FieldMark
- [Mark as field](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-mark-content-1.md): Creates a new field record. The specific content is highlighted and marked as a field. The required parameters are passed in the request body.
- [Mark as field](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-mark-content-2-1.md): Creates a new field record. The specific content is highlighted and marked as a field. The required parameters are passed in the request body.
- Fields
- [Get field data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-data-retrieve.md): Retrieves all the field-related information based on field parameters that are passed in the request body.
- [Retrieves the reference to field name.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-references-metadata-1.md)
- [Get fields data validation.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-validate-1.md)
- [Get fields data validation for V2 metadata](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-validate-v2-1.md)
- [Get Locale Based Formatted Field Values](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-data-fetch-1.md)
- FieldsValidate
- [Validates the fields in a document for a given object and field API name.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-objects-objectname-objectid-fields-fieldapi-validate-1.md)
- IntelligentImport
- [Extract a document](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-documents-1.md): Submits a document for extraction process through CLM API.
- [Get document extraction status](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-intelligent-imports-documents-status-contractid-attachmentid-1.md): Gets the status for requested document. Returns `true` if the document is already sent for extraction, else `false`.
- [Get IDE job status](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-intelligent-imports-jobs-status-contractid-attachmentid-1.md): - Null if IDE import request is not made
- Complete or Job type is In-Review and status Pending
- If job status is complete then we will retrive field and clause in next request and mean while we…
- [Extract and mark the clauses and fields in the request document](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-documents-mark-clauses-and-fields-1.md)
- [Get the doc fields and clauses properties](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-documents-retrieve-properties-contractid-1.md)
- IntelligentImportRisk
- [Get Risk Insights Data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-risks-insights-query-1.md)
- [Update Risk Insights Score](https://developer.conga.com/contracts/reference/patch_api-xauthor-v1-intelligent-imports-risks-insights-1.md)
- [Add Risk Insights Score](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-risks-insights-1.md)
- [Get Risk Scale Data](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-intelligent-imports-risks-scales-1.md)
- [Delete Risk Insights](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-risks-insight-delete-1.md)
- Token
- [Get auth token](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-token-1.md)
- [Validate Sharepoint site](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-sites-sitename-validate-1.md): Checks if the custom-created Sharepoint site is valid.
- [Fetches the google authentication token for communicating with google APIs](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-google-token-1.md)
- UFC
- [Get repeat and section data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-ufc-repeat-data-1.md): Gets a table of repeat and section data to display in the UFC screen.
- [Update repeat and section data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-ufc-update-document-1.md): Update repeat and section data to display in UFC screen.
- User
- [/api/xajs/v1/xAuthor/User/UsersByType](https://developer.conga.com/contracts/reference/post_api-xajs-v1-xauthor-user-usersbytype-1.md)
- [get logged in user info](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-current-user-info-1.md)