# components.schemas.ErrorResponse.properties.code.description
A machine-readable code identifying the type of failure.

# components.schemas.ErrorResponse.properties.error.description
A human-readable message explaining why the request failed.

# components.schemas.ErrorResponse.properties.issues.description
The field-level validation issues found in an invalid request.

# components.schemas.ErrorResponse.properties.issues.items.properties.message.description
A human-readable explanation of the validation failure.

# components.schemas.ErrorResponse.properties.issues.items.properties.path.description
The location of the request field that failed validation.

# info.description
The Circleback public REST API provides programmatic access to your meetings, notes, action items, transcripts, and more. Authenticate every request by sending your API key as a bearer token.

# paths./action-item/{actionItemId}.delete.description
Deletes an action item. Returns the deleted action item.

# paths./action-item/{actionItemId}.delete.parameters[].description
The unique identifier of the action item.

# paths./action-item/{actionItemId}.put.description
Updates the title, description, status, or assignee of an action item. Returns the updated action item.

# paths./action-item/{actionItemId}.put.parameters[].description
The unique identifier of the action item.

# paths./action-item/{actionItemId}.put.requestBody.content.application/json.schema.properties.description.description
The detailed description of the action item.

# paths./action-item/{actionItemId}.put.requestBody.content.application/json.schema.properties.assigneeProfileId.description
The ID of the profile to assign the action item to, or null to remove the assignee.

# paths./action-item/{actionItemId}.put.requestBody.content.application/json.schema.properties.status.description
The completion status of the action item.

# paths./action-item/{actionItemId}.put.responses.200.content.application/json.schema.example.description
Reach out to Sunriver Events and other potential event venues to see if they would be open to hosting the event this summer.

# paths./action-item/{actionItemId}.put.responses.200.content.application/json.schema.properties.id.description
The unique identifier of the action item.

# paths./action-item/{actionItemId}.put.responses.200.content.application/json.schema.properties.description.description
The detailed description of the action item.

# paths./action-item/{actionItemId}.put.responses.200.content.application/json.schema.properties.completedAt.description
The time the action item was marked as done, or null if it is not completed.

# paths./action-item/{actionItemId}.put.responses.200.content.application/json.schema.properties.meetingId.description
The ID of the associated meeting, or null if none exists.

# paths./action-item/{actionItemId}.put.responses.200.content.application/json.schema.properties.status.description
The completion status of the action item.

# paths./action-items.get.description
Returns a page of action items across the authenticated user's meetings, filtered by assignee, status, tags, and attendees.

# paths./action-items.get.parameters[].description
The assignee scope to filter by. Defaults to Me.

# paths./action-items.get.parameters[].description
Profile ID of the assignee to filter by.

# paths./action-items.get.parameters[].description
Completion status to filter by. Defaults to incomplete action items.

# paths./action-items.get.parameters[].description
Profile IDs of meeting attendees to filter by.

# paths./action-items.get.parameters[].description
Cursor for the next page. Omit for the first page (RFC 8288).

# paths./action-items.get.responses.200.content.application/json.schema.example[].description
Reach out to Sunriver Events and other potential event venues to see if they would be open to hosting the event this summer.

# paths./action-items.get.responses.200.content.application/json.schema.example[].description
Review pricing and availability of venues and pick a venue for the event.

# paths./action-items.get.responses.200.content.application/json.schema.items.properties.id.description
The unique identifier of the action item.

# paths./action-items.get.responses.200.content.application/json.schema.items.properties.description.description
The detailed description of the action item.

# paths./action-items.get.responses.200.content.application/json.schema.items.properties.assignee.description
Action item assignee, or null if unassigned.

# paths./action-items.get.responses.200.content.application/json.schema.items.properties.assignee.anyOf[].properties.profileId.description
The unique identifier of the person's profile.

# paths./action-items.get.responses.200.content.application/json.schema.items.properties.assignee.anyOf[].properties.companyName.description
The name of the company the person belongs to.

# paths./action-items.get.responses.200.content.application/json.schema.items.properties.completedAt.description
The time the action item was marked as done, or null if it is not completed.

