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.
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:
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"
}
}
400
invalid_request
A parameter or field is missing or invalid. details.issues lists each one.
401
unauthorized
No key, a revoked key, or a key whose creator has left the organization.
403
forbidden
The 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.
404
not_found
Nothing with that ID in your organization, or no such endpoint.
405
method_not_allowed
The path exists but not with this method. The Allow header lists the methods.
409
conflict
The change conflicts with the current state, such as deleting a motion while voting is open.
413
payload_too_large
Request bodies are limited to 1 MB. A file sent in the request can be up to 6 MB; start an upload for larger files.
429
rate_limited
Too many of one kind of request, such as sign-in links for one member. Wait and retry.
500
internal_error
Something failed on our side. Retry, and contact support with the requestId if it persists.
502
upstream_error
Something 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.
Files go straight to storage, so they can be up to 5 GB. Uploading one takes three requests:
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.
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.
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.
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:
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:
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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/{taskId}/motions
Link motions to a task
Links the motions a task carries out, such as the resolution that directed it.
Path parameters
taskIdrequired
integer
Task ID.
Body
motionIdsrequired
array of integer
Motions to link, from List a meeting's motions. Up to 50 items.
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).
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.
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).
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.
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.
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.
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.
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).
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.