Developers

ClerkDirect API

Read and manage your organization's meetings, agendas, motions, minutes, tasks and automations from your own systems. 88 endpoints, organized around the same things you work with in ClerkDirect.

https://clerkdirect.com/api/v1OpenAPI 3.1 specMCP server
Contents

Overview

The API is organized by product area: meetings, their agenda items and motions, documents, tasks, automations, boards and so on. Every request is made as the member who created the API key, with their role, so it can read and change exactly what they can in the app, and changes show up in ClerkDirect with that person's name.

Ava, ClerkDirect's assistant, works through the same operations. Each endpoint below lists the Ava tool that does the same thing, so anything you can ask Ava to do you can also automate.

AI assistants outside ClerkDirect, such as Claude or Cursor, can use the same endpoints as tools through the MCP server.

Authentication

Every member creates their own API keys in ClerkDirect under Settings → Developers. A key is shown once, when it's created. Send it as a bearer token:

curl https://clerkdirect.com/api/v1/organization \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"
  • A key has the access of the member who created it, through their role. A participant's key reads what they can see and records their own votes, updates the status of tasks assigned to them, comments on tasks and acts on reviews assigned to them. Meeting managers and administrators can do as much as they can in the app. If the member's role changes, so does what the key can do.
  • A key stops working when the member who created it leaves the organization. Administrators can revoke any member's key.
  • Keep keys on your servers. Don't put them in browser code, mobile apps or source control. Revoke a key from Settings → Developers if it leaks.
  • Your data stays in its region: a key for a Canadian organization begins cdk_ca_ and its requests are served from Canadian storage.

Requests and responses

  • Send and receive JSON. Field names are camelCase.
  • Successful responses wrap the result in data: { "data": { "id": 4812, ... } }.
  • Times are ISO 8601 in UTC (2026-11-19T01:00:00.000Z); dates are YYYY-MM-DD. A meeting's timeZonesays where it's held.
  • PATCH changes only the fields you send. Send null to clear a field that allows it.
  • Every response has an X-Request-Id header. Include it when you contact support.

Errors

Errors have a status code and a body like this:

{
  "error": {
    "code": "invalid_request",
    "message": "body.startsAt must be an ISO 8601 date and time.",
    "details": { "issues": [{ "path": "startsAt", "message": "must be an ISO 8601 date and time", "in": "body" }] },
    "requestId": "req_4f1c2a9b0e7d3c5a61"
  }
}
400invalid_requestA parameter or field is missing or invalid. details.issues lists each one.
401unauthorizedNo key, a revoked key, or a key whose creator has left the organization.
403forbiddenThe key's creator can't read or change this in the app: their role doesn't allow the change, or it's a closed session they can't see.
404not_foundNothing with that ID in your organization, or no such endpoint.
405method_not_allowedThe path exists but not with this method. The Allow header lists the methods.
409conflictThe change conflicts with the current state, such as deleting a motion while voting is open.
413payload_too_largeRequest bodies are limited to 1 MB. A file sent in the request can be up to 6 MB; start an upload for larger files.
429rate_limitedToo many of one kind of request, such as sign-in links for one member. Wait and retry.
500internal_errorSomething failed on our side. Retry, and contact support with the requestId if it persists.
502upstream_errorSomething failed on our side. Retry, and contact support with the requestId if it persists.

Pagination

Endpoints that can return many results take limit (default 50, at most 200) and return a page with hasMore and nextCursor. Pass nextCursor as cursor to get the next page.

{
  "data": [ ... ],
  "hasMore": true,
  "nextCursor": "p2.50"
}

Uploading files

Files go straight to storage, so they can be up to 5 GB. Uploading one takes three requests:

  1. Start an upload on the agenda item or meeting, with the file's name and exact size in bytes. You get an uploadUrl, the headers to send and an uploadId.
  2. PUT the file's bytes to uploadUrl with those headers, within two hours. It needs no API key. Storage refuses a file of any other size, and a second PUT once the file is stored (412), so running the command again is harmless. Completing the upload refuses a file sent with another Content-Type.
  3. Complete the upload with uploadId, within a day. The document is added then (201), and attached under the agenda item if you started there. Completing again returns the same document (200), so a failed request is safe to retry.
curl -X POST https://clerkdirect.com/api/v1/agenda-items/482/documents/uploads \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"fileName": "Staff Report.pdf", "fileSize": 48213977}'

# Its curl field runs the PUT:
curl --globoff -X PUT -H 'Content-Type: application/pdf' -H 'If-None-Match: *' \
  --upload-file 'Staff Report.pdf' "$UPLOAD_URL"

curl -X POST https://clerkdirect.com/api/v1/documents/uploads/complete \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"uploadId": "'"$UPLOAD_ID"'"}'

Files up to 6 MB can also go in one request, to Upload a document to an agenda item or to a meeting: as multipart/form-data with the file in a file part, or as JSON with the file base64-encoded in content.

A file already on a public website, such as a staff report the city posted, can be added from its link instead: ClerkDirect fetches it, up to 250 MB. The link must open the file itself, without signing in, and lead to a public address.

curl -X POST https://clerkdirect.com/api/v1/agenda-items/482/documents/imports \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://www.springfield.gov/files/staff-report.pdf"}'

Ava and the API

Ava and the API cover the same product. Ava finds things by name (“the October council meeting”) where the API takes IDs, but they make the same changes with the same permissions. These Ava tools have an API equivalent:

Ava toolAPI
add_agenda_item
add_board_member
add_meeting_participants
archive_meeting_type
attach_document_to_agenda_item
comment_on_task
create_agenda_items
create_automation
create_board
create_meeting
create_meeting_type
create_motion
create_motions
create_task
create_tasks
delete_action_item
delete_agenda_item
delete_automation
delete_board
delete_board_member
delete_document_artifact
delete_meeting
delete_meeting_session
delete_motion
get_action_items
get_agenda
get_agenda_templates
get_automation_runs
get_automations
get_boards
get_broadcast_transcript
get_document_templates
get_meeting_attendees
get_meeting_detail
get_meeting_minutes
get_meeting_transcript
get_meetings
get_org_settings
get_portal_settings
get_resolutions
get_task_comments
get_template_workspace
get_votes
get_workspace_members
link_task_motions
read_document_source
record_attendance
record_votes
remind_open_tasks
remind_reviewers
request_review
restore_meeting_type
run_automation
search_across_minutes
search_artifacts
search_meetings
send_sign_in_link
transcribe_recordings
update_action_item
update_agenda_item
update_automation
update_board
update_board_member
update_meeting
update_meeting_publication
update_meeting_type
update_motion
update_motions
update_portal_settings

Some of what Ava does has no endpoint, because it works on what you have open in the app or uses Ava's writing model:

  • Works on the page or document the member has open in the app.

    show_ui_targetopen_pagecontrol_document_viewedit_active_documentget_document_editor_contextsearch_document_editor_meeting_contextsearch_document_editor_textedit_document_layout

  • Drafts or rewrites content with Ava's writing model, from files attached to the chat.

    edit_document_artifactregenerate_document_targetgenerate_document_artifactdraft_agenda_version_from_sourcescreate_meeting_session_from_sourcescreate_meeting_from_uploaded_recordingread_uploaded_documentsummarize_uploaded_documentlist_document_sourcescancel_generationprepare_motion_importapply_motion_import

  • Template design happens in the template workspace with Ava.

    get_agenda_template_outlineset_agenda_template_outlinecreate_template_from_examplesrename_templateassign_agenda_template_to_meeting_typesread_template_fileupdate_template_workspace

  • Reads the member's connected SharePoint through their Microsoft sign-in.

    list_sharepoint_filessearch_sharepoint_filesread_sharepoint_filecopy_to_sharepoint

  • About Ava itself: help, support, saved instructions and its own activity log.

    search_help_articlesescalate_to_supportlist_saved_actionsrun_saved_actionget_audit_log

  • Live broadcast and media playback in the app.

    get_broadcast_statusget_media_context

  • Not in the API yet.

    clear_agendacopy_agenda_item_to_meetingset_session_minuteslist_document_versionsrestore_document_version

AI assistants (MCP)

ClerkDirect is also a Model Context Protocol server, so an AI assistant you use can work with your meetings directly. Every endpoint on this page is one of its tools; each lists its tool name. The server is at:

https://clerkdirect.com/api/v1/mcp

Any member can connect an assistant, with their own role's access, in one of two ways.

Sign in (OAuth)

Assistants that add servers by URL, such as Claude.ai, ChatGPT and Copilot Studio, sign you in to ClerkDirect: add the server URL as a custom connector, sign in when asked, and choose your organization. The assistant then acts as you. Disconnect it from the assistant's settings to stop it.

API key

Clients that send a header can use an API key the same way the API does. Create a key for the assistant in Settings → Developers, so you can revoke it on its own. In Claude Code:

claude mcp add --transport http clerkdirect \
  https://clerkdirect.com/api/v1/mcp \
  --header "Authorization: Bearer $CLERKDIRECT_API_KEY"

In clients configured with JSON, such as Cursor:

mcp.json
{
  "mcpServers": {
    "clerkdirect": {
      "url": "https://clerkdirect.com/api/v1/mcp",
      "headers": { "Authorization": "Bearer cdk_..." }
    }
  }
}
  • The assistant acts as the member who created the key, with their role, exactly like an API request, and its changes show in ClerkDirect under their name.
  • Tools return the same JSON as their endpoints. A failed call returns the same error object, with its requestId, so the assistant can see what to fix.
  • Downloading a document returns the file itself, up to 8 MB. Use the API for larger files.
  • An assistant that can run commands, such as Claude Code, uploads a file of any size by starting an upload, running the curl command it returns, and completing it. Any assistant can add a file from a public link with the import tools. The upload tools that take the file base64-encoded in content suit only small files: the assistant writes the whole file into the call.
  • The server uses MCP's Streamable HTTP transport without sessions. Sign-in follows MCP's authorization spec, with ClerkDirect's sign-in as the authorization server; the API itself takes only keys.

Ava is the assistant inside ClerkDirect. It uses these same operations, and also drafts documents with ClerkDirect's writing model and works on what you have open in the app, which outside assistants can't.

Organization

Your workspace, its members and their roles.

GET/api/v1/organization

Get your organization

The organization your API key belongs to.

Returns

200 with { data }, where data is Organization.

Example request
curl https://clerkdirect.com/api/v1/organization \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: organization_get

Ava: get_org_settings