# paths./action-items.get.responses.200.content.application/json.schema.items.properties.meetingId.description
The ID of the meeting the action item belongs to.

# paths./action-items.get.responses.200.content.application/json.schema.items.properties.status.description
The completion status of the action item.

# paths./calendar/events.get.description
Returns upcoming calendar events from the authenticated user's connected calendars, with pagination and a configurable time window.

# paths./calendar/events.get.parameters[].description
Set to true to include calendar meetings that have no meeting link and only one attendee.

# paths./calendar/events.get.parameters[].description
How many hours in the past to include calendar meetings from, based on their start time.

# paths./calendar/events.get.parameters[].description
How many hours in the future to include calendar meetings from, based on their start time.

# paths./calendar/events.get.parameters[].description
The direction calendar meetings are sorted in by start time. Defaults to ascending.

# paths./calendar/events.get.parameters[].description
Cursor for the next page. Omit for the first page (RFC 8288).

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.id.description
The unique identifier of the calendar meeting.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.icalUid.description
The iCalendar UID of the calendar event.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.attendees.description
The attendees invited to the calendar meeting.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.attendees.items.properties.isOrganizer.description
Whether the attendee organized the calendar meeting.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.attendees.items.properties.status.description
The attendee's response to the calendar meeting invitation.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.calendarPlatform.description
The calendar platform the meeting was synced from.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.endTime.description
When the calendar meeting ends, as an ISO 8601 timestamp.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.isExternal.description
Whether the meeting includes attendees from more than one email domain.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.isHostedByMe.description
Whether the current user organized the calendar meeting.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.meetingId.description
The Circleback meeting associated with the calendar meeting, when one exists.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.meetingPlatform.description
The conferencing platform hosting the meeting, when detected.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.organizerEmail.description
The email address of the meeting organizer.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.overrideShouldRecord.description
Whether the user manually overrode the automatic recording decision, or null when no override is set.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.platform.description
The conferencing platform hosting the meeting, when detected. Alias of meetingPlatform.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.recurringEventId.description
The identifier of the recurring event series the meeting belongs to.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.startTime.description
When the calendar meeting starts, as an ISO 8601 timestamp.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.willRecord.description
Whether the notetaker will join and record the meeting.

# paths./calendar/events.get.responses.200.content.application/json.schema.items.properties.willRecordReason.description
A human-readable explanation of why the meeting will or will not be recorded.

# paths./companies.get.description
Returns the companies whose people attend the authenticated user's meetings, with optional tag filters.

# paths./companies.get.parameters[].description
Cursor for the next page. Omit for the first page (RFC 8288).

# paths./companies.get.parameters[].description
Filter companies to those with meetings that have these tag IDs.

# paths./company/{domain}.get.description
Returns a company by its domain, including its people and external links.

# paths./company/{domain}.get.responses.200.content.application/json.schema.properties.externalLinks.description
Links to the company on external platforms and connected integrations.

# paths./company/{domain}.get.responses.200.content.application/json.schema.properties.externalLinks.items.properties.objectType.description
Whether the link refers to a person or a company.

# paths./company/{domain}.get.responses.200.content.application/json.schema.properties.externalLinks.items.properties.type.description
The platform or integration the link points to.

# paths./company/{domain}.get.responses.200.content.application/json.schema.properties.people.description
People at the company you have met with.

# paths./meeting/{meetingId}.delete.description
Deletes a meeting. Only the owner of the meeting can delete it. Returns the deleted meeting.

