# Parley

> Documentation and guides for Parley, the legal agent that delivers finished work and helps law firms manage cases: drafting, exhibit assembly, research, and more.

- [Quickstart](https://docs.parley.so/get-started/quickstart.md): Connect your email, bring your data over, and create your first Skills.
- [The Parley model](https://docs.parley.so/get-started/parley-model.md): The three records Parley organizes around, and the four ideas behind how the system works.
- [Project Overview](https://docs.parley.so/projects/overview.md): A Project is one matter. Everything the case needs, and everything Parley produces for it, lives here.
- [Working in a Project](https://docs.parley.so/projects/working-in-a-project.md): Produce drafts, compile exhibit packets, keep notes, and manage long threads once the Project is set up.
- [Overview](https://docs.parley.so/memory-and-skills/skills.md): Codify how your firm works into reusable instructions the whole team can run.
- [Practice areas](https://docs.parley.so/memory-and-skills/practice-areas.md): The Skill library Parley ships with, organized by practice area.
- [Overview](https://docs.parley.so/parley-agent/overview.md): Use Parley Agent to profile, clean, map, import, and maintain data across your workspace.
- [Importing data](https://docs.parley.so/parley-agent/importing-data.md): Profile a source export, review the mapping, check a sample, import, recover, and reconcile.
- [Workspace maintenance](https://docs.parley.so/parley-agent/workspace-maintenance.md): Manage records, fields, notes, file trees, Skills, and read-only lookups after the data is in.
- [Objects](https://docs.parley.so/self-driving/objects.md): How Parley organizes people, organizations, and work into Accounts, Contacts, and Projects.
- [Where information belongs](https://docs.parley.so/self-driving/where-information-belongs.md): How to choose between native properties, custom fields, notes, files, outputs, email, and calendar.
- [Field types](https://docs.parley.so/self-driving/field-types.md): The typed custom fields available on Accounts, Contacts, and Projects, and when to use each.
- [Self-driving fields](https://docs.parley.so/self-driving/fields.md): What makes a field self-driving, how to design one, and what you get in return.
- [Case management](https://docs.parley.so/self-driving/overview.md): Parley keeps your case fields current from the work you're already doing.
- [Routines](https://docs.parley.so/routines/overview.md): Schedule the Agent to run recurring work on a daily, weekly, or monthly cadence.
- [Tables](https://docs.parley.so/tables/overview.md): Ask the same set of questions across hundreds of documents at once and get structured answers back.
- [Connectors](https://docs.parley.so/connectors/overview.md): Connect the tools your firm already uses so Parley can pull in documents, keep correspondence in sync, and work in your other apps.
- [Document management](https://docs.parley.so/connectors/document-management.md): Sync Projects with Google Drive, SharePoint, Dropbox, Clio, or Box so evidence lands in Parley on its own.
- [Email and calendar](https://docs.parley.so/connectors/email-and-calendar.md): Connect your inbox once and Parley keeps your cases and correspondence in sync, including meeting transcripts.
- [Slack](https://docs.parley.so/connectors/slack.md): Let Parley search your Slack conversations and post updates for you, so what your team discusses in Slack becomes part of the case.
- [Parley for Word](https://docs.parley.so/addins/parley-for-word.md): Bring the Agent into Microsoft Word to revise drafts with tracked, word-level redlines.
- [Parley for Outlook](https://docs.parley.so/addins/parley-for-outlook.md): Draft email responses, query matter data, and conduct legal research from inside Outlook, without leaving your inbox.
- [Claude and ChatGPT](https://docs.parley.so/ai-assistants/claude-and-chatgpt.md): Use Parley from Claude or ChatGPT to check on your cases, read files and notes, and make updates when you ask.
- [Permissions](https://docs.parley.so/admin/permissions.md): What Owners, Admins, and Members can each do in Parley.
- [Plans](https://docs.parley.so/plans-and-billing/plans.md): What each plan includes, how billing periods work, and how to change plans.
- [How credits work](https://docs.parley.so/plans-and-billing/how-credits-work.md): What draws from your credit balance, what doesn't, and how rollover, overages, and spending controls behave.
- [Pricing and usage FAQs](https://docs.parley.so/plans-and-billing/pricing-faqs.md): Common questions about seats, document processing, credit estimates, and running out of credits.
- [Security and compliance](https://docs.parley.so/security-and-compliance/overview.md): How Parley protects your firm's confidential client data, and the standards we follow.
- [Getting support](https://docs.parley.so/help/getting-support.md): Where to reach the Parley team, ask questions, and get support.
- [Introduction](https://docs.parley.so/api-reference/introduction.md): Read and manage your Parley workspace over an API.
- [Authentication](https://docs.parley.so/api-reference/authentication.md): Authenticate API requests with a Parley API key.
- [Pagination](https://docs.parley.so/api-reference/pagination.md): Page through list endpoints with cursors.
- [Errors](https://docs.parley.so/api-reference/errors.md): Status codes and the error response shape.
- [List projects](https://docs.parley.so/api-reference/projects/list-projects.md): List the projects (matters or cases) the caller can see, newest first by default. Filter by name, linked account or contact, and when projects were created or updated.
- [Create a project](https://docs.parley.so/api-reference/projects/create-a-project.md): Create a project (matter or case), optionally linked to accounts and contacts. Visible to everyone in the organization unless access is restricted to specific members.
- [Get a project](https://docs.parley.so/api-reference/projects/get-a-project.md): Get a single project (matter or case) by ID.
- [Delete a project](https://docs.parley.so/api-reference/projects/delete-a-project.md): Permanently delete a project (matter or case) along with its files, outputs, tables, and tasks. This cannot be undone.
- [Update a project](https://docs.parley.so/api-reference/projects/update-a-project.md): Rename a project (matter or case) or change its linked accounts and contacts. Omitted fields are left unchanged.
- [List accounts](https://docs.parley.so/api-reference/accounts/list-accounts.md): List accounts (the client organizations the firm works with), newest first by default. Filter by name, linked project, and when accounts were created or updated. An account's updatedAt covers the account itself; contacts joining or leaving do not change it.
- [Create an account](https://docs.parley.so/api-reference/accounts/create-an-account.md): Create an account (a client organization), optionally linked to projects. Link people to it with create_contact or update_contact.
- [Get an account](https://docs.parley.so/api-reference/accounts/get-an-account.md): Get a single account (client organization) by ID.
- [Delete an account](https://docs.parley.so/api-reference/accounts/delete-an-account.md): Permanently delete an account (client organization) along with its notes, files, and tasks. Its contacts are kept and unlinked from the account. This cannot be undone.
- [Update an account](https://docs.parley.so/api-reference/accounts/update-an-account.md): Rename an account (client organization) or change the projects it is linked to. Omitted fields are left unchanged.
- [List contacts](https://docs.parley.so/api-reference/contacts/list-contacts.md): List contacts (people, each optionally belonging to one account), newest first by default. Filter by name or email, account, linked project, and when contacts were created or updated.
- [Create a contact](https://docs.parley.so/api-reference/contacts/create-a-contact.md): Create a contact (a person), optionally belonging to an account and linked to projects. An email address can belong to only one contact.
- [Get a contact](https://docs.parley.so/api-reference/contacts/get-a-contact.md): Get a single contact (person) by ID.
- [Delete a contact](https://docs.parley.so/api-reference/contacts/delete-a-contact.md): Permanently delete a contact (person) along with its notes, files, and tasks. This cannot be undone.
- [Update a contact](https://docs.parley.so/api-reference/contacts/update-a-contact.md): Update a contact's name, account, email address, or linked projects. Omitted fields are left unchanged.
- [List tasks](https://docs.parley.so/api-reference/tasks/list-tasks.md): List the tasks the caller can see, newest first by default. A task on a project is visible to the people who can see that project; any other task is visible to everyone in the organization. Filter by status, assignee, due date, the record a task is about, title, and when tasks were created or update…
- [Create a task](https://docs.parley.so/api-reference/tasks/create-a-task.md): Create a task, optionally about one project, account, or contact. A new task has the status Todo; set its status, assignee, due date, and description through its fields. Pass reminder to have Parley remind the caller about it.
- [Get a task](https://docs.parley.so/api-reference/tasks/get-a-task.md): Get a single task by ID, with its field values and the caller's own reminder for it.
- [Delete a task](https://docs.parley.so/api-reference/tasks/delete-a-task.md): Permanently delete a task, along with everyone's reminders for it. This cannot be undone.
- [Update a task](https://docs.parley.so/api-reference/tasks/update-a-task.md): Rename a task, change the record it's about, set its field values, or set or remove the caller's reminder for it. Omitted properties are left unchanged. Anyone who can see a task can set their own reminder on it.
- [List fields](https://docs.parley.so/api-reference/fields/list-fields.md): List the custom fields defined for projects, accounts, contacts, and tasks, newest first by default. Filter by record type, value type, name, and when fields were created or updated. Field values live on the records, in the fields of get_project, get_account, get_contact, and get_task.
- [Create a field](https://docs.parley.so/api-reference/fields/create-a-field.md): Define a custom field for projects, accounts, contacts, or tasks. Set its values with the fields input of the create and update tools for that record type. Parley doesn't fill task fields, so their automation is off. Requires the owner or admin role.
- [Get a field](https://docs.parley.so/api-reference/fields/get-a-field.md): Get a single custom field definition by ID.
- [Delete a field](https://docs.parley.so/api-reference/fields/delete-a-field.md): Permanently delete a custom field and erase its value from every record. This cannot be undone. System fields can't be deleted. Requires the owner or admin role.
- [Update a field](https://docs.parley.so/api-reference/fields/update-a-field.md): Rename a custom field, change its automation, or add, rename, and remove single_select options. Omitted properties are left unchanged, and the type can't change. System fields can't be updated. Requires the owner or admin role.
- [List account notes](https://docs.parley.so/api-reference/notes/list-account-notes.md): List the notes on the account, newest first by default.
- [Add a note to the account](https://docs.parley.so/api-reference/notes/add-a-note-to-the-account.md): Create a markdown note on the account.
- [List contact notes](https://docs.parley.so/api-reference/notes/list-contact-notes.md): List the notes on the contact, newest first by default.
- [Add a note to the contact](https://docs.parley.so/api-reference/notes/add-a-note-to-the-contact.md): Create a markdown note on the contact.
- [Get a note](https://docs.parley.so/api-reference/notes/get-a-note.md): Get a note by ID, including its markdown content.
- [Delete a note](https://docs.parley.so/api-reference/notes/delete-a-note.md): Delete a note. This cannot be undone.
- [Update a note](https://docs.parley.so/api-reference/notes/update-a-note.md): Rename a note or replace its content. Pass the version you last read as expectedVersion: if someone changed the note since, this returns 409 and changes nothing. Omitted fields are left unchanged.
- [List project notes](https://docs.parley.so/api-reference/notes/list-project-notes.md): List the notes on the project, newest first by default.
- [Add a note to the project](https://docs.parley.so/api-reference/notes/add-a-note-to-the-project.md): Create a markdown note on the project.
- [List account files](https://docs.parley.so/api-reference/files/list-account-files.md): List the files and folders in the account, newest first by default. Starts at the top level: pass folderId to list inside a folder, and recursive=true to include everything below.
- [Add a file to the account](https://docs.parley.so/api-reference/files/add-a-file-to-the-account.md): Add an uploaded file to the account. Create the upload with POST /uploads and PUT the file's bytes to its url first. Parley then extracts the file's text in the background, and the file can be read once its status is ready. Adding the same upload again returns the same file; adding it anywhere else…
- [Create a folder in the account](https://docs.parley.so/api-reference/files/create-a-folder-in-the-account.md): Create a folder in the account, at the top level or inside another folder. If a folder with that name is already there, a number is appended, as in "Evidence (2)".
- [List contact files](https://docs.parley.so/api-reference/files/list-contact-files.md): List the files and folders in the contact, newest first by default. Starts at the top level: pass folderId to list inside a folder, and recursive=true to include everything below.
- [Add a file to the contact](https://docs.parley.so/api-reference/files/add-a-file-to-the-contact.md): Add an uploaded file to the contact. Create the upload with POST /uploads and PUT the file's bytes to its url first. Parley then extracts the file's text in the background, and the file can be read once its status is ready. Adding the same upload again returns the same file; adding it anywhere else…
- [Create a folder in the contact](https://docs.parley.so/api-reference/files/create-a-folder-in-the-contact.md): Create a folder in the contact, at the top level or inside another folder. If a folder with that name is already there, a number is appended, as in "Evidence (2)".
- [Get a file](https://docs.parley.so/api-reference/files/get-a-file.md): Get a file or folder by ID. A file can be read once its status is ready.
- [Delete a file](https://docs.parley.so/api-reference/files/delete-a-file.md): Delete a file, or a folder along with everything in it. This cannot be undone.
- [Update a file](https://docs.parley.so/api-reference/files/update-a-file.md): Rename a file or folder, or move it to another folder in the same location. Omitted fields are left unchanged. Returns 409 if the destination already has an item with that name.
- [Read a file](https://docs.parley.so/api-reference/files/read-a-file.md): Read the text Parley extracted from a file, one window at a time. Scanned pages are OCRed, and paged documents mark each page with <document-page number="N" />. When nextOffset is not null there is more text: pass it back as offset to keep reading. Returns 409 until the text has been extracted, or i…
- [Get a file download URL](https://docs.parley.so/api-reference/files/get-a-file-download-url.md): Get a short-lived URL that downloads the original file as it was uploaded.
- [List library files](https://docs.parley.so/api-reference/files/list-library-files.md): List the files and folders in the library, newest first by default. Starts at the top level: pass folderId to list inside a folder, and recursive=true to include everything below.
- [Add a file to the library](https://docs.parley.so/api-reference/files/add-a-file-to-the-library.md): Add an uploaded file to the library. Create the upload with POST /uploads and PUT the file's bytes to its url first. Parley then extracts the file's text in the background, and the file can be read once its status is ready. Adding the same upload again returns the same file; adding it anywhere else…
- [Create a folder in the library](https://docs.parley.so/api-reference/files/create-a-folder-in-the-library.md): Create a folder in the library, at the top level or inside another folder. If a folder with that name is already there, a number is appended, as in "Evidence (2)".
- [List project files](https://docs.parley.so/api-reference/files/list-project-files.md): List the files and folders in the project, newest first by default. Starts at the top level: pass folderId to list inside a folder, and recursive=true to include everything below.
- [Add a file to the project](https://docs.parley.so/api-reference/files/add-a-file-to-the-project.md): Add an uploaded file to the project. Create the upload with POST /uploads and PUT the file's bytes to its url first. Parley then extracts the file's text in the background, and the file can be read once its status is ready. Adding the same upload again returns the same file; adding it anywhere else…
- [Create a folder in the project](https://docs.parley.so/api-reference/files/create-a-folder-in-the-project.md): Create a folder in the project, at the top level or inside another folder. If a folder with that name is already there, a number is appended, as in "Evidence (2)".
- [Create an upload](https://docs.parley.so/api-reference/files/create-an-upload.md): Start uploading a file. PUT the file's bytes to the returned url in one request before it expires (for example, curl -X PUT --upload-file ./letter.pdf "$URL"). Then pass the upload's id as uploadId: to add_file to add the file to a location, or to upsert_skill for a skill.
- [List account activity](https://docs.parley.so/api-reference/activity/list-account-activity.md): List the account's activity feed, newest first: the items on its Activity tab in Parley.
- [List activity](https://docs.parley.so/api-reference/activity/list-activity.md): List activity across the organization, newest first: projects, accounts, and contacts created, deleted, changed, and linked; notes and files added or deleted; USCIS case status updates; and synced emails and meetings with contacts. Each item appears once, on the record it happened to. To see everyth…
- [List contact activity](https://docs.parley.so/api-reference/activity/list-contact-activity.md): List the contact's activity feed, newest first: the items on its Activity tab in Parley.
- [List project activity](https://docs.parley.so/api-reference/activity/list-project-activity.md): List the project's activity feed, newest first: the items on its Activity tab in Parley.
- [List automations](https://docs.parley.so/api-reference/automations/list-automations.md): List your automations, newest first by default, each with its next run and most recent run. Other people's automations aren't listed.
- [Create an automation](https://docs.parley.so/api-reference/automations/create-an-automation.md): Create an automation: instructions Parley's assistant carries out whenever one of its triggers fires, as you, with nobody present. The automation is active as soon as it's created. Without a trigger it only runs when someone starts it with run_automation.
- [Get an automation](https://docs.parley.so/api-reference/automations/get-an-automation.md): Get one of your automations by ID, with its triggers and instructions.
- [Delete an automation](https://docs.parley.so/api-reference/automations/delete-an-automation.md): Delete an automation with its triggers, its run history, and the conversations its runs produced, and cancel any run in progress. This cannot be undone; to stop an automation running, pause it with update_automation instead.
- [Update an automation](https://docs.parley.so/api-reference/automations/update-an-automation.md): Rename an automation, replace its instructions, add or remove triggers, pause or resume it, or move it to another project. Omitted fields are left unchanged.
- [List an automation's runs](https://docs.parley.so/api-reference/automations/list-an-automations-runs.md): List an automation's runs, newest first by default, with what started each one, how it ended, and why a failed run failed.
- [Run an automation now](https://docs.parley.so/api-reference/automations/run-an-automation-now.md): Start a run of an automation now, without waiting for a trigger. A paused automation can be run too. Returns the run as soon as it's queued; follow its progress with list_automation_runs. Returns 429 when the organization has reached its limit of automation runs for a given period; don't retry until…
- [List skills](https://docs.parley.so/api-reference/skills/list-skills.md): List the organization's skills and your personal ones, newest first by default. Parley's built-in skills aren't listed.
- [Get a skill](https://docs.parley.so/api-reference/skills/get-a-skill.md): Get a skill by slug, including its SKILL.md and the paths of its bundled documents.
- [Create or update a skill](https://docs.parley.so/api-reference/skills/create-or-update-a-skill.md): Create the skill with this slug, or update it if you can see one: replace its SKILL.md or the whole skill with its bundled documents, change when it's used, or turn it on or off. A new skill is on as soon as it's created. Fields left out of an update are unchanged, and created says which happened. R…
- [Delete a skill](https://docs.parley.so/api-reference/skills/delete-a-skill.md): Delete a skill and its bundled documents. This cannot be undone; to stop Parley using a skill, turn it off with upsert_skill instead.
- [Get a skill download URL](https://docs.parley.so/api-reference/skills/get-a-skill-download-url.md): Get a short-lived URL that downloads the whole skill, its SKILL.md and bundled documents, as a .skill archive.
- [Get the current user](https://docs.parley.so/api-reference/users/get-the-current-user.md): Get the user you're acting as, the owner of the API key or the user who signed in, with their role and organization.
- [List users](https://docs.parley.so/api-reference/users/list-users.md): List the people in your organization, newest first by default. A user's id is what create_project takes in memberIds and what a field of type user takes as its value.
- [Get a user](https://docs.parley.so/api-reference/users/get-a-user.md): Get a person in your organization by user ID.

## OpenAPI Specs

- [openapi](https://api.parley.so/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.