GET/api/v1/members

List members

Everyone in the organization. Use userId to assign tasks or add board members.

Query parameters

limit
integer
How many results to return (1-200, default 50). 1-200.
cursor
string
The nextCursor from the previous page. Omit it for the first page.

Returns

200 with { data: [...], hasMore, nextCursor }, where data is page of Member.

Example request
curl https://clerkdirect.com/api/v1/members \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: organization_members_list

Ava: get_workspace_members

Meetings

Meetings and everything that hangs off one: agenda, attendees, sessions, minutes, transcript and public portal publication.

GET/api/v1/meetings

List meetings

Meetings newest first unless you set order. Filter by date, board, type or status.

Query parameters

search
string
Words in the title, description, location or board name. Up to 80 characters.
boardId
integer
Only this board's meetings.
meetingTypeId
string
Only meetings of this type.
from
string (date)
Meetings on or after this date (YYYY-MM-DD).
to
string (date)
Meetings on or before this date (YYYY-MM-DD).
status
string
active: not cancelled. public: published to the portal. internal: not published. cancelled: cancelled.
activepublicinternalcancelled
order
string
By start time. Defaults to desc (newest first).
ascdesc
limit
integer
How many results to return (1-200, default 50). 1-200.
cursor
string
The nextCursor from the previous page. Omit it for the first page.

Returns

200 with { data: [...], hasMore, nextCursor }, where data is page of Meeting.

Example request
curl https://clerkdirect.com/api/v1/meetings \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_list

Ava: get_meetings, search_meetings — Ava also matches meetings by a fuzzy title; the API filters by search words.

GET/api/v1/meetings/{meetingId}

Get a meeting

One meeting with its sessions and the documents your key's creator can read.

Path parameters

meetingIdrequired
integer
Meeting ID.

Returns

200 with { data }, where data is MeetingDetail.

Example request
curl https://clerkdirect.com/api/v1/meetings/4812 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_get

Ava: get_meeting_detail

POST/api/v1/meetings

Create a meeting

Creates a meeting with an empty agenda. Members on the meeting's board with an email address get a calendar invitation. Set recurrence to create a series; the response is its first occurrence.

Body

titlerequired
string
The meeting's name, such as Regular Council Meeting. Up to 500 characters.
description
string or null
Notes about the meeting, shown on its page. Up to 20000 characters.
startsAtrequired
string (date-time)
Start time, ISO 8601 with an offset (2026-11-18T19:00:00-06:00) or in UTC.
timeZone
string
IANA time zone the meeting is held in, such as America/Chicago.
durationMinutes
integer
How long it's scheduled for, used for calendar invitations. 15-1440.
location
string or null
Where it's held, such as Council Chambers, City Hall. Up to 500 characters.
boardId
integer or null
The board or committee holding the meeting.
meetingTypeId
string or null
A meeting type ID.
tags
array of string
Labels for finding and filtering meetings in ClerkDirect. Replaces the list. Up to 50 items.
guests
array of object
People attending who aren't on the board, such as staff or presenters. Up to 100 items.
guests[].namerequired
string
Their full name. Up to 255 characters.
guests[].email
string (email)
Their email address. When a meeting is created with guests, guests with an email get its calendar invitation.
guests[].title
string
Their role, such as City Engineer or Applicant. Up to 255 characters.
guests[].isVotingMember
boolean
Whether they can vote on motions. Defaults to false.
recurrence
object
Repeat the meeting.
recurrence.frequencyrequired
string
How often it repeats.
dailyweeklymonthlyyearly
recurrence.interval
integer
Every N periods. Defaults to 1. 1-99.
recurrence.weekdays
array of string
For weekly meetings, the days it falls on.
MOTUWETHFRSASU
recurrence.monthlyNthWeekday
object
For monthly meetings on, say, the second Tuesday.
recurrence.monthlyNthWeekday.weekdayrequired
string
The day of the week.
MOTUWETHFRSASU
recurrence.monthlyNthWeekday.nthrequired
integer
1-5, or -1 for the last. -1-5.
recurrence.until
string (date)
Last date it can fall on.
recurrence.count
integer
How many occurrences. 1-500.

Returns

201 with { data }, where data is Meeting.

Example request
curl -X POST https://clerkdirect.com/api/v1/meetings \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Regular Council Meeting",
    "startsAt": "2026-11-18T19:00:00-06:00",
    "timeZone": "America/Chicago",
    "durationMinutes": 120,
    "location": "Council Chambers, City Hall",
    "boardId": 12
  }'

MCP tool: meetings_create

Ava: create_meeting

PATCH/api/v1/meetings/{meetingId}

Update a meeting

Changes only the fields you send. To publish or unpublish, use the publication endpoint. When a published, upcoming meeting is cancelled or its time or location changes, residents subscribed on the public portal are emailed.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

title
string
The meeting's name, such as Regular Council Meeting. Up to 500 characters.
description
string or null
Notes about the meeting, shown on its page. Up to 20000 characters.
startsAt
string (date-time)
Start time, ISO 8601 with an offset (2026-11-18T19:00:00-06:00) or in UTC.
timeZone
string
IANA time zone the meeting is held in, such as America/Chicago.
durationMinutes
integer
How long it's scheduled for, used for calendar invitations. 15-1440.
location
string or null
Where it's held, such as Council Chambers, City Hall. Up to 500 characters.
boardId
integer or null
The board or committee holding the meeting.
meetingTypeId
string or null
A meeting type ID.
tags
array of string
Labels for finding and filtering meetings in ClerkDirect. Replaces the list. Up to 50 items.
isCancelled
boolean
Marks the meeting cancelled. It stays in ClerkDirect, and on the portal if published, marked cancelled.
ownerUserId
string or null
A meeting manager or administrator.
recurrenceScope
string
For a recurring meeting, which occurrences the change applies to. Defaults to this_occurrence.
this_occurrencethis_and_followingentire_series

Returns

200 with { data }, where data is Meeting.

Example request
curl -X PATCH https://clerkdirect.com/api/v1/meetings/4812 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "location": "Community Center, Room B",
    "isCancelled": false
  }'

MCP tool: meetings_update

Ava: update_meeting

DELETE/api/v1/meetings/{meetingId}

Delete a meeting

Deletes the meeting with its agenda and documents. Tasks from it stay, unlinked from the meeting. ClerkDirect keeps deleted records for recovery, as the app does.

Path parameters

meetingIdrequired
integer
Meeting ID.

Query parameters

recurrenceScope
string
For a recurring meeting, which occurrences the change applies to. Defaults to this_occurrence.
this_occurrencethis_and_followingentire_series

Returns

200 with { data }, where data is object.

Example request
curl -X DELETE https://clerkdirect.com/api/v1/meetings/4812 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_delete

Ava: delete_meeting

GET/api/v1/meetings/{meetingId}/sessions

List a meeting's sessions

Path parameters

meetingIdrequired
integer
Meeting ID.

Returns

200 with { data }, where data is array of Session.

Example request
curl https://clerkdirect.com/api/v1/meetings/4812/sessions \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_sessions_list

Ava: get_meeting_detail — Ava reads sessions as part of the meeting.

POST/api/v1/meetings/{meetingId}/sessions

Add a session

Adds an open (public) or closed (private, in-camera) session with its own agenda and minutes.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

type
string
Defaults to closed.
openclosed
title
string
Its name, such as Closed Session. Defaults to one from its type. Up to 255 characters.
legalAuthority
string
For a closed session. Up to 1000 characters.
closedReason
string
For a closed session. Up to 2000 characters.

Returns

201 with { data }, where data is Session.

Example request
curl -X POST https://clerkdirect.com/api/v1/meetings/4812/sessions \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_sessions_create

Ava: API only.

DELETE/api/v1/meetings/{meetingId}/sessions/{sessionId}

Delete a session

Deletes a session with its agenda. A meeting always keeps at least one open session.

Path parameters

meetingIdrequired
integer
Meeting ID.
sessionIdrequired
integer
Session ID.

Returns

200 with { data }, where data is object.

Example request
curl -X DELETE https://clerkdirect.com/api/v1/meetings/4812/sessions/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_sessions_delete

Ava: delete_meeting_session

GET/api/v1/meetings/{meetingId}/attendance

Get attendance

The meeting's board members and voting guests, with roll call where it was taken.

Path parameters

meetingIdrequired
integer
Meeting ID.

Returns

200 with { data }, where data is array of Attendee.

Example request
curl https://clerkdirect.com/api/v1/meetings/4812/attendance \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_attendance_get

Ava: get_meeting_attendees

PUT/api/v1/meetings/{meetingId}/attendance

Record roll call

Marks attendees present or absent. Attendees you don't list are left as they are.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

attendancerequired
array of object
Each attendee to mark, by voter key. Up to 100 items.
attendance[].voterKeyrequired
string
From Get attendance. Up to 255 characters.
attendance[].statusrequired
string
Absent members can't vote.
presentabsent

Returns

200 with { data }, where data is array of Attendee.

Example request
curl -X PUT https://clerkdirect.com/api/v1/meetings/4812/attendance \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "attendance": [
      {
        "voterKey": "member:31",
        "status": "present"
      }
    ]
  }'

MCP tool: meetings_attendance_update

Ava: record_attendance

POST/api/v1/meetings/{meetingId}/guests

Add a guest

Adds someone who isn't on the board, such as staff or a presenter. Voting guests can vote.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

namerequired
string
Their full name. Up to 255 characters.
email
string (email)
Their email address. When a meeting is created with guests, guests with an email get its calendar invitation.
title
string
Their role, such as City Engineer or Applicant. Up to 255 characters.
isVotingMember
boolean
Whether they can vote on motions. Defaults to false.

Returns

201 with { data }, where data is Guest.

Example request
curl -X POST https://clerkdirect.com/api/v1/meetings/4812/guests \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_guests_add

Ava: add_meeting_participants

GET/api/v1/meetings/{meetingId}/guests

List guests

Path parameters

meetingIdrequired
integer
Meeting ID.

Returns

200 with { data }, where data is array of Guest.

Example request
curl https://clerkdirect.com/api/v1/meetings/4812/guests \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_guests_list

Ava: get_meeting_attendees

DELETE/api/v1/meetings/{meetingId}/guests/{guestId}

Remove a guest

Path parameters

meetingIdrequired
integer
Meeting ID.
guestIdrequired
integer
Guest ID.

Returns

200 with { data }, where data is object.