# paths./meeting/{meetingId}.get.description
Returns a meeting by its ID, including the notes, attendees, and recording details the caller has permission to view.

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.example.notes
#### Overview
* Several options for event venues were reviewed…

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.example.privateNotes
Ask Samantha about the Sunriver deposit before Friday.

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.example.actionItems[].description
Reach out to Sunriver Events and other potential event venues to see if they would be open to hosting the event this summer.

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.example.actionItems[].description
Review pricing and availability of venues and pick a venue for the event.

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.example.insights.Questions[].insight
When will the webhook integration be ready?

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.properties.id.description
Circleback meeting ID. Can be used to generate a link to the meeting (`https://circleback.ai/meetings/${id}`).

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.properties.createdAt.description
Meeting creation date, formatted as an ISO 8601 timestamp.

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.properties.url.description
URL of the virtual meeting (Zoom, Google Meet, or Microsoft Teams).

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.properties.recordingUrl.description
URL of the meeting recording file. Only valid for 24 hours, and only available if saving meeting recordings is enabled in settings.

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.properties.icalUid.description
Unique identifier of the calendar event associated with the meeting.

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.properties.notes.description
Circleback meeting notes with Markdown formatting.

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.properties.privateNotes.description
The authenticated user's private notes for the meeting.

# paths./meeting/{meetingId}.get.responses.200.content.application/json.schema.properties.linkAccess.description
Who can access the meeting through its shareable link.

# paths./meeting/{meetingId}.put.description
Updates a meeting's name, notes, or private notes. Returns only the fields that were updated.

# paths./meeting/{meetingId}.put.requestBody.content.application/json.schema.example.notes
#### Overview
* Several options for event venues were reviewed…

# paths./meeting/{meetingId}.put.requestBody.content.application/json.schema.example.privateNotes
Ask Samantha about the Sunriver deposit before Friday.

# paths./meeting/{meetingId}.put.requestBody.content.application/json.schema.properties.privateNotes.description
The authenticated user's private notes for the meeting.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.id.description
Circleback meeting ID. Can be used to generate a link to the meeting (`https://circleback.ai/meetings/${id}`).

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.createdAt.description
Meeting creation date, formatted as an ISO 8601 timestamp.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.url.description
URL of the virtual meeting (Zoom, Google Meet, or Microsoft Teams).

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.recordingUrl.description
URL of the meeting recording file. Only valid for 24 hours, and only available if saving meeting recordings is enabled in settings.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.icalUid.description
Unique identifier of the calendar event associated with the meeting.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.attendees.items.properties.profileId.description
The unique identifier of the person's profile.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.attendees.items.properties.name.description
Calendar event invitee name if associated with a calendar event, or the name of the meeting participant.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.attendees.items.properties.companyName.description
The name of the company the person belongs to.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.attendees.items.properties.email.description
Calendar event invitee email if associated with a calendar event.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.attendees.items.properties.isCalendarEventOrganizer.description
Whether the attendee organized the calendar event.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.attendees.items.properties.isCalendarInvitee.description
Whether the attendee was invited on the calendar event.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.notes.description
Circleback meeting notes with Markdown formatting.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.privateNotes.description
The authenticated user's private notes for the meeting.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.actionItems.items.properties.assignee.description
Action item assignee, or null if unassigned.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.actionItems.items.properties.status.description
Action item status, one of 'PENDING' or 'DONE'.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.insights.additionalProperties.items.properties.speaker.description
Speaker the insight is associated with, if any.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.insights.additionalProperties.items.properties.timestamp.description
Timestamp in seconds the insight is associated with, if any.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.insights.additionalProperties.items.properties.insight.description
The insight result. A string, or an object when the insight has custom fields.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.insights.description
Insight results for the meeting, keyed by the name of the user-created insight.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.linkAccess.description
Who can access the meeting through its shareable link.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.calendarEvent.anyOf[].properties.id.description
The unique identifier of the calendar event.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.calendarEvent.anyOf[].properties.icalUid.description
The iCalendar unique identifier of the event.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.calendarEvent.anyOf[].properties.platform.description
The calendar platform the event comes from.

# paths./meeting/{meetingId}.put.responses.200.content.application/json.schema.properties.calendarEvent.anyOf[].properties.platformId.description
The unique identifier of the event on the calendar platform.

# paths./meeting/{meetingId}/transcript.get.description
Returns the full transcript for a meeting.

# paths./meeting/{meetingId}/transcript.get.responses.200.content.application/json.schema.description
The segments of the transcript, in chronological order.

