All Resources

Resource	Description
Gets the folder details by ID	Retrieves the full metadata and details of a specific client folder using its unique Smarter Drafter ID.
Gets the library of client folders	Retrieves a collection or list representing the available library of folders associated with the client.

Forms

Forms are built as an automation using fields, and are sent to users to complete

Resource	Description
GET /Forms/:id/Fields	Returns fields from a specified form
GET /Forms/:id	Returns a specified form
GET /Forms	Search for forms with specified query parameters
Retrieves a form by ID	Retrieves the full configuration details of a specific Smarter Drafter form using its unique identifier.
Searches for forms based on the provided filter and pagination parameters	Allows searching and retrieving a paginated list of available forms based on specified criteria.
Retrieves fields by form ID	Retrieves a list of all data fields that are contained within a specified form.

Submissions

Submissions are completed forms, often with generated documents

Resource	Description
Get a submission by its ID	Retrieves the full status and details of a specific document generation submission using its unique identifier.
Get submission mapping by its ID	Retrieves the data mapping and context used by the submission to connect to Matter Records and other data sources.
Searches for submissions based on the provided query parameters	Allows searching and retrieving a list of document submissions based on filters such as creation date, form, or status.
Download generated document	Retrieves the final, generated document file (e.g., Word or PDF) associated with a completed submission.
Download submission answer file	Retrieves the raw data or answer file that contains all the input values used to populate the document.
Creates a new submission and queue documents for generation	Programmatically initiates a new document drafting process by sending initial data and queuing the final document for generation.
Submit submission and queue documents for generation	Finalises a submission that is in progress and immediately triggers the document generation process.
Update answer for a submission and field	Allows updating the value for a specific field within an existing document submission record.
Deletes a submission by its Id	Permanently removes a document submission record and its associated files.

Field Alias

[Field Alias](<field aliases#>) store the specific data values within a Record (e.g., full_name, ABN, email_address).

Resource	Description
Get an alias by ID	Retrieves the full definition of a Field Alias using its unique, internal Smarter Drafter ID.
Get an alias by name	Retrieves the full definition of a Field Alias using its technical name string (e.g., client_first_name).
Search for aliases based on the query parameters	Allows searching and retrieving a list of Field Alias definitions based on provided filter criteria (e.g., associated Custom Data Source).
Add a new alias	Creates a new Field Alias definition to standardise a specific data property for use in Records.
Update an alias by ID	Updates the details of an existing Field Alias, primarily its display name, using its unique Smarter Drafter ID.
Delete an alias by ID	Permanently removes an existing Field Alias definition from the system.

Record Types

[Record Types](<record types#>) categorise Records as Roles (eg., "Client", "Vendor"), or Matter Details (eg., "Trial Information") helping define how the Record relates to the matter.

Resource	Description
Get a record type by ID	Retrieves the full definition of a Record Type, including its category (Role or Matter Details), using its unique Smarter Drafter ID.
Get a record type by API identifier	Retrieves the full definition of a Record Type using the unique technical identifier created for the API integration.
Search for record types based on query parameters	Allows searching and retrieving a list of Record Type definitions based on filter criteria, such as category or associated data source.
Add a new record type	Creates a new Record Type definition, categorised as either a Role (for people) or Matter Details (for things/concepts).
Update a record type by ID	Updates the details of an existing Record Type, primarily its display name or category, using its unique Smarter Drafter ID.
Deprecate a record type by ID	Archives or sets the status of an existing Record Type to deprecated, preventing it from being used for new Records.
Reactivate a record type by ID	Restores a previously deprecated Record Type, making it available again for use when creating new Records.

Matters

Matters are the cases from your source system that acts as the central container for associated data in Smarter Drafter

Resource	Description
Get a matter by ID	Retrieves the full details of a matter using its unique, internal Smarter Drafter ID.
Get a matter by external ID	Retrieves the details of a matter by querying its unique identifier from your connected external source system.
Search for matters based on query parameters	Allows searching and retrieving a paginated list of matters based on provided filter criteria (e.g., name, creation date, or status).
Add a new matters	Creates a new Matter record in Smarter Drafter, establishing the central data container for a case file from your external system.
Update a matter by ID	Updates the main descriptive details of an existing Matter using its unique Smarter Drafter ID.
Update the users that have access to a matter	Modifies the list of specific Smarter Drafter users who are explicitly granted access to the Matter's data.
Update the groups that limits access to a matter	Modifies the Smarter Drafter user groups that are permitted to access the Matter's data.
Deprecate a matter	Archives or sets the status of an existing matter to deprecated, removing it from active use without deletion.

Records

Records are the individual data entities that are associated to a matter. These are the payloads of information - such as a specific person (Contact), a business entity (Company), or Matter Information (Matter Data) - that are used to pre-fill the form.

Resource	Description
Get a record by ID	Retrieves the full details, including all stored data values, of a specific Record using its unique, internal Smarter Drafter ID.
Get a record by external ID	Retrieves a Record's details by querying its unique identifier from your connected external source system.
Search for records based on query parameters	Allows searching and retrieving a list of Records based on provided query parameters (e.g., Record Type ID or Custom Data Source ID).
Add a new records	Creates a new Record entity, importing the data values from your source system and associating them with a Record Type.
Update a record by ID	Replaces the full data set or updates the details of an existing Record using its unique Smarter Drafter ID.
Update the record types associate to a record	Allows changing the Record Type assigned to an existing Record entity.
Update the aliases associate to a record	Allows modifying the specific set of Field Aliases and their values stored within an existing Record.
Deactivate a record by ID	Sets the status of an existing Record to inactive, making it unavailable for use in new forms without permanent deletion.
Reactivate a record by ID	Restores a previously deactivated Record, making it available again for use within the Matter Record system.
Deletes a record by ID	Permanently removes a Record entity from the Matter Record data store.

Groups

Groups allow for access to be assigned collectively to multiple users.

Resource	Description
Get a group by ID	Retrieves the full details and list of members for a specific user group using its unique Smarter Drafter ID.
Search for groups based on query parameters	Allows searching and retrieving a list of user groups based on filter criteria like name or member status.
Add a new group	Creates a new user group within Smarter Drafter for the purpose of organising users and controlling access.
Updates a group	Updates the main descriptive details, such as the name, of an existing user group.
Updates the members of a group	Modifies the list of users that are included as members of a specific user group.
Delete a group by ID	Permanently removes an existing user group from the system.