Example request
curl -X DELETE https://clerkdirect.com/api/v1/meetings/4812/guests/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_guests_delete

Ava: API only.

GET/api/v1/meetings/{meetingId}/documents

List a meeting's documents

Every file on the meeting your key's creator can read, newest first.

Path parameters

meetingIdrequired
integer
Meeting ID.

Query parameters

type
string
Only this document type, such as minutes or agenda_packet.
limit
integer
How many results to return (1-200, default 50). 1-200.
cursor
string
The nextCursor from the previous page. Omit it for the first page.

Returns

200 with { data: [...], hasMore, nextCursor }, where data is page of Document.

Example request
curl https://clerkdirect.com/api/v1/meetings/4812/documents \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_documents_list

Ava: get_meeting_detail, search_artifacts

POST/api/v1/meetings/{meetingId}/documents

Upload a document to a meeting

Adds a small file to the meeting's files, as uploading it on the meeting's Files page in the app does; automations that run when a document is added run. The file comes in the request, up to 6 MB; for larger files, start an upload instead. To put it under an agenda item, use Upload a document to an agenda item.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

fileNamerequired
string
The file's name, with its extension: .pdf, .doc, .docx, .png, .jpg, .jpeg, .gif, .mp4, .webm, .mp3, .m4a. The extension decides its Content-Type. A name already on the meeting gets a number added. Up to 255 characters.
contentrequired
string
The file's bytes, base64-encoded (a data: URL works too). At most 6 MB once decoded; start an upload for larger files.
type
string
What the file is. Defaults to recordings for audio and video, as the app's Files page types them, and other for anything else.
agenda_pdfagenda_packetminutes_pdfminutes_packetrecordingsmeeting_recordingother
sessionId
integer
The session the file belongs to, such as a closed session. Without it, the file belongs to the whole meeting. At least 1.

Send the file as multipart/form-data, in a part named file with the other fields as text parts (fileNamedefaults to the file's name), or as JSON with the file base64-encoded in content. Files can be up to 6 MB; for larger ones, see Uploading files.

Returns

201 with { data }, where data is Document.

Example request
curl -X POST https://clerkdirect.com/api/v1/meetings/4812/documents \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -F "file=@Public Comment - Main Street Rezoning.pdf" \
  -F "type=other"

MCP tool: meetings_documents_upload

Ava: API only.

POST/api/v1/meetings/{meetingId}/documents/imports

Add a document to a meeting from a link

Fetches the file at a public link and adds it to the meeting's files, as uploading it on the meeting's Files page in the app does; automations that run when a document is added run. The server fetches it while the request waits, up to 250 MB within about a minute; for larger files, start an upload instead. To put it under an agenda item, use Add a document to an agenda item from a link.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

urlrequired
string (uri)
A public http or https link straight to the file, such as a staff report on the city's website (not a page about it, and not one that needs signing in). At most 250 MB. Up to 2048 characters.
fileName
string
The name to give the file. Defaults to the name the link gives it. It needs one of these extensions: .pdf, .doc, .docx, .png, .jpg, .jpeg, .gif, .mp4, .webm, .mp3, .m4a; one is added from what the file is when it has none. Up to 255 characters.
type
string
What the file is. Defaults to recordings for audio and video, as the app's Files page types them, and other for anything else.
agenda_pdfagenda_packetminutes_pdfminutes_packetrecordingsmeeting_recordingother
sessionId
integer
The session the file belongs to, such as a closed session. Without it, the file belongs to the whole meeting. At least 1.

Returns

201 with { data }, where data is Document.

Example request
curl -X POST https://clerkdirect.com/api/v1/meetings/4812/documents/imports \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.springfield.gov/files/public-comment-main-street.pdf"
  }'

MCP tool: meetings_documents_import

Ava: API only.

POST/api/v1/meetings/{meetingId}/documents/uploads

Start an upload to a meeting

For a file of any size up to 5 GB, such as a recording. Returns uploadUrl: PUT the file's bytes there with the headers given (curl is a ready-made command), within two hours. Then Complete an upload with uploadId adds it to the meeting's files, as uploading it on the meeting's Files page in the app does.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

fileNamerequired
string
The file's name, with its extension: .pdf, .doc, .docx, .png, .jpg, .jpeg, .gif, .mp4, .webm, .mp3, .m4a. The extension decides its Content-Type. A name already on the meeting gets a number added. Up to 255 characters.
fileSizerequired
integer
The file's exact size in bytes, at most 5 GB. Storage refuses a file of any other size. At least 1.
type
string
What the file is. Defaults to recordings for audio and video, as the app's Files page types them, and other for anything else.
agenda_pdfagenda_packetminutes_pdfminutes_packetrecordingsmeeting_recordingother
sessionId
integer
The session the file belongs to, such as a closed session. Without it, the file belongs to the whole meeting. At least 1.

Returns

201 with { data }, where data is DocumentUpload.

Example request
curl -X POST https://clerkdirect.com/api/v1/meetings/4812/documents/uploads \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "Council - March 3.mp4",
    "fileSize": 1873201152
  }'

MCP tool: meetings_documents_uploads_create

Ava: API only.

GET/api/v1/meetings/{meetingId}/minutes

Get minutes

A session's minutes as text, with the minutes recorded against each agenda item. Without sessionId, the meeting's first public session.

Path parameters

meetingIdrequired
integer
Meeting ID.

Query parameters

sessionId
integer
Which session.

Returns

200 with { data }, where data is Minutes.

Example request
curl https://clerkdirect.com/api/v1/meetings/4812/minutes \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_minutes_get

Ava: get_meeting_minutes

GET/api/v1/meetings/{meetingId}/transcript

Get the transcript

Speaker-labeled transcript segments for a session's recording.

Path parameters

meetingIdrequired
integer
Meeting ID.

Query parameters

sessionId
integer
Which session. Defaults to the live broadcast or first session.
speaker
string
Only this speaker's segments.
search
string
Only segments containing this text.
limit
integer
How many results to return (1-200, default 50). 1-200.
cursor
string
The nextCursor from the previous page. Omit it for the first page.

Returns

200 with { data: [...], hasMore, nextCursor }, where data is page of TranscriptSegment.

Example request
curl https://clerkdirect.com/api/v1/meetings/4812/transcript \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_transcript_get

Ava: get_meeting_transcript, get_broadcast_transcript

POST/api/v1/meetings/{meetingId}/transcriptions

Transcribe recordings

Starts transcribing the meeting's recordings, or one recording when you name it. Transcription runs in the background; the transcript appears on the meeting when it finishes.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

documentId
integer
One recording to transcribe. Defaults to all of them.

Returns

202 with { data }, where data is object.

Example request
curl -X POST https://clerkdirect.com/api/v1/meetings/4812/transcriptions \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_transcribe

Ava: transcribe_recordings

GET/api/v1/meetings/{meetingId}/publication

Get publication status

Whether the meeting is on the public portal, and which files it publishes.

Path parameters

meetingIdrequired
integer
Meeting ID.

Returns

200 with { data }, where data is Publication.

Example request
curl https://clerkdirect.com/api/v1/meetings/4812/publication \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meetings_publication_get

Ava: API only.

PUT/api/v1/meetings/{meetingId}/publication

Publish or unpublish a meeting

Publishing puts the meeting and the files you choose on the public portal and turns the portal on. Publishing runs in the background: the response has status updating, and Get publication status reports published or error when it finishes. Files you leave out keep the meeting's saved choice. Private sessions never publish.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

isPublicrequired
boolean
true publishes; false makes the meeting internal.
standardFiles
array of object
The agenda, agenda packet and minutes to publish for each public session. Replaces the saved choice. Up to 100 items.
standardFiles[].rolerequired
string
Which of the session's documents.
agendaagenda_packetminutes
standardFiles[].sessionIdrequired
integer
A public session, from List a meeting's sessions.
standardFiles[].documentId
integer
For agenda_packet, which packet document to publish.
documentIds
array of integer
Other meeting documents to publish. Replaces the saved choice. Up to 500 items.

Returns

200 with { data }, where data is Publication.

Example request
curl -X PUT https://clerkdirect.com/api/v1/meetings/4812/publication \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "isPublic": true,
    "standardFiles": [
      {
        "role": "agenda",
        "sessionId": 88
      },
      {
        "role": "minutes",
        "sessionId": 88
      }
    ]
  }'

MCP tool: meetings_publication_update

Ava: update_meeting_publication — Ava keeps the Publishing panel's saved choice of files unless asked otherwise; the API does the same when you leave the files out.

Agenda items

The items on a meeting's agenda, nested in sections and sub-items.

GET/api/v1/meetings/{meetingId}/agenda

Get a meeting's agenda

Every item in agenda order, with its documents and motions. Without sessionId, the meeting's first open session.

Path parameters

meetingIdrequired
integer
Meeting ID.

Query parameters

sessionId
integer
Which session.

Returns

200 with { data }, where data is Agenda.

Example request
curl https://clerkdirect.com/api/v1/meetings/4812/agenda \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: agenda_get

Ava: get_agenda

POST/api/v1/meetings/{meetingId}/agenda/items

Add an agenda item

Adds one item or section. Set parentId to nest it; it goes last among its siblings unless you set position.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

titlerequired
string
The item's heading as it appears on the agenda. Up to 2048 characters.
description
string or null
Body text. Simple HTML (p, strong, em, ul, ol, li, a) is kept. Up to 100000 characters.
isSection
boolean
A heading that groups the items under it, such as Consent Agenda.
parentId
integer or null
The item or section to nest it under.
position
integer
Its place among its siblings, from 1. At least 1.
sessionId
integer
Which session's agenda. Defaults to the first open session.

Returns

201 with { data }, where data is AgendaItem.

Example request
curl -X POST https://clerkdirect.com/api/v1/meetings/4812/agenda/items \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Approval of the October 21 minutes",
    "parentId": 5012
  }'

MCP tool: agenda_items_create

Ava: add_agenda_item

POST/api/v1/meetings/{meetingId}/agenda/items/batch

Add several agenda items

Adds items in order at the end of the agenda (or under parentId). Nest items under a section with children. Items are added one at a time: if one fails, the ones before it stay and the error says which failed.

Path parameters

meetingIdrequired
integer
Meeting ID.

Body