# paths./meeting/{meetingId}/transcript.get.responses.200.content.application/json.schema.example[].text
Going well, just testing the Circleback API.

# paths./meeting/{meetingId}/transcript.get.responses.200.content.application/json.schema.items.properties.timestamp.description
Timestamp in seconds that marks the beginning of the segment.

# paths./meetings.get.description
Returns a page of meetings for the authenticated user, optionally filtered by attendees, tags, ownership, and status.

# paths./meetings.get.parameters[].description
Whether to return only meetings the user owns or all meetings the user can access.

# paths./meetings.get.parameters[].description
Cursor for the next page. Omit for the first page (RFC 8288).

# paths./people.get.description
Returns the people who attend the authenticated user's meetings, ordered by most recent meeting, with optional company and tag filters.

# paths./people.get.parameters[].description
Filter people to those associated with any of these company domains.

# paths./people.get.parameters[].description
Cursor for the next page. Omit for the first page (RFC 8288).

# paths./people.get.parameters[].description
Filter people to attendees of meetings with these tag IDs.

# paths./people.get.responses.200.content.application/json.schema.items.properties.companyId.description
The unique identifier of the company the person belongs to.

# paths./people.get.responses.200.content.application/json.schema.items.properties.companyName.description
The name of the company the person belongs to.

# paths./person/{profileId}.get.description
Returns a person by their profile ID, including their profile details and external links.

# paths./person/{profileId}.get.parameters[].description
The unique identifier of the person's profile.

# paths./person/{profileId}.get.responses.200.content.application/json.schema.properties.companyId.description
The unique identifier of the company the person belongs to.

# paths./person/{profileId}.get.responses.200.content.application/json.schema.properties.companyName.description
The name of the company the person belongs to.

# paths./person/{profileId}.get.responses.200.content.application/json.schema.properties.externalLinks.description
Links to the person on external platforms and connected integrations.

# paths./search.get.description
Searches the authenticated user's meetings by name and content, with optional filters for specific meetings, tags, and people.

# paths./search.get.parameters[].description
The text to search for across meeting names and content.

# paths./search.get.parameters[].description
Restrict the search to the meetings with these IDs.

# paths./search.get.parameters[].description
Restrict the search to meetings with these tag IDs.

# paths./search.get.parameters[].description
Cursor for the next page. Omit for the first page (RFC 8288).

# paths./search.get.parameters[].description
Restrict the search to meetings attended by the people with these profile IDs.

# paths./search.get.responses.200.content.application/json.schema.description
The meetings that match the search query.

# paths./search.get.responses.200.content.application/json.schema.example[].notes
#### Overview
* Several options for event venues were reviewed…

# paths./search.get.responses.200.content.application/json.schema.example[].privateNotes
Ask Samantha about the Sunriver deposit before Friday.

# paths./search.get.responses.200.content.application/json.schema.example[].actionItems[].description
Reach out to Sunriver Events and other potential event venues to see if they would be open to hosting the event this summer.

# paths./search.get.responses.200.content.application/json.schema.example[].actionItems[].description
Review pricing and availability of venues and pick a venue for the event.

# paths./search.get.responses.200.content.application/json.schema.example[].insights.Questions[].insight
When will the webhook integration be ready?

# paths./tag.delete.description
Removes a tag from one or more meetings and returns the updated meetings.

# paths./tag.get.description
Returns every tag available to the authenticated user.

# paths./tag.post.description
Creates a new tag. If a tag with the same name already exists, a conflict error is returned.

# paths./tag.put.description
Applies an existing tag to one or more meetings and returns the updated meetings.

# paths./tag/{tagId}.delete.description
Permanently deletes a tag and removes it from every meeting it was applied to.

# tags[].description
Access meetings along with their notes, transcripts, attendees, recordings, and search.

# tags[].description
Read and update action items captured from meetings.

# tags[].description
Organize meetings with tags and manage tag assignments.

# tags[].description
View upcoming calendar events and control whether Circleback joins them.

# tags[].description
Look up the people who attend your meetings.

# tags[].description
Look up the companies associated with your meetings.