Explore
Clarify API
0.1
OAS 3.1
The Clarify API OpenAPI documentation.
default
GET
/health
GET
/nylas
/webhooks
POST
/nylas
/webhooks
GET
/profile
POST
/profile
/sync
GET
/slack
/connection
DELETE
/slack
/connection
POST
/slack
/oauth-callback
POST
/webhooks
/ampersand
/lifecycle
POST
/webhooks
/ampersand
/records
POST
/webhooks
/flatfile
/import-records
POST
/webhooks
/posthog
/events
POST
/webhooks
/recall
/bot-status
POST
/webhooks
/stripe
POST
/workspaces
/{workspace}
/ai-column
/{entityType}
/{messageid}
/revalidate
GET
/workspaces
/{workspace}
/async
GET
/workspaces
/{workspace}
/async
/{id}
GET
/workspaces
/{workspace}
/billing
/checkout
/{priceId}
GET
/workspaces
/{workspace}
/billing
/dashboard
GET
/workspaces
/{workspace}
/billing
/subscription
GET
/workspaces
/{workspace}
/billing
/usage
POST
/workspaces
/{workspace}
/comments
GET
/workspaces
/{workspace}
/comments
/{id}
PATCH
/workspaces
/{workspace}
/comments
/{id}
DELETE
/workspaces
/{workspace}
/comments
/{id}
POST
/workspaces
/{workspace}
/dashboards
/prompt
POST
/workspaces
/{workspace}
/dashboards
/query
GET
/workspaces
/{workspace}
/favorites
POST
/workspaces
/{workspace}
/favorites
PATCH
/workspaces
/{workspace}
/favorites
/{id}
DELETE
/workspaces
/{workspace}
/favorites
/{id}
GET
/workspaces
/{workspace}
/flatfile
/signature
POST
/workspaces
/{workspace}
/invitations
GET
/workspaces
/{workspace}
/invitations
GET
/workspaces
/{workspace}
/lists
/top
POST
/workspaces
/{workspace}
/live-updates
/authorize
GET
/workspaces
/{workspace}
/meetings
PATCH
/workspaces
/{workspace}
/meetings
/{meetingId}
/notes
PATCH
/workspaces
/{workspace}
/meetings
/{meetingId}
/prep
POST
/workspaces
/{workspace}
/meetings
/{meetingId}
/recording
DELETE
/workspaces
/{workspace}
/meetings
/{meetingId}
/recording
POST
/workspaces
/{workspace}
/meetings
/{meetingId}
/recordings
/{id}
/artifacts
DELETE
/workspaces
/{workspace}
/meetings
/{meetingId}
/recordings
/{recordingId}
PATCH
/workspaces
/{workspace}
/meetings
/{meetingId}
/summary
GET
/workspaces
/{workspace}
/messages
GET
/workspaces
/{workspace}
/notes
POST
/workspaces
/{workspace}
/notes
GET
/workspaces
/{workspace}
/notes
/{id}
PATCH
/workspaces
/{workspace}
/notes
/{id}
DELETE
/workspaces
/{workspace}
/notes
/{id}
GET
/workspaces
/{workspace}
/objects
/{object}
/cards
POST
/workspaces
/{workspace}
/objects
/{object}
/cards
PATCH
/workspaces
/{workspace}
/objects
/{object}
/cards
/{id}
DELETE
/workspaces
/{workspace}
/objects
/{object}
/cards
/{id}
GET
/workspaces
/{workspace}
/objects
/{object}
/lists
POST
/workspaces
/{workspace}
/objects
/{object}
/lists
GET
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
PATCH
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
DELETE
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
POST
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/from-nl
POST
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/records
DELETE
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/records
POST
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/rows
POST
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/rows
/csv
GET
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/views
POST
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/views
GET
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/views
/{view}
PATCH
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/views
/{view}
DELETE
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/views
/{view}
POST
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/views
/{view}
/from-nl
POST
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/views
/{view}
/records
POST
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/views
/{view}
/rows
POST
/workspaces
/{workspace}
/objects
/{object}
/lists
/{list}
/views
/{view}
/rows
/csv
POST
/workspaces
/{workspace}
/objects
/{object}
/records
PATCH
/workspaces
/{workspace}
/objects
/{object}
/records
DELETE
/workspaces
/{workspace}
/objects
/{object}
/records
GET
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
PATCH
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
DELETE
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
PUT
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
/attachments
POST
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
/attachments
GET
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
/attachments
/{attachmentId}
GET
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
/relationships
/{relationship}
POST
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
/relationships
/{relationship}
PATCH
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
/relationships
/{relationship}
DELETE
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
/relationships
/{relationship}
GET
/workspaces
/{workspace}
/objects
/{object}
/records
/{record}
/activities
GET
/workspaces
/{workspace}
/objects
/{object}
/records
/{record}
/cards
POST
/workspaces
/{workspace}
/objects
/{object}
/records
/{record}
/cards
POST
/workspaces
/{workspace}
/objects
/{object}
/records
/{record}
/merges
POST
/workspaces
/{workspace}
/objects
/{object}
/records
/bulk
GET
/workspaces
/{workspace}
/objects
/{object}
/resources
GET
/workspaces
/{workspace}
/objects
/{object}
/stats
POST
/workspaces
/{workspace}
/record-summary
POST
/workspaces
/{workspace}
/record-summary
/ai
GET
/workspaces
/{workspace}
/schemas
PATCH
/workspaces
/{workspace}
/schemas
PUT
/workspaces
/{workspace}
/schemas
/objects
/{object}
GET
/workspaces
/{workspace}
/search
/records
POST
/workspaces
/{workspace}
/search
/records
/prefix
POST
/workspaces
/{workspace}
/settings
GET
/workspaces
/{workspace}
/settings
GET
/workspaces
/{workspace}
/settings
/{key}
GET
/workspaces
/{workspace}
/suggestions
PATCH
/workspaces
/{workspace}
/suggestions
GET
/workspaces
/{workspace}
/tasks
PATCH
/workspaces
/{workspace}
/tasks
/{taskId}
/description
POST
/workspaces
/{workspace}
/user-settings
GET
/workspaces
/{workspace}
/user-settings
GET
/workspaces
/{workspace}
/user-settings
/{key}
GET
/workspaces
/{workspace}
/users
GET
/workspaces
/{workspace}
/users
/{userId}
GET
/workspaces
/{workspace}
/users
/me
/identities
POST
/workspaces
/{workspace}
/webhook-templates
POST
/workspaces
/{workspace}
/webhooks
GET
/workspaces
/{workspace}
/webhooks
PATCH
/workspaces
/{workspace}
/webhooks
/{id}
DELETE
/workspaces
/{workspace}
/webhooks
/{id}
GET
/workspaces
/{workspace}
/webhooks
/{id}
GET
/workspaces
/{workspace}
/webhooks
/{id}
/logs
GET
/workspaces
/{workspace}
/workflows
POST
/workspaces
/{workspace}
/workflows
GET
/workspaces
/{workspace}
/workflows
/{id}
PATCH
/workspaces
/{workspace}
/workflows
/{id}
DELETE
/workspaces
/{workspace}
/workflows
/{id}
GET
/workspaces
/{workspace}
/workflows
/{workflow}
/runs
GET
/workspaces
/{workspace}
/workflows
/{workflow}
/runs
/{id}
DELETE
/workspaces
/{workspace}
/workflows
/{workflow}
/runs
/{id}
GET
/zoom
/oauth
GET
/zoom
/oauth-callback
emails
POST
/workspaces
/{workspace}
/emails
pre-alpha
Record Subscriptions
GET
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
/subscription
Get record subscription status
POST
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
/subscription
Subscribe to record
DELETE
/workspaces
/{workspace}
/objects
/{object}
/records
/{id}
/subscription
Unsubscribe from record
Schemas
AmpersandRequestBodyDto
Expand all
object
AmpersandLifecycleRequestBodyDto
Expand all
object
ListOfActivitiesResponse
Expand all
object
RecordSummarizationTriggerDto
Expand all
object
UpdateSummaryDto
Expand all
object
RecordResponse
Expand all
object
BillingLinkDto
Expand all
object
BillingCreditUsageDto
Expand all
array<object>
SubscriptionDto
Expand all
object
CreateCommentDto
Expand all
object
UpdateCommentDto
Expand all
object
ListOfCustomCardsResponse
Expand all
object
CreateCustomCardDto
Expand all
object
CustomCardResponse
Expand all
object
SendEmailRequest
Expand all
object
SendEmailResponse
Expand all
object
ListOfSuggestionsResponse
Expand all
object
PatchSuggestionsDto
Expand all
(object | object)
PatchSuggestionsResponse
Expand all
object
ListOfListsResponse
Expand all
object
ListResponse
Expand all
object
CreateListDto
Expand all
object
UpdateListDto
Expand all
object
MutateListRecordsDto
Expand all
object
ListViewResponse
Expand all
object
ListOfViewsResponse
Expand all
object
CreateListViewDto
Expand all
object
UpdateListViewDto
Expand all
object
ListOfRowsRequestDto
Expand all
object
ListOfRowsResponse
Expand all
object
ListOfRecordsResponse
Expand all
object
ListsQueryRequestDto
Expand all
object
ListsQueryResponseDto
Expand all
object
RecordingArtifactResponse
Expand all
object
UpdateMeetingTextDto
Expand all
object
UpdateMeetingNotesDto
Expand all
object
NoteResponse
Expand all
object
NotePaginatedResponse
Expand all
object
CreateNoteDto
Expand all
object
UpdateNoteDto
Expand all
object
ProfileResponseSchemaDto
Expand all
object
CreateRecordDto
Expand all
object
CreateRecordResponse
Expand all
object
CreateBulkRecordDto
Expand all
object
CreateBulkRecordResponse
Expand all
object
UpdateRecordDto
Expand all
object
UpdateRecordsDto
Expand all
object
DeleteRecordsDto
Expand all
object
UpdateRelationshipDto
Expand all
object
CreateRecordFileDto
Expand all
object
GetSignedUrlForRecordAttachmentUploadResponse
Expand all
object
AddFileToRecordDto
Expand all
object
GetRecordAttachmentResponse
Expand all
object
MergeRecordsDto
Expand all
object
ResourcesResponse
Expand all
object
ListOfSchemasResponse
Expand all
object
UpdateEntitySchemaDto
Expand all
object
AsyncTaskResponse
Expand all
object
SchemaPropertiesPatchDto
Expand all
object
SchemaPropertiesPatchResponseDto
Expand all
object
ListOfEntitySearchResponse
Expand all
object
RecordsPrefixSearchParamsDto
Expand all
object
SlackConnectionDtoResponse
Expand all
object
SqlSchemaDto
Expand all
object
Nlq2SqlSchemaDto
Expand all
object
Nlq2SqlSchemaResponseDto
Expand all
object
ObjectStatsResponse
Expand all
object
PostHogEvent
Expand all
object
ListOfUsersResponse
Expand all
object
UserResponse
Expand all
object
ListUserIdentitiesResponseDto
Expand all
object
CreateWebhookDto
Expand all
(object | object)
WebhookResponseDto
Expand all
object
ListOfWebhookResponse
Expand all
object
UpdateWebhookDto
Expand all
object
ListOfWebhookLogResponse
Expand all
object
WebhookTemplateDto
Expand all
object
WebhookTemplateResponseDto
Expand all
object
ListOfAsyncTasksResponse
Expand all
object
WriteWorkspaceSettingDto
Expand all
object
WorkspaceSettingReadDto
Expand all
object
WorkspaceSettingsDto
Expand all
object
WriteWorkspaceUserSettingDto
Expand all
object
WorkspaceUserSettingReadDto
Expand all
object
WorkspaceUserSettingsDto
Expand all
object
FlatfileWebhookBodyDto
Expand all
object
FlatfileWebhookSignatureResponse
Expand all
object
WorkflowResponse
Expand all
object
ListOfWorkflowsResponse
Expand all
object
CreateWorkflowRequestDto
Expand all
object
UpdateWorkflowRequestDto
Expand all
object
WorkflowRunResponse
Expand all
object
ListOfWorkflowRunsResponse
Expand all
object
RecordSubscriptionResponse
Expand all
object
GetTasksResponse
Expand all
object
UpdateTaskDescriptionDto
Expand all
object
ListOfFavoritesResponse
Expand all
object
CreateFavoriteRequestDto
Expand all
object
FavoriteResponse
Expand all
object
UpdateFavoriteRequestDto
Expand all
object
CreateInvitationDto
Expand all
object
InvitationsResponse
Expand all
object