itemsrequired
array of object
The items to add, in agenda order. Up to 100 items.
items[].titlerequired
string
The item's heading as it appears on the agenda. Up to 2048 characters.
items[].description
string or null
Body text. Simple HTML (p, strong, em, ul, ol, li, a) is kept. Up to 100000 characters.
items[].isSection
boolean
A heading that groups the items under it, such as Consent Agenda.
items[].children
array of object
Items nested under this one. Up to 100 items.
items[].children[].titlerequired
string
The item's heading as it appears on the agenda. Up to 2048 characters.
items[].children[].description
string or null
Body text. Simple HTML (p, strong, em, ul, ol, li, a) is kept. Up to 100000 characters.
items[].children[].isSection
boolean
A heading that groups the items under it, such as Consent Agenda.
parentId
integer or null
Add them all under this item or section.
sessionId
integer
Which session's agenda. Defaults to the first open session.

Returns

201 with { data }, where data is array of AgendaItem.

Example request
curl -X POST https://clerkdirect.com/api/v1/meetings/4812/agenda/items/batch \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      {
        "title": "Call to Order"
      },
      {
        "title": "Consent Agenda",
        "isSection": true,
        "children": [
          {
            "title": "Approval of Minutes"
          },
          {
            "title": "Payment of Bills"
          }
        ]
      }
    ]
  }'

MCP tool: agenda_items_create_batch

Ava: create_agenda_items

GET/api/v1/agenda-items/{itemId}

Get an agenda item

Path parameters

itemIdrequired
integer
Agenda item ID.

Returns

200 with { data }, where data is AgendaItem.

Example request
curl https://clerkdirect.com/api/v1/agenda-items/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: agenda_items_get

Ava: get_agenda

PATCH/api/v1/agenda-items/{itemId}

Update an agenda item

Changes only the fields you send. Move an item by setting parentId and position.

Path parameters

itemIdrequired
integer
Agenda item ID.

Body

title
string
The item's heading as it appears on the agenda. Up to 2048 characters.
description
string or null
Body text. Simple HTML (p, strong, em, ul, ol, li, a) is kept. Up to 100000 characters.
isSection
boolean
A heading that groups the items under it, such as Consent Agenda.
minutes
string or null
Minutes recorded against the item. Up to 100000 characters.
parentId
integer or null
Move it under this item or section; null moves it to the top level.
position
integer
Its place among its siblings, from 1. At least 1.

Returns

200 with { data }, where data is AgendaItem.

Example request
curl -X PATCH https://clerkdirect.com/api/v1/agenda-items/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Approval of the October 21 regular meeting minutes"
  }'

MCP tool: agenda_items_update

Ava: update_agenda_item

DELETE/api/v1/agenda-items/{itemId}

Delete an agenda item

Deletes the item with its motions and tasks. Items nested under it move up a level.

Path parameters

itemIdrequired
integer
Agenda item ID.

Returns

200 with { data }, where data is object.

Example request
curl -X DELETE https://clerkdirect.com/api/v1/agenda-items/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: agenda_items_delete

Ava: delete_agenda_item

GET/api/v1/agenda-items/{itemId}/documents

List an agenda item's documents

Path parameters

itemIdrequired
integer
Agenda item ID.

Returns

200 with { data }, where data is array of Document.

Example request
curl https://clerkdirect.com/api/v1/agenda-items/305/documents \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: agenda_items_documents_list

Ava: get_agenda

POST/api/v1/agenda-items/{itemId}/documents

Upload a document to an agenda item

Adds a small file, such as a staff report, to the meeting and attaches it under the item, as uploading it on the item in the app does: it goes in the agenda packet and the meeting's files, and automations that run when a document is added run. The file comes in the request, up to 6 MB; for larger files, start an upload instead.

Path parameters

itemIdrequired
integer
Agenda item ID.

Body

fileNamerequired
string
The file's name, with its extension: .pdf, .doc, .docx, .xls, .xlsx, .zip, .mp4, .webm, .mp3, .m4a. The extension decides its Content-Type. A name already on the meeting gets a number added. Up to 255 characters.
contentrequired
string
The file's bytes, base64-encoded (a data: URL works too). At most 6 MB once decoded; start an upload for larger files.
type
string
What the file is. Defaults to agenda_packet, as an upload on an agenda item is in the app.
agenda_pdfagenda_packetminutes_pdfminutes_packetrecordingsmeeting_recordingother

Send the file as multipart/form-data, in a part named file with the other fields as text parts (fileNamedefaults to the file's name), or as JSON with the file base64-encoded in content. Files can be up to 6 MB; for larger ones, see Uploading files.

Returns

201 with { data }, where data is Document.

Example request
curl -X POST https://clerkdirect.com/api/v1/agenda-items/305/documents \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -F "file=@Staff Report - Zoning Variance 26-04.pdf"

MCP tool: agenda_items_documents_upload

Ava: attach_document_to_agenda_item — Ava attaches a file uploaded to the chat or a document already in ClerkDirect; the API uploads a new file.

POST/api/v1/agenda-items/{itemId}/documents/imports

Add a document to an agenda item from a link

Fetches the file at a public link, such as a staff report on the city's website, adds it to the meeting and attaches it under the item, as uploading it on the item in the app does: it goes in the agenda packet and the meeting's files, and automations that run when a document is added run. The server fetches it while the request waits, up to 250 MB within about a minute; for larger files, start an upload instead.

Path parameters

itemIdrequired
integer
Agenda item ID.

Body

urlrequired
string (uri)
A public http or https link straight to the file, such as a staff report on the city's website (not a page about it, and not one that needs signing in). At most 250 MB. Up to 2048 characters.
fileName
string
The name to give the file. Defaults to the name the link gives it. It needs one of these extensions: .pdf, .doc, .docx, .xls, .xlsx, .zip, .mp4, .webm, .mp3, .m4a; one is added from what the file is when it has none. Up to 255 characters.
type
string
What the file is. Defaults to agenda_packet, as an upload on an agenda item is in the app.
agenda_pdfagenda_packetminutes_pdfminutes_packetrecordingsmeeting_recordingother

Returns

201 with { data }, where data is Document.

Example request
curl -X POST https://clerkdirect.com/api/v1/agenda-items/305/documents/imports \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.springfield.gov/files/staff-report-zoning-26-04.pdf"
  }'

MCP tool: agenda_items_documents_import

Ava: API only.

POST/api/v1/agenda-items/{itemId}/documents/uploads

Start an upload to an agenda item

For a file of any size up to 5 GB. Returns uploadUrl: PUT the file's bytes there with the headers given (curl is a ready-made command), within two hours. Then Complete an upload with uploadId adds it to the meeting and attaches it under the item, as uploading it on the item in the app does.

Path parameters

itemIdrequired
integer
Agenda item ID.

Body

fileNamerequired
string
The file's name, with its extension: .pdf, .doc, .docx, .xls, .xlsx, .zip, .mp4, .webm, .mp3, .m4a. The extension decides its Content-Type. A name already on the meeting gets a number added. Up to 255 characters.
fileSizerequired
integer
The file's exact size in bytes, at most 5 GB. Storage refuses a file of any other size. At least 1.
type
string
What the file is. Defaults to agenda_packet, as an upload on an agenda item is in the app.
agenda_pdfagenda_packetminutes_pdfminutes_packetrecordingsmeeting_recordingother

Returns

201 with { data }, where data is DocumentUpload.

Example request
curl -X POST https://clerkdirect.com/api/v1/agenda-items/305/documents/uploads \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "Agenda Packet - March 3.pdf",
    "fileSize": 48213977
  }'

MCP tool: agenda_items_documents_uploads_create

Ava: API only.

Motions and votes

Decision items on an agenda item: motions, recommendations and their votes.

GET/api/v1/meetings/{meetingId}/motions

List a meeting's motions

Every motion on the meeting's agenda items, in agenda order.

Path parameters

meetingIdrequired
integer
Meeting ID.

Returns

200 with { data }, where data is array of Motion.

Example request
curl https://clerkdirect.com/api/v1/meetings/4812/motions \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: motions_list

Ava: get_agenda, get_votes

GET/api/v1/agenda-items/{itemId}/motions

List an agenda item's motions

Path parameters

itemIdrequired
integer
Agenda item ID.

Returns

200 with { data }, where data is array of Motion.

Example request
curl https://clerkdirect.com/api/v1/agenda-items/305/motions \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: motions_list_for_item

Ava: get_agenda

POST/api/v1/agenda-items/{itemId}/motions

Add a motion

Adds a motion or other decision item to an agenda item, after any already there.

Path parameters

itemIdrequired
integer
Agenda item ID.

Body

kind
string
Decision item type key, such as motion or recommendation. Defaults to your organization's default.
titlerequired
string
The motion's text. Up to 2048 characters.
description
string or null
Background or the full text, when title is a short summary. Up to 20000 characters.
mover
string or null
Who moved it, as the minutes name them, such as Councillor Lee. Up to 255 characters.
seconder
string or null
Who seconded it, as the minutes name them. Up to 255 characters.
recordedOutcome
string or null
Record the outcome by hand. Recording votes sets it from the tally.
passedfailed
isTabled
boolean
Tabled (postponed) rather than decided.
isWithdrawn
boolean
Withdrawn by its mover before a decision.
officialRecord
object or null
Give the motion an official record number, such as Resolution 2026-14. null removes it.
officialRecord.typerequired
string
A record kind key from your record numbering settings, such as resolution.
officialRecord.numberModerequired
string
next takes the next number in sequence; manual uses number.
nextmanual
officialRecord.number
string
With numberMode manual. Up to 64 characters.

Returns

201 with { data }, where data is Motion.

Example request
curl -X POST https://clerkdirect.com/api/v1/agenda-items/305/motions \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Motion to approve the consent agenda as presented",
    "mover": "Council Member Ortiz",
    "seconder": "Council Member Hale"
  }'

MCP tool: motions_create

Ava: create_motion, create_motions

GET/api/v1/motions/{motionId}

Get a motion

Path parameters

motionIdrequired
integer
Motion ID.

Returns

200 with { data }, where data is Motion.

Example request
curl https://clerkdirect.com/api/v1/motions/9921 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: motions_get

Ava: get_votes

PATCH/api/v1/motions/{motionId}

Update a motion

Changes only the fields you send.

Path parameters

motionIdrequired
integer
Motion ID.

Body

kind
string
Decision item type key, such as motion or recommendation. Defaults to your organization's default.
title
string
The motion's text. Up to 2048 characters.
description
string or null
Background or the full text, when title is a short summary. Up to 20000 characters.
mover
string or null
Who moved it, as the minutes name them, such as Councillor Lee. Up to 255 characters.
seconder
string or null
Who seconded it, as the minutes name them. Up to 255 characters.
recordedOutcome
string or null
Record the outcome by hand. Recording votes sets it from the tally.
passedfailed
isTabled
boolean
Tabled (postponed) rather than decided.
isWithdrawn
boolean
Withdrawn by its mover before a decision.
officialRecord
object or null
Give the motion an official record number, such as Resolution 2026-14. null removes it.
officialRecord.typerequired
string
A record kind key from your record numbering settings, such as resolution.
officialRecord.numberModerequired
string
next takes the next number in sequence; manual uses number.
nextmanual
officialRecord.number
string
With numberMode manual. Up to 64 characters.

Returns

200 with { data }, where data is Motion.

Example request
curl -X PATCH https://clerkdirect.com/api/v1/motions/9921 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "isTabled": true
  }'

MCP tool: motions_update

Ava: update_motion, update_motions

DELETE/api/v1/motions/{motionId}

Delete a motion

Deletes the motion and its votes. A motion can't be deleted while voting on it is open.

Path parameters

motionIdrequired
integer
Motion ID.

Returns

200 with { data }, where data is object.

Example request
curl -X DELETE https://clerkdirect.com/api/v1/motions/9921 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: motions_delete

Ava: delete_motion

GET/api/v1/motions/{motionId}/votes

Get votes

Each eligible voter and how they voted. value is null for voters who haven't voted.

Path parameters

motionIdrequired
integer
Motion ID.

Returns

200 with { data }, where data is array of Vote.

Example request
curl https://clerkdirect.com/api/v1/motions/9921/votes \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: motions_votes_list

Ava: get_votes

PUT/api/v1/motions/{motionId}/votes

Record votes

Sets how each listed voter voted; voters you leave out keep their vote. The motion's outcome is recalculated from the tally. Voter keys come from Get votes or Get attendance.

Path parameters

motionIdrequired
integer
Motion ID.

Body

votesrequired
array of object
Each voter's vote. Up to 100 items.
votes[].voterKeyrequired
string
From Get votes or Get attendance. Up to 255 characters.
votes[].valuerequired
string or null
null clears the vote.
yesnoabstain

Returns

200 with { data }, where data is array of Vote.

Example request
curl -X PUT https://clerkdirect.com/api/v1/motions/9921/votes \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "votes": [
      {
        "voterKey": "user_2abc",
        "value": "yes"
      },
      {
        "voterKey": "member:31",
        "value": "no"
      }
    ]
  }'

MCP tool: motions_votes_record

Ava: record_votes

GET/api/v1/decision-item-types

List decision item types

The kinds of decision item your organization records, such as Motion, Recommendation and Direction, and whether each takes a vote.

Returns

200 with { data }, where data is array of DecisionItemType.

Example request
curl https://clerkdirect.com/api/v1/decision-item-types \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: motions_kinds_list

Ava: get_org_settings

Documents

Files attached to meetings and agenda items: agendas, packets, staff reports, minutes and recordings.

GET/api/v1/documents/{documentId}

Get a document

Path parameters

documentIdrequired
integer
Document ID.

Returns

200 with { data }, where data is Document.

Example request
curl https://clerkdirect.com/api/v1/documents/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: documents_get

Ava: search_artifacts, get_meeting_detail

GET/api/v1/documents/{documentId}/content

Download a document

The file itself, with its Content-Type and a Content-Disposition naming it. Range requests are supported.

Path parameters

documentIdrequired
integer
Document ID.

Query parameters

inline
boolean
Ask for Content-Disposition: inline.

Returns

The file's bytes.

Example request
curl https://clerkdirect.com/api/v1/documents/305/content \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -o document.pdf

MCP tool: documents_download

Ava: read_document_source — Ava reads a document's text rather than downloading the file.

PATCH/api/v1/documents/{documentId}

Rename or retype a document

Changes its file name (keep the extension) or type. To put a document on the public portal, publish its meeting.

Path parameters

documentIdrequired
integer
Document ID.

Body

fileName
string
The new file name, keeping its extension. Up to 255 characters.
type
string
What the document is, which decides where it's listed and published.
agendaagenda_pdfagenda_packetminutesminutes_pdfminutes_packetrecordingsmeeting_recordingtranscriptsother

Returns

200 with { data }, where data is Document.

Example request
curl -X PATCH https://clerkdirect.com/api/v1/documents/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "fileName": "Staff Report - Zoning Variance 26-04.pdf"
  }'

MCP tool: documents_update

Ava: API only.

DELETE/api/v1/documents/{documentId}

Delete a document

ClerkDirect keeps deleted documents for recovery, as the app does.

Path parameters

documentIdrequired
integer
Document ID.

Returns

200 with { data }, where data is object.

Example request
curl -X DELETE https://clerkdirect.com/api/v1/documents/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: documents_delete

Ava: delete_document_artifact

POST/api/v1/documents/uploads/complete

Complete an upload

After the file's bytes are PUT to an upload's uploadUrl: adds the document to the meeting and, for an upload started on an agenda item, attaches it under the item. Automations that run when a document is added run. Completing the same upload again returns the same document with status 200, so retry it if it fails.

Body

uploadIdrequired
string
The uploadId from Start an upload. Up to 4096 characters.

Returns

201 with { data }, where data is Document.

Example request
curl -X POST https://clerkdirect.com/api/v1/documents/uploads/complete \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "uploadId": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  }'

MCP tool: documents_uploads_complete

Ava: API only.

POST/api/v1/documents/{documentId}/review-requests

Request a review

Asks members to review and approve the document. Reviewers are emailed a link. sequential asks them one after another in the order given.

Path parameters

documentIdrequired
integer
Document ID.

Body

reviewersrequired
array of string
Members' user IDs or email addresses. Up to 50 items.
message
string
A note included in the email to reviewers. Up to 2000 characters.
mode
string
parallel asks every reviewer at once; sequential asks them one at a time, in the order given.
parallelsequential

Returns

201 with { data }, where data is object.

Example request
curl -X POST https://clerkdirect.com/api/v1/documents/305/review-requests \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "reviewers": [
      "[email protected]"
    ],
    "message": "Please review before Tuesday."
  }'

MCP tool: documents_reviews_request

Ava: request_review

POST/api/v1/documents/review-reminders

Remind reviewers

Emails everyone with a document review waiting on them your message. Limit it to meetings of some types with meetingTypeIds.

Body

messagerequired
string
The reminder emailed to each reviewer. Up to 2000 characters.
meetingTypeIds
array of string
Only reviews of documents on meetings of these types (from List meeting types). Up to 24 items.

Returns

200 with { data }, where data is object.

Example request
curl -X POST https://clerkdirect.com/api/v1/documents/review-reminders \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: documents_reviews_remind

Ava: remind_reviewers

GET/api/v1/reviews

List my reviews

Review rounds you review, requested or own (managers see every round they can read), most recently changed first. stage needs_my_review lists what's waiting on you.

Query parameters

stage
string
Only rounds at this stage for you.
needs_my_reviewwaiting_for_reviewerswaiting_for_authorapproved
limit
integer
How many results to return (1-200, default 50). 1-200.
cursor
string
The nextCursor from the previous page. Omit it for the first page.

Returns

200 with { data: [...], hasMore, nextCursor }, where data is page of object.

Example request
curl https://clerkdirect.com/api/v1/reviews \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: reviews_list

Ava: Members see their reviews on the Reviews page.

GET/api/v1/documents/{documentId}/review

Get a document's review

Its current review round: who reviews it, each decision, who it's waiting on, and the discussion.

Path parameters

documentIdrequired
integer
Document ID.

Returns

200 with { data }, where data is object.

Example request
curl https://clerkdirect.com/api/v1/documents/305/review \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: documents_reviews_get

Ava: Members review documents in the app's review view.

POST/api/v1/documents/{documentId}/review/response

Approve or request changes

Records your decision on a document you're reviewing, as the review view does. The requester is notified. In a sequential review it must be your turn. pending withdraws an approval.

Path parameters

documentIdrequired
integer
Document ID.

Body

decisionrequired
string
approved, changes_requested, or pending to withdraw your decision.
pendingapprovedchanges_requested
comment
string
Why, shown with your decision, such as what needs to change. Up to 10000 characters.

Returns

200 with { data }, where data is object.

Example request
curl -X POST https://clerkdirect.com/api/v1/documents/305/review/response \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "decision": "approved",
    "comment": "Looks good."
  }'

MCP tool: documents_reviews_respond

Ava: Members respond in the app's review view.

POST/api/v1/documents/{documentId}/review/comments

Comment on a review

Adds a comment to the document's review discussion, as the review view does. Mentioned members are notified.

Path parameters

documentIdrequired
integer
Document ID.

Body

bodyrequired
string
The comment text. Up to 10000 characters.
mentionedUserIds
array of string
Members to notify, by user ID (from List members). Up to 50 items.

Returns

201 with { data }, where data is object.

Example request
curl -X POST https://clerkdirect.com/api/v1/documents/305/review/comments \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "Section 4 should cite the 2025 bylaw."
  }'

MCP tool: documents_reviews_comment

Ava: Members comment in the app's review view.

Tasks

Action items and resolutions that come out of meetings, with comments.

GET/api/v1/tasks

List tasks

Tasks your key's creator can read, from the most recent meetings first.

Query parameters

status
string
open (the default) is unstarted or in progress.
openunstartedin_progressdonecanceledall
meetingId
integer
Tasks from, or linked to, this meeting.
boardId
integer
Tasks from this board's meetings.
assigneeUserId
string
Tasks assigned to this member.
limit
integer
How many results to return (1-200, default 50). 1-200.
cursor
string
The nextCursor from the previous page. Omit it for the first page.

Returns

200 with { data: [...], hasMore, nextCursor }, where data is page of Task.

Example request
curl https://clerkdirect.com/api/v1/tasks \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: tasks_list

Ava: get_action_items, get_resolutions

GET/api/v1/tasks/{taskId}

Get a task

Path parameters

taskIdrequired
integer
Task ID.

Returns

200 with { data }, where data is Task.

Example request
curl https://clerkdirect.com/api/v1/tasks/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: tasks_get

Ava: get_action_items

POST/api/v1/tasks

Create a task

Creates a task. Set agendaItemId to create it from an agenda item, as the meeting page does; otherwise it's a workspace task. The assignee is notified.

Body

titlerequired
string
What needs doing, such as Post the adopted budget online. Up to 512 characters.
description
string or null
Details and instructions. Up to 20000 characters.
status
string
Defaults to unstarted. done records who completed it and when.
unstartedin_progressdonecanceled
priority
string or null
null for none.
lowmediumhigh
assigneeUserId
string or null
A member's user ID (from List members).
dueDate
string (date) or null
When it's due (YYYY-MM-DD).
agendaItemId
integer
The agenda item it comes out of.

Returns

201 with { data }, where data is Task.

Example request
curl -X POST https://clerkdirect.com/api/v1/tasks \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Post the adopted budget to the website",
    "assigneeUserId": "user_2abc",
    "dueDate": "2026-12-01",
    "priority": "high"
  }'

MCP tool: tasks_create

Ava: create_task, create_tasks

PATCH/api/v1/tasks/{taskId}

Update a task

Changes only the fields you send. Marking a task done records who completed it and when.

Path parameters

taskIdrequired
integer
Task ID.

Body

title
string
What needs doing, such as Post the adopted budget online. Up to 512 characters.
description
string or null
Details and instructions. Up to 20000 characters.
status
string
Defaults to unstarted. done records who completed it and when.
unstartedin_progressdonecanceled
priority
string or null
null for none.
lowmediumhigh
assigneeUserId
string or null
A member's user ID (from List members).
dueDate
string (date) or null
When it's due (YYYY-MM-DD).
cancellationReason
string
With status canceled. Up to 255 characters.

Returns

200 with { data }, where data is Task.

Example request
curl -X PATCH https://clerkdirect.com/api/v1/tasks/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "done"
  }'

MCP tool: tasks_update

Ava: update_action_item

DELETE/api/v1/tasks/{taskId}

Delete a task

Path parameters

taskIdrequired
integer
Task ID.

Returns

200 with { data }, where data is object.

Example request
curl -X DELETE https://clerkdirect.com/api/v1/tasks/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: tasks_delete

Ava: delete_action_item

GET/api/v1/tasks/{taskId}/comments

List a task's comments

Oldest first.

Path parameters

taskIdrequired
integer
Task ID.

Returns

200 with { data }, where data is array of TaskComment.

Example request
curl https://clerkdirect.com/api/v1/tasks/305/comments \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: tasks_comments_list

Ava: get_task_comments

POST/api/v1/tasks/{taskId}/comments

Comment on a task

Adds a comment as your key's creator. Mentioned members are notified.

Path parameters

taskIdrequired
integer
Task ID.

Body

bodyrequired
string
The comment text. Up to 10000 characters.
mentionedUserIds
array of string
Members to notify, by user ID (from List members). Up to 50 items.

Returns

201 with { data }, where data is TaskComment.

Example request
curl -X POST https://clerkdirect.com/api/v1/tasks/305/comments \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "Posted to the website on Nov 20."
  }'

MCP tool: tasks_comments_create

Ava: comment_on_task

POST/api/v1/tasks/reminders

Remind assignees

Emails the assignees of the listed open tasks your message. Each task's assignee is reminded at most once a day with the same message.

Body

taskIdsrequired
array of integer
The tasks whose assignees to remind. Up to 200 items.
messagerequired
string
The reminder emailed to each assignee. Up to 2000 characters.

Returns

200 with { data }, where data is object.

Example request
curl -X POST https://clerkdirect.com/api/v1/tasks/reminders \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: tasks_reminders_send

Ava: remind_open_tasks

Automations

Rules that run steps when something happens or on a schedule.

GET/api/v1/automations

List automations

Query parameters

status
string
Only active automations run on their own.
draftactivepaused
limit
integer
How many results to return (1-200, default 50). 1-200.
cursor
string
The nextCursor from the previous page. Omit it for the first page.

Returns

200 with { data: [...], hasMore, nextCursor }, where data is page of Automation.

Example request
curl https://clerkdirect.com/api/v1/automations \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: automations_list

Ava: get_automations

GET/api/v1/automations/{automationId}

Get an automation

Path parameters

automationIdrequired
string
Automation ID.

Returns

200 with { data }, where data is Automation.

Example request
curl https://clerkdirect.com/api/v1/automations/b6f1c2e0-8d4a-4f7e-9a51-2c3d4e5f6a7b \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: automations_get

Ava: get_automations

POST/api/v1/automations

Create an automation

Body

namerequired
string
Such as Draft minutes after council meetings. Up to 255 characters.
description
string or null
What it's for, shown in the automation list. Up to 2000 characters.
status
string
Only active automations run on their own.
draftactivepaused
ownerUserId
string
Defaults to your key's creator. Steps run as the owner.
triggerrequired
object
When it runs. type is one of meeting_ended, meeting_upcoming, schedule, document_generated, document_added or document_approved; the other fields depend on it (see Automation triggers).
trigger.typerequired
string
What starts a run.
meeting_endedmeeting_upcomingscheduledocument_generateddocument_addeddocument_approved
stepsrequired
array of object
What it does, in order. A step that fails ends the run. Up to 20 items.
steps[].idrequired
string
Unique within the automation. Up to 64 characters.
steps[].name
string or null
A label for the step in run history. Up to 255 characters.
steps[].actionrequired
object
What the step does. type is one of transcribe_recordings, generate_document, ask_ava, create_tasks, remind_open_tasks, remind_reviewers, request_review or export_to_sharepoint (see Automation steps).
steps[].action.typerequired
string
The kind of step. Its other settings go alongside it in action.
transcribe_recordingsgenerate_documentask_avacreate_tasksremind_open_tasksremind_reviewersrequest_reviewexport_to_sharepoint

Returns

201 with { data }, where data is Automation.

Example request
curl -X POST https://clerkdirect.com/api/v1/automations \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Draft minutes after council meetings",
    "status": "active",
    "trigger": {
      "type": "meeting_ended",
      "meetingTypeIds": [
        "council"
      ]
    },
    "steps": [
      {
        "id": "transcribe",
        "action": {
          "type": "transcribe_recordings"
        }
      },
      {
        "id": "minutes",
        "action": {
          "type": "generate_document",
          "prompt": "Draft the minutes.",
          "templateId": null,
          "fileName": null,
          "sessionMinutes": true
        }
      }
    ]
  }'

MCP tool: automations_create

Ava: create_automation

PATCH/api/v1/automations/{automationId}

Update an automation

Changes only the fields you send. trigger and steps replace the automation's whole trigger or step list. Pause or resume by setting status.

Path parameters

automationIdrequired
string
Automation ID.

Body

name
string
Such as Draft minutes after council meetings. Up to 255 characters.
description
string or null
What it's for, shown in the automation list. Up to 2000 characters.
status
string
Only active automations run on their own.
draftactivepaused
ownerUserId
string
Defaults to your key's creator. Steps run as the owner.
trigger
object
When it runs. type is one of meeting_ended, meeting_upcoming, schedule, document_generated, document_added or document_approved; the other fields depend on it (see Automation triggers).
trigger.typerequired
string
What starts a run.
meeting_endedmeeting_upcomingscheduledocument_generateddocument_addeddocument_approved
steps
array of object
What it does, in order. A step that fails ends the run. Up to 20 items.
steps[].idrequired
string
Unique within the automation. Up to 64 characters.
steps[].name
string or null
A label for the step in run history. Up to 255 characters.
steps[].actionrequired
object
What the step does. type is one of transcribe_recordings, generate_document, ask_ava, create_tasks, remind_open_tasks, remind_reviewers, request_review or export_to_sharepoint (see Automation steps).
steps[].action.typerequired
string
The kind of step. Its other settings go alongside it in action.
transcribe_recordingsgenerate_documentask_avacreate_tasksremind_open_tasksremind_reviewersrequest_reviewexport_to_sharepoint

Returns

200 with { data }, where data is Automation.

Example request
curl -X PATCH https://clerkdirect.com/api/v1/automations/b6f1c2e0-8d4a-4f7e-9a51-2c3d4e5f6a7b \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "paused"
  }'

MCP tool: automations_update

Ava: update_automation

DELETE/api/v1/automations/{automationId}

Delete an automation

ClerkDirect's default minutes automation can't be deleted; pause it instead.

Path parameters

automationIdrequired
string
Automation ID.

Returns

200 with { data }, where data is object.

Example request
curl -X DELETE https://clerkdirect.com/api/v1/automations/b6f1c2e0-8d4a-4f7e-9a51-2c3d4e5f6a7b \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: automations_delete

Ava: delete_automation

POST/api/v1/automations/{automationId}/runs

Run an automation now

Starts a run right away, even if the automation is paused. Meeting-based automations need meetingId; document-based ones need documentId.

Path parameters

automationIdrequired
string
Automation ID.

Body

meetingId
integer
The meeting to run it for.
documentId
integer
The document to run it for.

Returns

202 with { data }, where data is AutomationRun.

Example request
curl -X POST https://clerkdirect.com/api/v1/automations/b6f1c2e0-8d4a-4f7e-9a51-2c3d4e5f6a7b/runs \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: automations_run

Ava: run_automation

GET/api/v1/automations/{automationId}/runs

List an automation's runs

Most recent first, with each step's outcome.

Path parameters

automationIdrequired
string
Automation ID.

Query parameters

limit
integer
How many results to return (1-200, default 50). 1-200.
cursor
string
The nextCursor from the previous page. Omit it for the first page.

Returns

200 with { data: [...], hasMore, nextCursor }, where data is page of AutomationRun.

Example request
curl https://clerkdirect.com/api/v1/automations/b6f1c2e0-8d4a-4f7e-9a51-2c3d4e5f6a7b/runs \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: automations_runs_list

Ava: get_automation_runs

Boards

Boards, councils and committees, and their members.

GET/api/v1/boards

List boards

Returns

200 with { data }, where data is array of Board.

Example request
curl https://clerkdirect.com/api/v1/boards \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: boards_list

Ava: get_boards

GET/api/v1/boards/{boardId}

Get a board

Path parameters

boardIdrequired
integer
Board ID.

Returns

200 with { data }, where data is Board.

Example request
curl https://clerkdirect.com/api/v1/boards/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: boards_get

Ava: get_boards

POST/api/v1/boards

Create a board

Body

namerequired
string
Such as City Council or Planning Commission. Up to 255 characters.
members
array of object
Its members: by userId for someone with an account, otherwise by name. Up to 200 items.
members[].userId
string or null
The member's user ID, when they have a ClerkDirect account.
members[].name
string or null
Their name, for someone without an account. Up to 255 characters.
members[].title
string or null
Such as Mayor or Ward 2 Council Member. Up to 255 characters.
members[].startDate
string (date) or null
Term start.
members[].endDate
string (date) or null
Term end.

Returns

201 with { data }, where data is Board.

Example request
curl -X POST https://clerkdirect.com/api/v1/boards \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Planning Commission",
    "members": [
      {
        "name": "Dana Whitfield",
        "title": "Chair",
        "startDate": "2026-01-01"
      }
    ]
  }'

MCP tool: boards_create

Ava: create_board

PATCH/api/v1/boards/{boardId}

Rename a board

Renames the board. Its members keep their IDs.

Path parameters

boardIdrequired
integer
Board ID.

Body

namerequired
string
The new name. Up to 255 characters.

Returns

200 with { data }, where data is Board.

Example request
curl -X PATCH https://clerkdirect.com/api/v1/boards/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: boards_update

Ava: update_board

DELETE/api/v1/boards/{boardId}

Delete a board

Deletes the board and its roster. Its meetings stay, with no board.

Path parameters

boardIdrequired
integer
Board ID.

Returns

200 with { data }, where data is object.

Example request
curl -X DELETE https://clerkdirect.com/api/v1/boards/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: boards_delete

Ava: delete_board

POST/api/v1/boards/{boardId}/members

Add a board member

Set userId for a member with an account, or name for someone without one.

Path parameters

boardIdrequired
integer
Board ID.

Body

userId
string or null
The member's user ID, when they have a ClerkDirect account.
name
string or null
Their name, for someone without an account. Up to 255 characters.
title
string or null
Such as Mayor or Ward 2 Council Member. Up to 255 characters.
startDate
string (date) or null
Term start.
endDate
string (date) or null
Term end.

Returns

201 with { data }, where data is BoardMember.

Example request
curl -X POST https://clerkdirect.com/api/v1/boards/305/members \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "userId": "user_2abc",
    "title": "Ward 3 Council Member",
    "startDate": "2026-01-06"
  }'

MCP tool: boards_members_add

Ava: add_board_member

PATCH/api/v1/boards/{boardId}/members/{memberId}

Update a board member

Change a member's title, term dates, or (for someone without an account) name.

Path parameters

boardIdrequired
integer
Board ID.
memberIdrequired
integer
Board member ID.

Body

name
string or null
Their name, for someone without an account. Up to 255 characters.
title
string or null
Such as Mayor or Ward 2 Council Member. Up to 255 characters.
startDate
string (date) or null
Term start.
endDate
string (date) or null
Term end.

Returns

200 with { data }, where data is BoardMember.

Example request
curl -X PATCH https://clerkdirect.com/api/v1/boards/305/members/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "endDate": "2026-12-31"
  }'

MCP tool: boards_members_update

Ava: update_board_member

DELETE/api/v1/boards/{boardId}/members/{memberId}

Remove a board member

Path parameters

boardIdrequired
integer
Board ID.
memberIdrequired
integer
Board member ID.

Returns

200 with { data }, where data is object.

Example request
curl -X DELETE https://clerkdirect.com/api/v1/boards/305/members/305 \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: boards_members_remove

Ava: delete_board_member

Meeting types

The kinds of meeting your organization holds and their defaults.

GET/api/v1/meeting-types

List meeting types

Query parameters

includeArchived
boolean
Include archived types.

Returns

200 with { data }, where data is array of MeetingType.

Example request
curl https://clerkdirect.com/api/v1/meeting-types \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: meeting_types_list

Ava: get_org_settings

POST/api/v1/meeting-types

Create a meeting type

Body

namerequired
string
Such as Regular Council or Planning Commission. Up to 80 characters.
decisionKindIds
array of string
The decision item types its meetings can use (from List decision item types).
defaultDecisionKindId
string
One of decisionKindIds.
agendaTemplateId
string or null
Agenda template new meetings of this type start from.
showDecisionItemsOnAgenda
boolean
Whether motions appear in agenda documents and the public agenda page.

Returns

201 with { data }, where data is MeetingType.

Example request
curl -X POST https://clerkdirect.com/api/v1/meeting-types \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Special Meeting",
    "decisionKindIds": [
      "motion"
    ]
  }'

MCP tool: meeting_types_create

Ava: create_meeting_type

PATCH/api/v1/meeting-types/{meetingTypeId}

Update a meeting type

Changes only the fields you send. Archive a type with isArchived; its meetings keep it.

Path parameters

meetingTypeIdrequired
string
Meeting type ID.

Body

name
string
Such as Regular Council or Planning Commission. Up to 80 characters.
decisionKindIds
array of string
The decision item types its meetings can use (from List decision item types).
defaultDecisionKindId
string
One of decisionKindIds.
agendaTemplateId
string or null
Agenda template new meetings of this type start from.
showDecisionItemsOnAgenda
boolean
Whether motions appear in agenda documents and the public agenda page.
isArchived
boolean
true hides it from new meetings; false restores it. Its meetings keep the type.

Returns

200 with { data }, where data is MeetingType.

Example request
curl -X PATCH https://clerkdirect.com/api/v1/meeting-types/council \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "isArchived": true
  }'

MCP tool: meeting_types_update

Ava: update_meeting_type, archive_meeting_type, restore_meeting_type

Templates

Agenda and document templates.

GET/api/v1/templates

List document templates

Your organization's minutes and document templates.

Returns

200 with { data }, where data is array of Template.

Example request
curl https://clerkdirect.com/api/v1/templates \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: templates_list

Ava: get_document_templates, get_template_workspace

GET/api/v1/agenda-templates

List agenda templates

Saved agenda outlines new meetings can start from.

Returns

200 with { data }, where data is array of AgendaTemplate.

Example request
curl https://clerkdirect.com/api/v1/agenda-templates \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: templates_agenda_list

Ava: get_agenda_templates

Public portal

Settings for the public portal residents use to follow meetings.

GET/api/v1/portal

Get portal settings

null when the organization hasn't set up its public portal.

Returns

200 with { data }, where data is PortalSettings.

Example request
curl https://clerkdirect.com/api/v1/portal \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY"

MCP tool: portal_settings_get

Ava: get_portal_settings

PATCH/api/v1/portal

Update portal settings

Changes only the fields you send. Turning the portal off takes every meeting off it.

Body

isEnabled
boolean
Whether the public portal is on. Turning it off takes every meeting off it.
pageTitle
string
The heading at the top of the portal. Up to 255 characters.
pageDescription
string or null
Introductory text under the heading. Up to 2000 characters.
headerBgColor
string
Header background, as a hex color such as #1F4E79.
headerTextColor
string
Header text, as a hex color.
accentColor
string
Links and buttons, as a hex color.
navLinks
array of object
Links in the portal's header, such as your website. Replaces the list. Up to 20 items.
navLinks[].labelrequired
string
The link's text. Up to 80 characters.
navLinks[].urlrequired
string (uri)
Where it goes.
socialLinks
array of object
Social media profiles shown on the portal. Replaces the list. Up to 20 items.
socialLinks[].platformrequired
string
Which network, for its icon.
facebookinstagramxyoutubelinkedinnextdoortiktokthreads
socialLinks[].urlrequired
string (uri)
The profile's address.
displayConfig
object
Display options: resultsPerPage (6, 10, 12 or 20), defaultSort (newest or oldest), documentOpenMode (newTab or download), allowSubscriptions, and show* flags for each part of the portal.

Returns

200 with { data }, where data is PortalSettings.

Example request
curl -X PATCH https://clerkdirect.com/api/v1/portal \
  -H "Authorization: Bearer $CLERKDIRECT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "pageTitle": "Springfield Public Meetings",
    "accentColor": "#1F4E79"
  }'

MCP tool: portal_settings_update

Ava: update_portal_settings

Objects

What the API returns. Fields marked required are always present.

Meeting

A meeting.

Fields

idrequired
integer
Meeting ID.
titlerequired
string
Meeting title.
descriptionrequired
string or null
Description.
startsAtrequired
string (date-time)
Start, in UTC. Date-only meetings start at midnight in timeZone.
timeZonerequired
string or null
IANA time zone the meeting is held in, such as America/Chicago.
durationMinutesrequired
integer
locationrequired
string or null
Where it's held.
boardIdrequired
integer or null
The board or committee holding it.
meetingTypeIdrequired
string or null
Its meeting type.
tagsrequired
array of string
isPublicrequired
boolean
Whether it's published to the public portal. Change it with the publication endpoint.
isCancelledrequired
boolean
ownerUserIdrequired
string or null
The member who owns it, when known.
recurrenceSeriesIdrequired
integer or null
Set when the meeting is one occurrence of a recurring series.
createdAtrequired
string (date-time)
When it was created.
updatedAtrequired
string (date-time)
When it last changed.

MeetingDetail

A meeting with its sessions and documents.

Fields

idrequired
integer
Meeting ID.
titlerequired
string
Meeting title.
descriptionrequired
string or null
Description.
startsAtrequired
string (date-time)
Start, in UTC. Date-only meetings start at midnight in timeZone.
timeZonerequired
string or null
IANA time zone the meeting is held in, such as America/Chicago.
durationMinutesrequired
integer
locationrequired
string or null
Where it's held.
boardIdrequired
integer or null
The board or committee holding it.
meetingTypeIdrequired
string or null
Its meeting type.
tagsrequired
array of string
isPublicrequired
boolean
Whether it's published to the public portal. Change it with the publication endpoint.
isCancelledrequired
boolean
ownerUserIdrequired
string or null
The member who owns it, when known.
recurrenceSeriesIdrequired
integer or null
Set when the meeting is one occurrence of a recurring series.
createdAtrequired
string (date-time)
When it was created.
updatedAtrequired
string (date-time)
When it last changed.
agendaItemCountrequired
integer
sessionsrequired
array of Session
documentsrequired
array of Document

Session

A part of a meeting with its own agenda and minutes. Every meeting has an open session; closed (in-camera) sessions are private.

Fields

idrequired
integer
Session ID.
titlerequired
string
Session title.
typerequired
string
openclosed
visibilityrequired
string
publicprivate
positionrequired
integer
Order within the meeting, from 1.
legalAuthorityrequired
string or null
For a closed session, the authority it was closed under.
closedReasonrequired
string or null
For a closed session, the reason it was closed.
hasTranscriptrequired
boolean
minutesDocumentIdrequired
integer or null
The document holding this session's minutes, if there is one.
canReadrequired
boolean
False when the session is restricted to members your key's creator isn't one of.

Attendee

Someone expected at a meeting: a board member or a guest.

Fields

voterKeyrequired
string
Identifies them in roll call and votes.
namerequired
string or null
Their name.
titlerequired
string or null
Their title, such as Mayor.
userIdrequired
string or null
Their user ID, when they have an account.
boardMemberIdrequired
integer or null
isGuestrequired
boolean
isVotingMemberrequired
boolean
attendancerequired
string or null
From roll call; null when it wasn't taken.
presentabsent

Guest

A meeting guest who isn't on the board.

Fields

idrequired
integer
Guest ID.
namerequired
string
Name.
emailrequired
string or null
Email.
titlerequired
string or null
Title.
isVotingMemberrequired
boolean

Minutes

A session's minutes.

Fields

meetingIdrequired
integer
Meeting ID.
sessionIdrequired
integer or null
documentIdrequired
integer or null
The minutes document.
fileNamerequired
string or null
The minutes document's name.
textrequired
string or null
The minutes as plain text. null for an uploaded file ClerkDirect can't read.
agendaItemsrequired
array of object
Minutes recorded against each agenda item.
agendaItems[].titlerequired
string
agendaItems[].minutesrequired
string or null
agendaItems[].isSectionrequired
boolean

TranscriptSegment

A stretch of speech by one speaker.

Fields

speakerrequired
string or null
Speaker name or label.
textrequired
string
What they said.
startMsrequired
integer
Offset into the recording, in milliseconds.
endMsrequired
integer

Publication

Whether a meeting is on the public portal.

Fields

statusrequired
string
updating while the portal copy is being built.
unpublishedupdatingpublishederror
isPublicrequired
boolean
publishedAtrequired
string (date-time) or null
errorrequired
string or null
Why the last publish failed.
revisionrequired
integer
standardFilesrequired
array of object
standardFiles[].rolerequired
string
agendaagenda_packetminutes
standardFiles[].sessionIdrequired
integer
standardFiles[].documentIdrequired
integer or null
documentIdsrequired
array of integer

Document

A file attached to a meeting or agenda item.

Fields

idrequired
integer
Document ID.
meetingIdrequired
integer or null
sessionIdrequired
integer or null
typerequired
string
What the file is: agenda, agenda_pdf, agenda_packet, minutes, minutes_pdf, minutes_packet, recordings (an uploaded audio or video file), meeting_recording (a live meeting's recording), transcripts or other.
fileNamerequired
string
File name, with extension.
fileSizerequired
integer
Size in bytes.
contentTyperequired
string or null
MIME type.
isPublicrequired
boolean
Whether the public portal shows it.
versionrequired
integer
agendaItemsrequired
array of object
Agenda items the file is attached to.
agendaItems[].idrequired
integer
agendaItems[].titlerequired
string
createdAtrequired
string (date-time)
When it was added.
updatedAtrequired
string (date-time)
When it last changed.

DocumentUpload

An upload waiting for its file. PUT the file's bytes to uploadUrl with headers, then Complete an upload with uploadId.

Fields

uploadIdrequired
string
Pass this to Complete an upload once the file is stored.
uploadUrlrequired
string
Where to PUT the file's bytes, straight to storage. It's signed for this file's exact size; send the Content-Type in headers, which completing the upload checks.
methodrequired
string
Always PUT.
PUT
headersrequired
object
Headers to send with the PUT, exactly as given. If-None-Match makes storage refuse a second PUT (412), so running the command again can't replace a stored file.
expiresAtrequired
string (date-time)
When uploadUrl stops working. Complete the upload within a day.
curlrequired
string
A ready-to-run curl command that PUTs the file, run from the folder it's in.

Agenda

A session's agenda.

Fields

meetingIdrequired
integer
Meeting ID.
sessionIdrequired
integer or null
itemsrequired
array of AgendaItem
Every item, in agenda order (each parent before its children).

AgendaItem

An agenda item or section.

Fields

idrequired
integer
Agenda item ID.
meetingIdrequired
integer
Its meeting.
sessionIdrequired
integer or null
parentIdrequired
integer or null
The item or section it's nested under.
depthrequired
integer
Nesting depth; top-level items are 0.
positionrequired
integer
Order among its siblings, from 1.
titlerequired
string
Title.
descriptionrequired
string or null
Body text.
minutesrequired
string or null
Minutes recorded against the item.
isSectionrequired
boolean
A heading that groups the items under it.
restrictedrequired
boolean
True when the item is limited to selected members and your key's creator isn't one of them. Its title is then the public title and its contents are left out.
documentsrequired
array of object
documents[].idrequired
integer
documents[].fileNamerequired
string
motionsrequired
array of Motion

Motion

A decision item on an agenda item: a motion, recommendation, resolution or another kind your organization defines.

Fields

idrequired
integer
Motion ID.
agendaItemIdrequired
integer
The agenda item it belongs to.
kindrequired
string
Decision item type key, such as motion.
kindLabelrequired
string
Decision item type name, such as Motion.
votingModerequired
string
requiredoptionalnone
titlerequired
string
The motion's text.
descriptionrequired
string or null
Further detail.
moverrequired
string or null
Who moved it.
seconderrequired
string or null
Who seconded it.
statusrequired
string
Where the motion stands.
pendingpassedfailedtabledwithdrawn
recordedOutcomerequired
string or null
The outcome recorded for it, by vote or by hand.
passedfailed
officialRecordrequired
object or null
Its official record number, such as Resolution 2026-14.
officialRecord.typerequired
string
officialRecord.numberrequired
string or null
voteCountsrequired
positionrequired
integer
Order on the agenda item.
createdAtrequired
string (date-time)
When it was created.
updatedAtrequired
string (date-time)
When it last changed.

VoteCounts

Vote tallies.

Fields

yesrequired
integer
norequired
integer
abstainrequired
integer
absentrequired
integer
recordedrequired
integer
eligiblerequired
integer or null

Vote

One voter's vote on a motion.

Fields

voterKeyrequired
string
Who voted: a member's user ID, member:<boardMemberId> for a board member without an account, or guest:<guestId>.
boardMemberIdrequired
integer or null
namerequired
string or null
The voter's name, when known.
valuerequired
string or null
yesnoabstainabsent

Task

An action item, often directed by a motion at a meeting.

Fields

id
integer
number
string or null
Its task number, such as T-2026-031.
title
string
description
string or null
status
string
Defaults to unstarted. done records who completed it and when.
unstartedin_progressdonecanceled
priority
string or null
lowmediumhigh
assigneeUserId
string or null
dueDate
string (date) or null
meetingId
integer or null
The meeting it came from.
agendaItemId
integer or null
The agenda item it came from.
linkedAgendaItemIds
array of integer
linkedMotionIds
array of integer
commentCount
integer or null
completedAt
string (date-time) or null
createdAt
string (date-time)
updatedAt
string (date-time)

TaskComment

Fields

id
integer
authorUserId
string or null
body
string
mentionedUserIds
array of string
createdAt
string (date-time)
updatedAt
string (date-time)

Automation

A rule that runs steps when something happens or on a schedule.

Fields

id
string
name
string
description
string or null
status
string
Only active automations run on their own.
draftactivepaused
isDefault
boolean
ClerkDirect's default minutes automation.
ownerUserId
string or null
trigger
object
When it runs. type is one of meeting_ended, meeting_upcoming, schedule, document_generated, document_added or document_approved; the other fields depend on it (see Automation triggers).
trigger.type
string
What starts a run.
meeting_endedmeeting_upcomingscheduledocument_generateddocument_addeddocument_approved
steps
array of object
steps[].idrequired
string
Unique within the automation. Up to 64 characters.
steps[].name
string or null
A label for the step in run history. Up to 255 characters.
steps[].actionrequired
object
What the step does. type is one of transcribe_recordings, generate_document, ask_ava, create_tasks, remind_open_tasks, remind_reviewers, request_review or export_to_sharepoint (see Automation steps).
steps[].action.typerequired
string
The kind of step. Its other settings go alongside it in action.
transcribe_recordingsgenerate_documentask_avacreate_tasksremind_open_tasksremind_reviewersrequest_reviewexport_to_sharepoint
nextRuns
array of string (date-time)
For scheduled automations, the next times it runs.
createdAt
string (date-time)
updatedAt
string (date-time)

AutomationRun

Fields

id
integer
automationId
string
status
string
runningwaitingsucceededfailedskippedcanceled
triggeredBy
string or null
eventschedulemanual
triggerType
string or null
meetingId
integer or null
error
string or null
steps
array of object
steps[].stepId
string
steps[].type
string or null
steps[].status
string or null
steps[].summary
string or null
steps[].error
string or null
steps[].startedAt
string (date-time) or null
steps[].completedAt
string (date-time) or null
startedAt
string (date-time) or null
completedAt
string (date-time) or null

Organization

Fields

id
string
name
string or null
slug
string or null
dataRegion
string
Where its data is stored.
uscaeu

Member

Fields

userId
string
name
string or null
email
string or null
canManageMeetings
boolean
An administrator or meeting manager.

Board

Fields

id
integer
name
string
members
array of BoardMember
meetingCount
integer

BoardMember

Fields

id
integer
boardId
integer
userId
string or null
name
string or null
email
string or null
title
string or null
startDate
string (date) or null
endDate
string (date) or null

MeetingType

Fields

id
string
name
string
isArchived
boolean
decisionKindIds
array of string
defaultDecisionKindId
string or null
agendaTemplateId
string or null
showDecisionItemsOnAgenda
boolean

DecisionItemType

Fields

id
string
label
string
votingMode
string
requiredoptionalnone
isDefault
boolean

Template

Fields

id
string
name
string
description
string or null
category
string or null
kind
string
documentagenda
status
string
ready, or the state of a template still being built.

AgendaTemplate

Fields

id
string
name
string
description
string or null
itemCount
integer
isDefault
boolean
updatedAt
string (date-time) or null

PortalSettings

Fields

id
integer
slug
string or null
url
string or null
isEnabled
boolean
pageTitle
string or null
pageDescription
string or null
logoUrl
string or null
headerBgColor
string or null
headerTextColor
string or null
accentColor
string or null
navLinks
array of object
navLinks[].label
string
navLinks[].url
string
socialLinks
array of object
socialLinks[].platform
string
socialLinks[].url
string
displayConfig
object or null
updatedAt
string (date-time) or null

SearchResults

Fields

meetings
array of object
agendaItems
array of object
documents
array of object
minutes
array of object