Open main menu
API Reference
Guides
Download Spec
View Changelog
Loading groups...
API Changelog: API Documentation
Previous
Next
Showing page
1
of
21
(
146
dates with changes)
Previous
1
2
3
...
21
Next
August 20, 2026
29 changes
29 changes
click to expand
+
Schema
added
_filter_root_meeting
Schema changes
+
oneOf:
+
- type: object
+
title: Advanced filters
+
required:
+
- "$op"
+
properties:
+
"$op":
+
enum:
+
- or
+
- and
+
type: string
+
x-enums:
+
or: OR
+
and: AND
+
patternProperties:
+
"^[0-9]+$":
+
"$ref": "#/components/schemas/_filter_root_meeting"
+
- "$ref": "#/components/schemas/filter_meeting"
+
required: false
+
x-internal: true
+
+
Schema
added
resource_meeting_participant
Schema changes
+
type: object
+
title: Meeting participant Resource
+
required: false
+
properties:
+
name:
+
type: string
+
title: Name
+
x-used-in:
+
- serializer
+
role:
+
type: string
+
title: Role
+
x-used-in:
+
- serializer
+
email:
+
type: string
+
title: Email
+
x-used-in:
+
- serializer
+
person:
+
title: Person
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_person
+
meeting:
+
title: Meeting
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_meeting
+
created_at:
+
type: string
+
title: Created At
+
format: date-time
+
x-used-in:
+
- serializer
+
updated_at:
+
type: string
+
title: Updated At
+
format: date-time
+
x-used-in:
+
- serializer
+
organization:
+
title: Organization
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_organization
+
x-internal: true
+
+
Schema
added
resource_meeting
Schema changes
+
type: object
+
title: Meeting Resource
+
required: false
+
properties:
+
id:
+
type: integer
+
title: Id
+
x-used-in:
+
- filter
+
deal:
+
title: Deal
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_deal
+
after:
+
type: string
+
title: After
+
format: date
+
x-used-in:
+
- filter
+
query:
+
type: string
+
title: Query
+
x-used-in:
+
- filter
+
title:
+
type: string
+
title: Title
+
x-used-in:
+
- serializer
+
- form
+
before:
+
type: string
+
title: Before
+
format: date
+
x-used-in:
+
- filter
+
status:
+
enum:
+
- pending
+
- joining
+
- in_progress
+
- processing
+
- completed
+
- failed
+
type: string
+
title: Status
+
x-enums:
+
failed: Failed
+
joining: Joining
+
pending: Pending
+
completed: Completed
+
processing: Processing
+
in_progress: In Progress
+
x-used-in:
+
- serializer
+
- filter
+
creator:
+
title: Creator
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_person
+
deal_id:
+
type: integer
+
title: Deal
+
x-used-in:
+
- form
+
- filter
+
project:
+
title: Project
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_project
+
summary:
+
type: string
+
title: Summary
+
x-used-in:
+
- serializer
+
- form
+
ended_at:
+
type: string
+
title: Ended At
+
format: date-time
+
x-used-in:
+
- serializer
+
platform:
+
enum:
+
- zoom
+
- google_meet
+
- microsoft_teams
+
- webex
+
- unknown
+
type: string
+
title: Platform
+
x-enums:
+
zoom: Zoom
+
webex: Webex
+
unknown: Unknown
+
google_meet: Google Meet
+
microsoft_teams: Microsoft Teams
+
x-used-in:
+
- serializer
+
- filter
+
created_at:
+
type: string
+
title: Created At
+
format: date-time
+
x-used-in:
+
- serializer
+
- sorter
+
project_id:
+
type: integer
+
title: Project
+
x-used-in:
+
- form
+
- filter
+
started_at:
+
type: string
+
title: Started At
+
format: date-time
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
transcript:
+
type: array
+
items: {}
+
title: Transcript
+
x-used-in:
+
- serializer
+
updated_at:
+
type: string
+
title: Updated At
+
format: date-time
+
x-used-in:
+
- serializer
+
calendar_id:
+
type: string
+
title: Calendar Id
+
x-used-in:
+
- serializer
+
- form
+
- filter
+
meeting_url:
+
type: string
+
title: Meeting Url
+
x-used-in:
+
- serializer
+
- form
+
- filter
+
organization:
+
title: Organization
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_organization
+
scheduled_at:
+
type: string
+
title: Scheduled At
+
format: date-time
+
x-used-in:
+
- serializer
+
- form
+
- sorter
+
action_points:
+
type: string
+
title: Action Points
+
x-used-in:
+
- serializer
+
- form
+
recording_url:
+
type: string
+
title: Recording Url
+
x-used-in:
+
- serializer
+
duration_seconds:
+
type: integer
+
title: Duration Seconds
+
x-used-in:
+
- serializer
+
calendar_event_id:
+
type: string
+
title: Calendar Event Id
+
x-used-in:
+
- serializer
+
- form
+
- filter
+
calendar_provider:
+
enum:
+
- google
+
- outlook
+
type: string
+
title: Calendar Provider
+
x-enums:
+
google: Google Calendar
+
outlook: Outlook Calendar
+
x-used-in:
+
- serializer
+
- form
+
- filter
+
notetaker_enabled:
+
type: boolean
+
title: Notetaker Enabled
+
x-used-in:
+
- serializer
+
- form
+
calendar_event_uid:
+
type: string
+
title: Calendar Event Uid
+
x-used-in:
+
- serializer
+
- form
+
- filter
+
transcript_markdown:
+
type: string
+
title: Transcript Markdown
+
x-used-in:
+
- serializer
+
meeting_participants:
+
title: Meeting Participants
+
x-used-in:
+
- serializer
+
x-relationship: has_many
+
x-related-resource: resource_meeting_participant
+
x-internal: true
+
+
Schema
added
filter_meeting
Schema changes
+
type: object
+
title: Filter meeting
+
required: false
+
properties:
+
id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/id"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/id"
+
- "$ref": "#/components/schemas/resource_meeting/properties/id"
+
after:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/after"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/after"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/after"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/after"
+
- "$ref": "#/components/schemas/resource_meeting/properties/after"
+
query:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/query"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/query"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/query"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/query"
+
- "$ref": "#/components/schemas/resource_meeting/properties/query"
+
before:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/before"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/before"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/before"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/before"
+
- "$ref": "#/components/schemas/resource_meeting/properties/before"
+
status:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/status"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/status"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/status"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/status"
+
- "$ref": "#/components/schemas/resource_meeting/properties/status"
+
deal_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/deal_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/deal_id"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/deal_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/deal_id"
+
- "$ref": "#/components/schemas/resource_meeting/properties/deal_id"
+
platform:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/platform"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/platform"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/platform"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/platform"
+
- "$ref": "#/components/schemas/resource_meeting/properties/platform"
+
project_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/project_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/project_id"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/project_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/project_id"
+
- "$ref": "#/components/schemas/resource_meeting/properties/project_id"
+
started_at:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/started_at"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/started_at"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/started_at"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/started_at"
+
- "$ref": "#/components/schemas/resource_meeting/properties/started_at"
+
calendar_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_id"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_id"
+
- "$ref": "#/components/schemas/resource_meeting/properties/calendar_id"
+
meeting_url:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/meeting_url"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/meeting_url"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/meeting_url"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/meeting_url"
+
- "$ref": "#/components/schemas/resource_meeting/properties/meeting_url"
+
calendar_event_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_id"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_id"
+
- "$ref": "#/components/schemas/resource_meeting/properties/calendar_event_id"
+
calendar_provider:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_provider"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_provider"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_provider"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_provider"
+
- "$ref": "#/components/schemas/resource_meeting/properties/calendar_provider"
+
calendar_event_uid:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_uid"
+
not_eq:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_uid"
+
contains:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_uid"
+
not_contain:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_uid"
+
- "$ref": "#/components/schemas/resource_meeting/properties/calendar_event_uid"
+
x-internal: true
+
patternProperties: {}
+
+
Schema
added
_filter_root_automation_report
Schema changes
+
oneOf:
+
- type: object
+
title: Advanced filters
+
required:
+
- "$op"
+
properties:
+
"$op":
+
enum:
+
- or
+
- and
+
type: string
+
x-enums:
+
or: OR
+
and: AND
+
patternProperties:
+
"^[0-9]+$":
+
"$ref": "#/components/schemas/_filter_root_automation_report"
+
- "$ref": "#/components/schemas/filter_automation_report"
+
required: false
+
x-internal: true
+
+
Schema
added
resource_automation_report
Schema changes
+
type: object
+
title: Automation report Resource
+
required: false
+
properties:
+
id:
+
type: integer
+
title: Id
+
x-used-in:
+
- filter
+
name:
+
type: string
+
title: Name
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
count:
+
type: integer
+
title: Count
+
x-used-in:
+
- serializer
+
- sorter
+
group:
+
type: string
+
title: Group
+
x-used-in:
+
- serializer
+
query:
+
type: string
+
title: Query
+
x-used-in:
+
- filter
+
report:
+
title: Report
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_automation_report
+
creator:
+
title: Creator
+
x-used-in:
+
- serializer
+
- sorter
+
- grouper
+
x-relationship: has_one
+
x-related-resource: resource_person
+
enabled:
+
type: boolean
+
title: Enabled
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
project:
+
title: Project
+
x-used-in:
+
- serializer
+
- sorter
+
- grouper
+
x-relationship: has_one
+
x-related-resource: resource_project
+
type_id:
+
enum:
+
- 1
+
- 2
+
type: integer
+
title: Type
+
x-enums:
+
'1': Event
+
'2': Time
+
x-used-in:
+
- serializer
+
- sorter
+
- grouper
+
- filter
+
agent_id:
+
type: integer
+
title: Agent
+
x-used-in:
+
- filter
+
projects:
+
title: Projects
+
x-used-in:
+
- serializer
+
x-relationship: has_many
+
x-related-resource: resource_project
+
survey_id:
+
type: integer
+
title: Survey
+
x-used-in:
+
- filter
+
target_id:
+
enum:
+
- 1
+
- 2
+
- 3
+
- 4
+
- 5
+
- 6
+
- 7
+
- 8
+
- 9
+
- 10
+
- 11
+
type: integer
+
title: Target
+
x-enums:
+
'1': Task
+
'2': Deal
+
'3': Budget
+
'4': Invoice
+
'5': Survey Response
+
'6': Project
+
'7': Booking
+
'8': Expense
+
'9': Company
+
'10': Employee
+
'11': Slack Message
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
automation:
+
title: Automation
+
x-used-in:
+
- serializer
+
- grouper
+
x-relationship: has_one
+
x-related-resource: resource_automation
+
created_at:
+
type: string
+
title: Created At
+
format: date
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
creator_id:
+
type: integer
+
title: Creator
+
x-used-in:
+
- filter
+
project_id:
+
type: integer
+
title: Project
+
x-used-in:
+
- filter
+
updated_at:
+
type: string
+
title: Updated At
+
format: date
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
description:
+
type: string
+
title: Description
+
x-used-in:
+
- serializer
+
- sorter
+
organization:
+
title: Organization
+
x-used-in:
+
- serializer
+
- grouper
+
x-relationship: has_one
+
formula_fields:
+
title: Formula Fields
+
x-used-in:
+
- serializer
+
automatable_type:
+
type: string
+
title: Automatable Type
+
x-used-in:
+
- filter
+
created_at_period:
+
title: Created At Period
+
x-used-in:
+
- serializer
+
updated_at_period:
+
title: Updated At Period
+
x-used-in:
+
- serializer
+
resolve_on_all_projects:
+
type: boolean
+
title: Resolve On All Projects
+
x-used-in:
+
- serializer
+
- filter
+
exclude_template_projects:
+
type: boolean
+
title: Exclude Template Projects
+
x-used-in:
+
- filter
+
+
Schema
added
filter_automation_report
Schema changes
+
type: object
+
title: Filter automation report
+
required: false
+
properties:
+
id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/id"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/id"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/id"
+
name:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/name"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/name"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/name"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/name"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/name"
+
query:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/query"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/query"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/query"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/query"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/query"
+
enabled:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/enabled"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/enabled"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/enabled"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/enabled"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/enabled"
+
type_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/type_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/type_id"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/type_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/type_id"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/type_id"
+
agent_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/agent_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/agent_id"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/agent_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/agent_id"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/agent_id"
+
survey_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/survey_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/survey_id"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/survey_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/survey_id"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/survey_id"
+
target_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/target_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/target_id"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/target_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/target_id"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/target_id"
+
created_at:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/created_at"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/created_at"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/created_at"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/created_at"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/created_at"
+
creator_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/creator_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/creator_id"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/creator_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/creator_id"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/creator_id"
+
project_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/project_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/project_id"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/project_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/project_id"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/project_id"
+
updated_at:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/updated_at"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/updated_at"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/updated_at"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/updated_at"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/updated_at"
+
automatable_type:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/automatable_type"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/automatable_type"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/automatable_type"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/automatable_type"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/automatable_type"
+
resolve_on_all_projects:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/resolve_on_all_projects"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/resolve_on_all_projects"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/resolve_on_all_projects"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/resolve_on_all_projects"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/resolve_on_all_projects"
+
exclude_template_projects:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/exclude_template_projects"
+
not_eq:
+
"$ref": "#/components/schemas/resource_automation_report/properties/exclude_template_projects"
+
contains:
+
"$ref": "#/components/schemas/resource_automation_report/properties/exclude_template_projects"
+
not_contain:
+
"$ref": "#/components/schemas/resource_automation_report/properties/exclude_template_projects"
+
- "$ref": "#/components/schemas/resource_automation_report/properties/exclude_template_projects"
+
x-internal: true
+
patternProperties: {}
+
~
Schema
modified
resource_search_quick_result
Schema changes
- budget
- action
- invoice
+
- artifact
type: string
title: Record Type
x-enums:
...
company: Company
invoice: Invoice
project: Project
+
artifact: Artifact
task_list: Task List
x-used-in:
- serializer
~
Schema
modified
resource_page
Schema changes
'2': Archived
x-used-in:
- filter
-
subscriber_ids:
-
title: Subscriber Ids
-
x-used-in:
-
- form
version_number:
type: integer
title: Version Number
...
title: Cover Image Meta
x-used-in:
- serializer
-
- form
last_activity_at:
type: string
title: Last Activity At
+
Parameter
added
sort_automation_report
Schema changes
+
in: query
+
name: sort
+
style: form
+
schema:
+
type: array
+
items:
+
enum:
+
- automation_created_at
+
- "-automation_created_at"
+
- automation_updated_at
+
- "-automation_updated_at"
+
- count
+
- "-count"
+
- created_at
+
- "-created_at"
+
- creator
+
- "-creator"
+
- description
+
- "-description"
+
- enabled
+
- "-enabled"
+
- name
+
- "-name"
+
- project
+
- "-project"
+
- target_id
+
- "-target_id"
+
- type_id
+
- "-type_id"
+
- updated_at
+
- "-updated_at"
+
type: string
+
title: Sort automation report
+
explode: false
+
required: false
+
+
Parameter
added
filter_automation_report
Schema changes
+
in: query
+
name: filter
+
style: deepObject
+
schema:
+
"$ref": "#/components/schemas/_filter_root_automation_report"
+
required: false
+
+
Parameter
added
filter_meeting
Schema changes
+
in: query
+
name: filter
+
style: deepObject
+
schema:
+
"$ref": "#/components/schemas/_filter_root_meeting"
+
required: false
+
+
Parameter
added
group_automation_report
Schema changes
+
in: query
+
name: group
+
style: form
+
schema:
+
enum:
+
- automation
+
- created_at
+
- creator
+
- enabled
+
- organization
+
- project
+
- target
+
- type
+
- updated_at
+
type: string
+
title: Group automation report
+
x-enums:
+
type: Type
+
target: Target
+
creator: Creator
+
enabled: Enabled
+
project: Project
+
automation: Automation
+
created_at: Created At
+
updated_at: Updated At
+
organization: Organization
+
explode: false
+
required: false
+
+
Parameter
added
sort_meeting
Schema changes
+
in: query
+
name: sort
+
style: form
+
schema:
+
type: array
+
items:
+
enum:
+
- created_at
+
- "-created_at"
+
- scheduled_at
+
- "-scheduled_at"
+
- started_at
+
- "-started_at"
+
type: string
+
title: Sort meeting
+
explode: false
+
required: false
+
~
Request body
modified
page_create_with_markdown
Schema changes
"$ref": "#/components/schemas/resource_page/properties/attachment_ids"
parent_page_id:
"$ref": "#/components/schemas/resource_page/properties/parent_page_id"
-
subscriber_ids:
-
"$ref": "#/components/schemas/resource_page/properties/subscriber_ids"
cover_image_url:
"$ref": "#/components/schemas/resource_page/properties/cover_image_url"
-
cover_image_meta:
-
"$ref": "#/components/schemas/resource_page/properties/cover_image_meta"
+
Request body
added
meeting
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
title:
+
"$ref": "#/components/schemas/resource_meeting/properties/title"
+
deal_id:
+
"$ref": "#/components/schemas/resource_meeting/properties/deal_id"
+
summary:
+
"$ref": "#/components/schemas/resource_meeting/properties/summary"
+
project_id:
+
"$ref": "#/components/schemas/resource_meeting/properties/project_id"
+
calendar_id:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_id"
+
meeting_url:
+
"$ref": "#/components/schemas/resource_meeting/properties/meeting_url"
+
scheduled_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/scheduled_at"
+
action_points:
+
"$ref": "#/components/schemas/resource_meeting/properties/action_points"
+
calendar_event_id:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_id"
+
calendar_provider:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_provider"
+
notetaker_enabled:
+
"$ref": "#/components/schemas/resource_meeting/properties/notetaker_enabled"
+
calendar_event_uid:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_uid"
+
~
Request body
modified
page
Schema changes
"$ref": "#/components/schemas/resource_page/properties/attachment_ids"
parent_page_id:
"$ref": "#/components/schemas/resource_page/properties/parent_page_id"
-
subscriber_ids:
-
"$ref": "#/components/schemas/resource_page/properties/subscriber_ids"
version_number:
"$ref": "#/components/schemas/resource_page/properties/version_number"
cover_image_url:
"$ref": "#/components/schemas/resource_page/properties/cover_image_url"
-
cover_image_meta:
-
"$ref": "#/components/schemas/resource_page/properties/cover_image_meta"
+
Response
added
collection_automation_report
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: array
+
items:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_automation_report/properties/name"
+
count:
+
"$ref": "#/components/schemas/resource_automation_report/properties/count"
+
group:
+
"$ref": "#/components/schemas/resource_automation_report/properties/group"
+
enabled:
+
"$ref": "#/components/schemas/resource_automation_report/properties/enabled"
+
type_id:
+
"$ref": "#/components/schemas/resource_automation_report/properties/type_id"
+
target_id:
+
"$ref": "#/components/schemas/resource_automation_report/properties/target_id"
+
created_at:
+
"$ref": "#/components/schemas/resource_automation_report/properties/created_at"
+
updated_at:
+
"$ref": "#/components/schemas/resource_automation_report/properties/updated_at"
+
description:
+
"$ref": "#/components/schemas/resource_automation_report/properties/description"
+
formula_fields:
+
"$ref": "#/components/schemas/resource_automation_report/properties/formula_fields"
+
resolve_on_all_projects:
+
"$ref": "#/components/schemas/resource_automation_report/properties/resolve_on_all_projects"
+
relationships:
+
type: object
+
properties:
+
report:
+
"$ref": "#/components/schemas/_single_relationship"
+
creator:
+
"$ref": "#/components/schemas/_single_relationship"
+
project:
+
"$ref": "#/components/schemas/_single_relationship"
+
projects:
+
"$ref": "#/components/schemas/_collection_relationship"
+
automation:
+
"$ref": "#/components/schemas/_single_relationship"
+
organization:
+
"$ref": "#/components/schemas/_single_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
single_meeting
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
title:
+
"$ref": "#/components/schemas/resource_meeting/properties/title"
+
status:
+
"$ref": "#/components/schemas/resource_meeting/properties/status"
+
summary:
+
"$ref": "#/components/schemas/resource_meeting/properties/summary"
+
ended_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/ended_at"
+
platform:
+
"$ref": "#/components/schemas/resource_meeting/properties/platform"
+
created_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/created_at"
+
started_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/started_at"
+
transcript:
+
"$ref": "#/components/schemas/resource_meeting/properties/transcript"
+
updated_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/updated_at"
+
calendar_id:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_id"
+
meeting_url:
+
"$ref": "#/components/schemas/resource_meeting/properties/meeting_url"
+
scheduled_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/scheduled_at"
+
action_points:
+
"$ref": "#/components/schemas/resource_meeting/properties/action_points"
+
recording_url:
+
"$ref": "#/components/schemas/resource_meeting/properties/recording_url"
+
duration_seconds:
+
"$ref": "#/components/schemas/resource_meeting/properties/duration_seconds"
+
calendar_event_id:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_id"
+
calendar_provider:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_provider"
+
notetaker_enabled:
+
"$ref": "#/components/schemas/resource_meeting/properties/notetaker_enabled"
+
calendar_event_uid:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_uid"
+
transcript_markdown:
+
"$ref": "#/components/schemas/resource_meeting/properties/transcript_markdown"
+
relationships:
+
type: object
+
properties:
+
deal:
+
"$ref": "#/components/schemas/_single_relationship"
+
creator:
+
"$ref": "#/components/schemas/_single_relationship"
+
project:
+
"$ref": "#/components/schemas/_single_relationship"
+
organization:
+
"$ref": "#/components/schemas/_single_relationship"
+
meeting_participants:
+
"$ref": "#/components/schemas/_collection_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
collection_meeting
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: array
+
items:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
title:
+
"$ref": "#/components/schemas/resource_meeting/properties/title"
+
status:
+
"$ref": "#/components/schemas/resource_meeting/properties/status"
+
summary:
+
"$ref": "#/components/schemas/resource_meeting/properties/summary"
+
ended_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/ended_at"
+
platform:
+
"$ref": "#/components/schemas/resource_meeting/properties/platform"
+
created_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/created_at"
+
started_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/started_at"
+
transcript:
+
"$ref": "#/components/schemas/resource_meeting/properties/transcript"
+
updated_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/updated_at"
+
calendar_id:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_id"
+
meeting_url:
+
"$ref": "#/components/schemas/resource_meeting/properties/meeting_url"
+
scheduled_at:
+
"$ref": "#/components/schemas/resource_meeting/properties/scheduled_at"
+
action_points:
+
"$ref": "#/components/schemas/resource_meeting/properties/action_points"
+
recording_url:
+
"$ref": "#/components/schemas/resource_meeting/properties/recording_url"
+
duration_seconds:
+
"$ref": "#/components/schemas/resource_meeting/properties/duration_seconds"
+
calendar_event_id:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_id"
+
calendar_provider:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_provider"
+
notetaker_enabled:
+
"$ref": "#/components/schemas/resource_meeting/properties/notetaker_enabled"
+
calendar_event_uid:
+
"$ref": "#/components/schemas/resource_meeting/properties/calendar_event_uid"
+
transcript_markdown:
+
"$ref": "#/components/schemas/resource_meeting/properties/transcript_markdown"
+
relationships:
+
type: object
+
properties:
+
deal:
+
"$ref": "#/components/schemas/_single_relationship"
+
creator:
+
"$ref": "#/components/schemas/_single_relationship"
+
project:
+
"$ref": "#/components/schemas/_single_relationship"
+
organization:
+
"$ref": "#/components/schemas/_single_relationship"
+
meeting_participants:
+
"$ref": "#/components/schemas/_collection_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Group
added
Meetings
Schema changes
+
name: Meetings
+
x-internal: true
+
x-resource: resource_meeting
+
+
Group
added
Meeting Participants
Schema changes
+
name: Meeting Participants
+
x-internal: true
+
x-resource: resource_meeting_participant
+
+
Get meetings
GET
Operation
added
/api/v2/meetings/get
Schema changes
+
tags:
+
- Meetings
+
summary: Get meetings
+
responses:
+
'200':
+
"$ref": "#/components/responses/collection_meeting"
+
parameters:
+
- "$ref": "#/components/parameters/filter_meeting"
+
- "$ref": "#/components/parameters/sort_meeting"
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: meetings-index
+
x-feature-flags:
+
- meetingNotetaker
+
+
Create a meeting
POST
Operation
added
/api/v2/meetings/post
Schema changes
+
tags:
+
- Meetings
+
summary: Create a meeting
+
responses:
+
'201':
+
"$ref": "#/components/responses/single_meeting"
+
'403':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
'422':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
parameters:
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: meetings-create
+
requestBody:
+
"$ref": "#/components/requestBodies/meeting"
+
x-feature-flags:
+
- meetingNotetaker
+
+
Deletes a meeting
DELETE
Operation
added
/api/v2/meetings/{id}/delete
Schema changes
+
tags:
+
- Meetings
+
summary: Deletes a meeting
+
responses:
+
'204': {}
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: meetings-destroy
+
x-feature-flags:
+
- meetingNotetaker
+
+
Gets a meeting
GET
Operation
added
/api/v2/meetings/{id}/get
Schema changes
+
tags:
+
- Meetings
+
summary: Gets a meeting
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_meeting"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: meetings-show
+
x-feature-flags:
+
- meetingNotetaker
+
+
Update a meeting
PATCH
Operation
added
/api/v2/meetings/{id}/patch
Schema changes
+
tags:
+
- Meetings
+
summary: Update a meeting
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_meeting"
+
'403':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
'422':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: meetings-update
+
requestBody:
+
"$ref": "#/components/requestBodies/meeting"
+
x-feature-flags:
+
- meetingNotetaker
+
+
Deletes a meeting recording
PATCH
Operation
added
/api/v2/meetings/{id}/delete_recording/patch
Schema changes
+
tags:
+
- Meetings
+
summary: Deletes a meeting recording
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_meeting"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: meetings-delete_recording-delete_recording
+
x-feature-flags:
+
- meetingNotetaker
+
+
Get automation reports
GET
Operation
added
/api/v2/reports/automation_reports/get
Schema changes
+
tags:
+
- Reports
+
summary: Get automation reports
+
responses:
+
'200':
+
"$ref": "#/components/responses/collection_automation_report"
+
parameters:
+
- "$ref": "#/components/parameters/filter_automation_report"
+
- "$ref": "#/components/parameters/sort_automation_report"
+
- "$ref": "#/components/parameters/group_automation_report"
+
- "$ref": "#/components/parameters/header_organization"
+
x-resource: resource_automation_report
+
operationId: reports-automation_reports-index
+
August 17, 2026
38 changes
38 changes
click to expand
-
Group
removed
Deal Contacts
Schema changes
-
name: Deal Contacts
-
x-resource: resource_deal_contact
-
-
Group
removed
Artifacts
Schema changes
-
name: Artifacts
-
x-resource: resource_artifact
-
-
Group
removed
Deal Contacts - Bulk
Schema changes
-
name: Deal Contacts - Bulk
-
x-resource: resource_deal_contact
-
-
Schema
removed
resource_artifact
Schema changes
-
type: object
-
title: Artifact Resource
-
required: false
-
properties:
-
id:
-
type: integer
-
x-used-in:
-
- filter
-
name:
-
type: string
-
title: Name
-
x-used-in:
-
- serializer
-
- form
-
created_at:
-
type: string
-
title: Created At
-
format: date-time
-
x-used-in:
-
- serializer
-
creator_id:
-
type: integer
-
x-used-in:
-
- filter
-
updated_at:
-
type: string
-
title: Updated At
-
format: date-time
-
x-used-in:
-
- serializer
-
description:
-
type: string
-
title: Description
-
x-used-in:
-
- serializer
-
- form
-
public_uuid:
-
type: string
-
title: Public Uuid
-
x-used-in:
-
- serializer
-
public_access:
-
type: boolean
-
title: Public Access
-
x-used-in:
-
- serializer
-
~
Schema
modified
resource_approval_status
Schema changes
title: Approver Group Key
x-used-in:
- serializer
+
x-feature-flags:
+
- pmDynamicApproverOnAbsences
approval_workflow_id:
type: integer
title: Approval Workflow
~
Schema
modified
resource_integration_task_management_configuration
Schema changes
- serializer
x-relationship: has_one
x-related-resource: resource_service
-
jira_board_name:
-
type: string
-
title: Jira Board Name
-
x-used-in:
-
- serializer
default_person_id:
type: integer
title: Default Person
x-used-in:
- form
-
jira_project_name:
-
type: string
-
title: Jira Project Name
-
x-used-in:
-
- serializer
default_service_id:
type: integer
title: Default Service
-
Schema
removed
resource_proposal_identity_confirmation
Schema changes
-
type: object
-
title: Proposal Identity Confirmation Resource
-
required: false
-
properties:
-
token:
-
type: string
-
title: Token
-
x-used-in:
-
- form
-
-
Schema
removed
filter_deal_contact
Schema changes
-
type: object
-
title: Filter deal contact
-
required: false
-
properties:
-
id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/id"
-
contains:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/id"
-
- "$ref": "#/components/schemas/resource_deal_contact/properties/id"
-
deal_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
-
contains:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
-
- "$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
-
position:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
-
not_eq:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
-
contains:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
-
not_contain:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
-
- "$ref": "#/components/schemas/resource_deal_contact/properties/position"
-
person_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
-
contains:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
-
- "$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
-
x-internal: true
-
patternProperties: {}
-
-
Schema
removed
_filter_root_deal_contact
Schema changes
-
oneOf:
-
- type: object
-
title: Advanced filters
-
required:
-
- "$op"
-
properties:
-
"$op":
-
enum:
-
- or
-
- and
-
type: string
-
x-enums:
-
or: OR
-
and: AND
-
patternProperties:
-
"^[0-9]+$":
-
"$ref": "#/components/schemas/_filter_root_deal_contact"
-
- "$ref": "#/components/schemas/filter_deal_contact"
-
required: false
-
x-internal: true
-
~
Schema
modified
resource_project_relevancy_report
Schema changes
title: Time Tracked Score
x-used-in:
- serializer
-
activity_period_end:
-
type: string
-
title: Activity Period End
-
format: date
-
x-used-in:
-
- filter
-
activity_period_start:
-
type: string
-
title: Activity Period Start
-
format: date
-
x-used-in:
-
- filter
pinned_services_score:
type: integer
title: Pinned Services Score
~
Schema
modified
filter_project_relevancy_report
Schema changes
not_contain:
"$ref": "#/components/schemas/resource_project_relevancy_report/properties/heuristic_type"
- "$ref": "#/components/schemas/resource_project_relevancy_report/properties/heuristic_type"
-
activity_period_end:
-
"$ref": "#/components/schemas/resource_project_relevancy_report/properties/activity_period_end"
-
activity_period_start:
-
"$ref": "#/components/schemas/resource_project_relevancy_report/properties/activity_period_start"
time_trackable_on_date:
"$ref": "#/components/schemas/resource_project_relevancy_report/properties/time_trackable_on_date"
time_tracked_period_end:
~
Schema
modified
resource_proposal
Schema changes
decline_reason:
type: string
title: Decline Reason
-
nullable: true
x-used-in:
- serializer
responder_name:
type: string
title: Responder Name
-
nullable: true
x-used-in:
- serializer
responsible_id:
...
title: Responsible
x-used-in:
- filter
-
signature_type:
-
enum:
-
- typed
-
- drawn
-
- uploaded
-
type: string
-
title: Signature Type
-
x-enums:
-
drawn: Drawn
-
typed: Typed
-
uploaded: Uploaded
-
x-used-in:
-
- form
signed_pdf_url:
type: string
title: Signed Pdf Url
...
responder_email:
type: string
title: Responder Email
-
nullable: true
x-used-in:
- serializer
currency_default:
...
title: Currency Normalized
x-used-in:
- serializer
-
disclaimer_accepted:
-
type: boolean
-
title: Disclaimer Accepted
-
x-used-in:
-
- form
footer_interpolated:
title: Footer Interpolated
x-used-in:
- serializer
-
signature_image_url:
-
type: string
-
title: Signature Image Url
-
x-used-in:
-
- form
budget_total_default:
title: Budget Total Default
x-used-in:
- serializer
-
proposal_version_two:
-
type: boolean
-
title: Proposal Version Two
-
x-used-in:
-
- serializer
-
identity_confirmed_at:
-
type: string
-
title: Identity Confirmed At
-
format: date-time
-
nullable: true
-
x-used-in:
-
- serializer
-
x-feature-flags:
-
- proposalVersionTwo
purchase_order_number:
type: string
title: Purchase Order Number
...
responded_via_public_link:
type: boolean
title: Responded Via Public Link
-
nullable: true
-
x-used-in:
-
- serializer
-
identity_confirmation_enabled:
-
type: boolean
-
title: Identity Confirmation Enabled
-
x-used-in:
-
- serializer
-
x-feature-flags:
-
- proposalVersionTwo
-
proposal_pdf_preview_on_mobile:
-
type: boolean
-
title: Proposal Pdf Preview On Mobile
x-used-in:
- serializer
-
Schema
removed
_filter_root_artifact
Schema changes
-
oneOf:
-
- type: object
-
title: Advanced filters
-
required:
-
- "$op"
-
properties:
-
"$op":
-
enum:
-
- or
-
- and
-
type: string
-
x-enums:
-
or: OR
-
and: AND
-
patternProperties:
-
"^[0-9]+$":
-
"$ref": "#/components/schemas/_filter_root_artifact"
-
- "$ref": "#/components/schemas/filter_artifact"
-
required: false
-
x-internal: true
-
~
Schema
modified
resource_deal
Schema changes
- serializer
- form
- filter
+
x-feature-flags:
+
- dealMandatoryTimeEntryNote
+
- dealMandatoryTimeEntryTask
automatic_invoicing_rule:
title: Automatic Invoicing Rule
x-used-in:
-
Schema
removed
resource_deal_contact
Schema changes
-
type: object
-
title: Deal contact Resource
-
required: false
-
properties:
-
id:
-
type: integer
-
title: Id
-
x-used-in:
-
- filter
-
deal:
-
title: Deal
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_deal
-
person:
-
title: Person
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_person
-
deal_id:
-
type: integer
-
title: Deal
-
x-used-in:
-
- form
-
- filter
-
position:
-
type: integer
-
title: Position
-
x-used-in:
-
- serializer
-
- form
-
- filter
-
person_id:
-
type: integer
-
title: Person
-
x-used-in:
-
- form
-
- filter
-
-
Schema
removed
filter_artifact
Schema changes
-
type: object
-
title: Filter artifact
-
required: false
-
properties:
-
id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/id"
-
contains:
-
"$ref": "#/components/schemas/resource_artifact/properties/id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_artifact/properties/id"
-
- "$ref": "#/components/schemas/resource_artifact/properties/id"
-
name:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/name"
-
not_eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/name"
-
contains:
-
"$ref": "#/components/schemas/resource_artifact/properties/name"
-
not_contain:
-
"$ref": "#/components/schemas/resource_artifact/properties/name"
-
- "$ref": "#/components/schemas/resource_artifact/properties/name"
-
created_at:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
-
not_eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
-
contains:
-
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
-
not_contain:
-
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
-
- "$ref": "#/components/schemas/resource_artifact/properties/created_at"
-
creator_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
-
contains:
-
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
-
- "$ref": "#/components/schemas/resource_artifact/properties/creator_id"
-
public_access:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/public_access"
-
not_eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/public_access"
-
- "$ref": "#/components/schemas/resource_artifact/properties/public_access"
-
x-internal: true
-
patternProperties: {}
-
~
Response
modified
collection_time_entry
Schema changes
approved:
"$ref": "#/components/schemas/resource_time_entry/properties/approved"
currency:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/currency"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/currency"
-
- type: 'null'
invoiced:
"$ref": "#/components/schemas/resource_time_entry/properties/invoiced"
overhead:
...
created_at:
"$ref": "#/components/schemas/resource_time_entry/properties/created_at"
started_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/started_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/started_at"
-
- type: 'null'
updated_at:
"$ref": "#/components/schemas/resource_time_entry/properties/updated_at"
approved_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/approved_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/approved_at"
-
- type: 'null'
rejected_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/rejected_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/rejected_at"
-
- type: 'null'
cost_default:
"$ref": "#/components/schemas/resource_time_entry/properties/cost_default"
billable_time:
"$ref": "#/components/schemas/resource_time_entry/properties/billable_time"
jira_issue_id:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id"
-
- type: 'null'
overhead_cost:
"$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost"
cost_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/cost_normalized"
jira_worklog_id:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id"
-
- type: 'null'
recognized_time:
"$ref": "#/components/schemas/resource_time_entry/properties/recognized_time"
rejected_reason:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/rejected_reason"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/rejected_reason"
-
- type: 'null'
track_method_id:
"$ref": "#/components/schemas/resource_time_entry/properties/track_method_id"
currency_default:
"$ref": "#/components/schemas/resource_time_entry/properties/currency_default"
last_activity_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at"
-
- type: 'null'
timer_started_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/timer_started_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/timer_started_at"
-
- type: 'null'
timer_stopped_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/timer_stopped_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/timer_stopped_at"
-
- type: 'null'
calendar_event_id:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id"
-
- type: 'null'
jira_issue_status:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status"
-
- type: 'null'
jira_organization:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/jira_organization"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_organization"
-
- type: 'null'
work_cost_default:
"$ref": "#/components/schemas/resource_time_entry/properties/work_cost_default"
jira_issue_summary:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary"
-
- type: 'null'
currency_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/currency_normalized"
work_cost_normalized:
...
internal_overhead_cost:
"$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost"
invoice_attribution_id:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id"
-
- type: 'null'
overhead_cost_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost_normalized"
facility_overhead_cost_default:
~
Response
modified
single_time_entry
Schema changes
approved:
"$ref": "#/components/schemas/resource_time_entry/properties/approved"
currency:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/currency"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/currency"
-
- type: 'null'
invoiced:
"$ref": "#/components/schemas/resource_time_entry/properties/invoiced"
overhead:
...
created_at:
"$ref": "#/components/schemas/resource_time_entry/properties/created_at"
started_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/started_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/started_at"
-
- type: 'null'
updated_at:
"$ref": "#/components/schemas/resource_time_entry/properties/updated_at"
approved_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/approved_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/approved_at"
-
- type: 'null'
rejected_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/rejected_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/rejected_at"
-
- type: 'null'
cost_default:
"$ref": "#/components/schemas/resource_time_entry/properties/cost_default"
billable_time:
"$ref": "#/components/schemas/resource_time_entry/properties/billable_time"
jira_issue_id:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id"
-
- type: 'null'
overhead_cost:
"$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost"
cost_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/cost_normalized"
jira_worklog_id:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id"
-
- type: 'null'
recognized_time:
"$ref": "#/components/schemas/resource_time_entry/properties/recognized_time"
rejected_reason:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/rejected_reason"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/rejected_reason"
-
- type: 'null'
track_method_id:
"$ref": "#/components/schemas/resource_time_entry/properties/track_method_id"
currency_default:
"$ref": "#/components/schemas/resource_time_entry/properties/currency_default"
last_activity_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at"
-
- type: 'null'
timer_started_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/timer_started_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/timer_started_at"
-
- type: 'null'
timer_stopped_at:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/timer_stopped_at"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/timer_stopped_at"
-
- type: 'null'
calendar_event_id:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id"
-
- type: 'null'
jira_issue_status:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status"
-
- type: 'null'
jira_organization:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/jira_organization"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_organization"
-
- type: 'null'
work_cost_default:
"$ref": "#/components/schemas/resource_time_entry/properties/work_cost_default"
jira_issue_summary:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary"
-
- type: 'null'
currency_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/currency_normalized"
work_cost_normalized:
...
internal_overhead_cost:
"$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost"
invoice_attribution_id:
-
anyOf:
+
"$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id"
-
- "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id"
-
- type: 'null'
overhead_cost_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost_normalized"
facility_overhead_cost_default:
~
Response
modified
collection_integration_task_management_configuration
Schema changes
"$ref": "#/components/schemas/resource_integration_task_management_configuration/properties/jira_project"
jira_screens:
"$ref": "#/components/schemas/resource_integration_task_management_configuration/properties/jira_screens"
-
jira_board_name:
-
"$ref": "#/components/schemas/resource_integration_task_management_configuration/properties/jira_board_name"
-
jira_project_name:
-
"$ref": "#/components/schemas/resource_integration_task_management_configuration/properties/jira_project_name"
jira_hierarchy_resolution_enabled:
"$ref": "#/components/schemas/resource_integration_task_management_configuration/properties/jira_hierarchy_resolution_enabled"
relationships:
~
Response
modified
collection_proposal
Schema changes
"$ref": "#/components/schemas/resource_proposal/properties/footer_interpolated"
budget_total_default:
"$ref": "#/components/schemas/resource_proposal/properties/budget_total_default"
-
identity_confirmed_at:
-
"$ref": "#/components/schemas/resource_proposal/properties/identity_confirmed_at"
purchase_order_number:
"$ref": "#/components/schemas/resource_proposal/properties/purchase_order_number"
budget_total_normalized:
"$ref": "#/components/schemas/resource_proposal/properties/budget_total_normalized"
-
identity_confirmation_enabled:
-
"$ref": "#/components/schemas/resource_proposal/properties/identity_confirmation_enabled"
relationships:
type: object
properties:
~
Response
modified
single_integration_task_management_configuration
Schema changes
"$ref": "#/components/schemas/resource_integration_task_management_configuration/properties/jira_project"
jira_screens:
"$ref": "#/components/schemas/resource_integration_task_management_configuration/properties/jira_screens"
-
jira_board_name:
-
"$ref": "#/components/schemas/resource_integration_task_management_configuration/properties/jira_board_name"
-
jira_project_name:
-
"$ref": "#/components/schemas/resource_integration_task_management_configuration/properties/jira_project_name"
jira_hierarchy_resolution_enabled:
"$ref": "#/components/schemas/resource_integration_task_management_configuration/properties/jira_hierarchy_resolution_enabled"
relationships:
~
Response
modified
single_proposal
Schema changes
"$ref": "#/components/schemas/resource_proposal/properties/footer_interpolated"
budget_total_default:
"$ref": "#/components/schemas/resource_proposal/properties/budget_total_default"
-
identity_confirmed_at:
-
"$ref": "#/components/schemas/resource_proposal/properties/identity_confirmed_at"
purchase_order_number:
"$ref": "#/components/schemas/resource_proposal/properties/purchase_order_number"
budget_total_normalized:
"$ref": "#/components/schemas/resource_proposal/properties/budget_total_normalized"
-
identity_confirmation_enabled:
-
"$ref": "#/components/schemas/resource_proposal/properties/identity_confirmation_enabled"
relationships:
type: object
properties:
~
Request body
modified
payment
Schema changes
"$ref": "#/components/schemas/resource_payment/properties/invoice_id"
written_off_on:
"$ref": "#/components/schemas/resource_payment/properties/written_off_on"
+
application/vnd.api+json; ext=bulk:
+
schema:
+
type: object
+
properties:
+
data:
+
type: array
+
items:
+
type: object
+
required:
+
- type
+
- attributes
+
properties:
+
type:
+
enum:
+
- payments
+
type: string
+
attributes:
+
type: object
+
maxItems: 100
-
Get artifacts
GET
Operation
removed
/api/v2/artifacts/get
Schema changes
-
tags:
-
- Artifacts
-
summary: Get artifacts
-
responses:
-
'200':
-
"$ref": "#/components/responses/collection_artifact"
-
parameters:
-
- "$ref": "#/components/parameters/filter_artifact"
-
- "$ref": "#/components/parameters/sort_artifact"
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: artifacts-index
-
-
Create an artifact
POST
Operation
removed
/api/v2/artifacts/post
Schema changes
-
tags:
-
- Artifacts
-
summary: Create an artifact
-
responses:
-
'201':
-
"$ref": "#/components/responses/single_artifact"
-
'422':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
parameters:
-
- "$ref": "#/components/parameters/header_organization"
-
x-internal: true
-
operationId: artifacts-create
-
requestBody:
-
"$ref": "#/components/requestBodies/artifact"
-
-
Deletes an artifact
DELETE
Operation
removed
/api/v2/artifacts/{id}/delete
Schema changes
-
tags:
-
- Artifacts
-
summary: Deletes an artifact
-
responses:
-
'204': {}
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: artifacts-destroy
-
-
Gets an artifact
GET
Operation
removed
/api/v2/artifacts/{id}/get
Schema changes
-
tags:
-
- Artifacts
-
summary: Gets an artifact
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_artifact"
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: artifacts-show
-
-
Update an artifact
PATCH
Operation
removed
/api/v2/artifacts/{id}/patch
Schema changes
-
tags:
-
- Artifacts
-
summary: Update an artifact
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_artifact"
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
x-internal: true
-
operationId: artifacts-update
-
requestBody:
-
"$ref": "#/components/requestBodies/artifact"
-
-
Publishes an artifact
PATCH
Operation
removed
/api/v2/artifacts/{id}/publish/patch
Schema changes
-
tags:
-
- Artifacts
-
summary: Publishes an artifact
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_artifact"
-
'409':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: artifacts-publish-publish
-
-
Unpublishes an artifact
PATCH
Operation
removed
/api/v2/artifacts/{id}/unpublish/patch
Schema changes
-
tags:
-
- Artifacts
-
summary: Unpublishes an artifact
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_artifact"
-
'409':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: artifacts-unpublish-unpublish
-
-
Gets a public artifact
GET
Operation
removed
/api/v2/public/artifacts/{uuid}/get
Schema changes
-
tags:
-
- Artifacts
-
summary: Gets a public artifact
-
security: []
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_artifact"
-
'404': {}
-
parameters:
-
- in: path
-
name: uuid
-
schema:
-
type: string
-
required: true
-
operationId: public-artifacts-show
-
-
Authenticates access to a public artifact attachment
GET
Operation
removed
/api/v2/public/artifacts/{uuid}/attachments/{id}/auth/get
Schema changes
-
tags:
-
- Artifacts
-
summary: Authenticates access to a public artifact attachment
-
security: []
-
responses:
-
'200': {}
-
'404': {}
-
parameters:
-
- in: path
-
name: uuid
-
schema:
-
type: string
-
required: true
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
operationId: public-artifacts-attachments-auth
-
-
Get deal contacts
GET
Operation
removed
/api/v2/deal_contacts/get
Schema changes
-
tags:
-
- Deal Contacts
-
summary: Get deal contacts
-
responses:
-
'200':
-
"$ref": "#/components/responses/collection_deal_contact"
-
parameters:
-
- "$ref": "#/components/parameters/filter_deal_contact"
-
- "$ref": "#/components/parameters/header_organization"
-
x-internal: true
-
operationId: deal_contacts-index
-
-
Create a deal contact
POST
Operation
removed
/api/v2/deal_contacts/post
Schema changes
-
tags:
-
- Deal Contacts
-
summary: Create a deal contact
-
responses:
-
'201':
-
"$ref": "#/components/responses/single_deal_contact"
-
'422':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
parameters:
-
- "$ref": "#/components/parameters/header_organization"
-
x-internal: true
-
operationId: deal_contacts-create
-
requestBody:
-
"$ref": "#/components/requestBodies/deal_contact"
-
-
Deletes a deal contact
DELETE
Operation
removed
/api/v2/deal_contacts/{id}/delete
Schema changes
-
tags:
-
- Deal Contacts
-
summary: Deletes a deal contact
-
responses:
-
'204': {}
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
x-internal: true
-
operationId: deal_contacts-destroy
-
-
Update deal contacts
PATCH
Operation
removed
/api/v2/deal_contacts/patch
Schema changes
-
tags:
-
- Deal Contacts - Bulk
-
summary: Update deal contacts
-
responses:
-
'200':
-
"$ref": "#/components/responses/collection_deal_contact"
-
'422':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
parameters:
-
- "$ref": "#/components/parameters/header_organization"
-
x-internal: true
-
operationId: deal_contacts-update-bulk
-
requestBody:
-
"$ref": "#/components/requestBodies/deal_contact_bulk_update"
-
-
Accept a public proposal
PATCH
Operation
removed
/api/v2/public/proposals/{uuid}/accept/patch
Schema changes
-
tags:
-
- Proposals
-
summary: Accept a public proposal
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_public_proposal"
-
'404':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
'409':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
'422':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
'429':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
parameters:
-
- in: path
-
name: uuid
-
schema:
-
type: string
-
required: true
-
operationId: public-proposals-accept
-
requestBody:
-
"$ref": "#/components/requestBodies/public_proposal_accept"
-
-
Confirm identity for a public proposal
PATCH
Operation
removed
/api/v2/public/proposals/{uuid}/confirm_identity/patch
Schema changes
-
tags:
-
- Proposals
-
summary: Confirm identity for a public proposal
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_public_proposal"
-
'404':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
'409':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
'410':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
parameters:
-
- in: path
-
name: uuid
-
schema:
-
type: string
-
required: true
-
operationId: public-proposals-confirm_identity
-
requestBody:
-
"$ref": "#/components/requestBodies/proposal_identity_confirmation"
-
x-feature-flags:
-
- proposalVersionTwo
-
August 13, 2026
4 changes
4 changes
click to expand
~
Schema
modified
filter_project_relevancy_report
Schema changes
not_contain:
"$ref": "#/components/schemas/resource_project_relevancy_report/properties/heuristic_type"
- "$ref": "#/components/schemas/resource_project_relevancy_report/properties/heuristic_type"
+
activity_period_end:
+
"$ref": "#/components/schemas/resource_project_relevancy_report/properties/activity_period_end"
+
activity_period_start:
+
"$ref": "#/components/schemas/resource_project_relevancy_report/properties/activity_period_start"
time_trackable_on_date:
"$ref": "#/components/schemas/resource_project_relevancy_report/properties/time_trackable_on_date"
time_tracked_period_end:
~
Schema
modified
resource_deal
Schema changes
- filter
x-feature-flags:
- dealMandatoryTimeEntryNote
+
- dealMandatoryTimeEntryTask
automatic_invoicing_rule:
title: Automatic Invoicing Rule
x-used-in:
~
Schema
modified
resource_project_relevancy_report
Schema changes
title: Time Tracked Score
x-used-in:
- serializer
+
activity_period_end:
+
type: string
+
title: Activity Period End
+
format: date
+
x-used-in:
+
- filter
+
activity_period_start:
+
type: string
+
title: Activity Period Start
+
format: date
+
x-used-in:
+
- filter
pinned_services_score:
type: integer
title: Pinned Services Score
~
Schema
modified
resource_deal
Schema changes
- serializer
- form
- filter
-
x-feature-flags:
-
- dealMandatoryTimeEntryNote
automatic_invoicing_rule:
title: Automatic Invoicing Rule
x-used-in:
August 12, 2026
1 change
1 change
click to expand
~
Schema
modified
resource_approval_status
Schema changes
title: Approver Group Key
x-used-in:
- serializer
-
x-feature-flags:
-
- pmDynamicApproverOnAbsences
approval_workflow_id:
type: integer
title: Approval Workflow
August 11, 2026
1 change
1 change
click to expand
~
Schema
modified
resource_deal
Schema changes
- filter
x-feature-flags:
- dealMandatoryTimeEntryNote
-
- dealMandatoryTimeEntryTask
automatic_invoicing_rule:
title: Automatic Invoicing Rule
x-used-in:
August 10, 2026
29 changes
29 changes
click to expand
+
Group
added
Deal Contacts
Schema changes
+
name: Deal Contacts
+
x-resource: resource_deal_contact
+
+
Group
added
Deal Contacts - Bulk
Schema changes
+
name: Deal Contacts - Bulk
+
x-resource: resource_deal_contact
+
-
Group
removed
Artifacts
Schema changes
-
name: Artifacts
-
x-resource: resource_artifact
-
+
Request body
added
deal_contact_bulk_update
Schema changes
+
content:
+
application/vnd.api+json; ext=bulk:
+
schema:
+
type: object
+
properties:
+
data:
+
type: array
+
items:
+
type: object
+
required:
+
- type
+
- id
+
properties:
+
id:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/id"
+
type:
+
enum:
+
- deal_contacts
+
type: string
+
attributes:
+
type: object
+
properties:
+
position:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
+
+
Request body
added
deal_contact
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
deal_id:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
+
position:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
+
person_id:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
+
+
Response
added
collection_deal_contact
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: array
+
items:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
position:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
+
relationships:
+
type: object
+
properties:
+
deal:
+
"$ref": "#/components/schemas/_single_relationship"
+
person:
+
"$ref": "#/components/schemas/_single_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
single_deal_contact
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
position:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
+
relationships:
+
type: object
+
properties:
+
deal:
+
"$ref": "#/components/schemas/_single_relationship"
+
person:
+
"$ref": "#/components/schemas/_single_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
~
Response
modified
collection_time_entry
Schema changes
approved:
"$ref": "#/components/schemas/resource_time_entry/properties/approved"
currency:
-
"$ref": "#/components/schemas/resource_time_entry/properties/currency"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/currency"
+
- type: 'null'
invoiced:
"$ref": "#/components/schemas/resource_time_entry/properties/invoiced"
overhead:
...
created_at:
"$ref": "#/components/schemas/resource_time_entry/properties/created_at"
started_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/started_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/started_at"
+
- type: 'null'
updated_at:
"$ref": "#/components/schemas/resource_time_entry/properties/updated_at"
approved_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/approved_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/approved_at"
+
- type: 'null'
rejected_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/rejected_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/rejected_at"
+
- type: 'null'
cost_default:
"$ref": "#/components/schemas/resource_time_entry/properties/cost_default"
billable_time:
"$ref": "#/components/schemas/resource_time_entry/properties/billable_time"
jira_issue_id:
-
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id"
+
- type: 'null'
overhead_cost:
"$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost"
cost_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/cost_normalized"
jira_worklog_id:
-
"$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id"
+
- type: 'null'
recognized_time:
"$ref": "#/components/schemas/resource_time_entry/properties/recognized_time"
rejected_reason:
-
"$ref": "#/components/schemas/resource_time_entry/properties/rejected_reason"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/rejected_reason"
+
- type: 'null'
track_method_id:
"$ref": "#/components/schemas/resource_time_entry/properties/track_method_id"
currency_default:
"$ref": "#/components/schemas/resource_time_entry/properties/currency_default"
last_activity_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at"
+
- type: 'null'
timer_started_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/timer_started_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/timer_started_at"
+
- type: 'null'
timer_stopped_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/timer_stopped_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/timer_stopped_at"
+
- type: 'null'
calendar_event_id:
-
"$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id"
+
- type: 'null'
jira_issue_status:
-
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status"
+
- type: 'null'
jira_organization:
-
"$ref": "#/components/schemas/resource_time_entry/properties/jira_organization"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_organization"
+
- type: 'null'
work_cost_default:
"$ref": "#/components/schemas/resource_time_entry/properties/work_cost_default"
jira_issue_summary:
-
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary"
+
- type: 'null'
currency_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/currency_normalized"
work_cost_normalized:
...
internal_overhead_cost:
"$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost"
invoice_attribution_id:
-
"$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id"
+
- type: 'null'
overhead_cost_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost_normalized"
facility_overhead_cost_default:
~
Response
modified
single_time_entry
Schema changes
approved:
"$ref": "#/components/schemas/resource_time_entry/properties/approved"
currency:
-
"$ref": "#/components/schemas/resource_time_entry/properties/currency"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/currency"
+
- type: 'null'
invoiced:
"$ref": "#/components/schemas/resource_time_entry/properties/invoiced"
overhead:
...
created_at:
"$ref": "#/components/schemas/resource_time_entry/properties/created_at"
started_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/started_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/started_at"
+
- type: 'null'
updated_at:
"$ref": "#/components/schemas/resource_time_entry/properties/updated_at"
approved_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/approved_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/approved_at"
+
- type: 'null'
rejected_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/rejected_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/rejected_at"
+
- type: 'null'
cost_default:
"$ref": "#/components/schemas/resource_time_entry/properties/cost_default"
billable_time:
"$ref": "#/components/schemas/resource_time_entry/properties/billable_time"
jira_issue_id:
-
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_id"
+
- type: 'null'
overhead_cost:
"$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost"
cost_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/cost_normalized"
jira_worklog_id:
-
"$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_worklog_id"
+
- type: 'null'
recognized_time:
"$ref": "#/components/schemas/resource_time_entry/properties/recognized_time"
rejected_reason:
-
"$ref": "#/components/schemas/resource_time_entry/properties/rejected_reason"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/rejected_reason"
+
- type: 'null'
track_method_id:
"$ref": "#/components/schemas/resource_time_entry/properties/track_method_id"
currency_default:
"$ref": "#/components/schemas/resource_time_entry/properties/currency_default"
last_activity_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/last_activity_at"
+
- type: 'null'
timer_started_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/timer_started_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/timer_started_at"
+
- type: 'null'
timer_stopped_at:
-
"$ref": "#/components/schemas/resource_time_entry/properties/timer_stopped_at"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/timer_stopped_at"
+
- type: 'null'
calendar_event_id:
-
"$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/calendar_event_id"
+
- type: 'null'
jira_issue_status:
-
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_status"
+
- type: 'null'
jira_organization:
-
"$ref": "#/components/schemas/resource_time_entry/properties/jira_organization"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_organization"
+
- type: 'null'
work_cost_default:
"$ref": "#/components/schemas/resource_time_entry/properties/work_cost_default"
jira_issue_summary:
-
"$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/jira_issue_summary"
+
- type: 'null'
currency_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/currency_normalized"
work_cost_normalized:
...
internal_overhead_cost:
"$ref": "#/components/schemas/resource_time_entry/properties/internal_overhead_cost"
invoice_attribution_id:
-
"$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id"
+
anyOf:
+
- "$ref": "#/components/schemas/resource_time_entry/properties/invoice_attribution_id"
+
- type: 'null'
overhead_cost_normalized:
"$ref": "#/components/schemas/resource_time_entry/properties/overhead_cost_normalized"
facility_overhead_cost_default:
+
Parameter
added
filter_deal_contact
Schema changes
+
in: query
+
name: filter
+
style: deepObject
+
schema:
+
"$ref": "#/components/schemas/_filter_root_deal_contact"
+
required: false
+
+
Schema
added
resource_deal_contact
Schema changes
+
type: object
+
title: Deal contact Resource
+
required: false
+
properties:
+
id:
+
type: integer
+
title: Id
+
x-used-in:
+
- filter
+
deal:
+
title: Deal
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_deal
+
person:
+
title: Person
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_person
+
deal_id:
+
type: integer
+
title: Deal
+
x-used-in:
+
- form
+
- filter
+
position:
+
type: integer
+
title: Position
+
x-used-in:
+
- serializer
+
- form
+
- filter
+
person_id:
+
type: integer
+
title: Person
+
x-used-in:
+
- form
+
- filter
+
+
Schema
added
filter_deal_contact
Schema changes
+
type: object
+
title: Filter deal contact
+
required: false
+
properties:
+
id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/id"
+
contains:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/id"
+
- "$ref": "#/components/schemas/resource_deal_contact/properties/id"
+
deal_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
+
contains:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
+
- "$ref": "#/components/schemas/resource_deal_contact/properties/deal_id"
+
position:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
+
not_eq:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
+
contains:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
+
not_contain:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/position"
+
- "$ref": "#/components/schemas/resource_deal_contact/properties/position"
+
person_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
+
contains:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
+
- "$ref": "#/components/schemas/resource_deal_contact/properties/person_id"
+
x-internal: true
+
patternProperties: {}
+
+
Schema
added
_filter_root_deal_contact
Schema changes
+
oneOf:
+
- type: object
+
title: Advanced filters
+
required:
+
- "$op"
+
properties:
+
"$op":
+
enum:
+
- or
+
- and
+
type: string
+
x-enums:
+
or: OR
+
and: AND
+
patternProperties:
+
"^[0-9]+$":
+
"$ref": "#/components/schemas/_filter_root_deal_contact"
+
- "$ref": "#/components/schemas/filter_deal_contact"
+
required: false
+
x-internal: true
+
-
Schema
removed
_filter_root_artifact
Schema changes
-
oneOf:
-
- type: object
-
title: Advanced filters
-
required:
-
- "$op"
-
properties:
-
"$op":
-
enum:
-
- or
-
- and
-
type: string
-
x-enums:
-
or: OR
-
and: AND
-
patternProperties:
-
"^[0-9]+$":
-
"$ref": "#/components/schemas/_filter_root_artifact"
-
- "$ref": "#/components/schemas/filter_artifact"
-
required: false
-
x-internal: true
-
-
Schema
removed
resource_artifact
Schema changes
-
type: object
-
title: Artifact Resource
-
required: false
-
properties:
-
id:
-
type: integer
-
x-used-in:
-
- filter
-
name:
-
type: string
-
title: Name
-
x-used-in:
-
- serializer
-
- form
-
created_at:
-
type: string
-
title: Created At
-
format: date-time
-
x-used-in:
-
- serializer
-
creator_id:
-
type: integer
-
x-used-in:
-
- filter
-
updated_at:
-
type: string
-
title: Updated At
-
format: date-time
-
x-used-in:
-
- serializer
-
description:
-
type: string
-
title: Description
-
x-used-in:
-
- serializer
-
- form
-
public_uuid:
-
type: string
-
title: Public Uuid
-
x-used-in:
-
- serializer
-
public_access:
-
type: boolean
-
title: Public Access
-
x-used-in:
-
- serializer
-
-
Schema
removed
filter_artifact
Schema changes
-
type: object
-
title: Filter artifact
-
required: false
-
properties:
-
id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/id"
-
contains:
-
"$ref": "#/components/schemas/resource_artifact/properties/id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_artifact/properties/id"
-
- "$ref": "#/components/schemas/resource_artifact/properties/id"
-
name:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/name"
-
not_eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/name"
-
contains:
-
"$ref": "#/components/schemas/resource_artifact/properties/name"
-
not_contain:
-
"$ref": "#/components/schemas/resource_artifact/properties/name"
-
- "$ref": "#/components/schemas/resource_artifact/properties/name"
-
created_at:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
-
not_eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
-
contains:
-
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
-
not_contain:
-
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
-
- "$ref": "#/components/schemas/resource_artifact/properties/created_at"
-
creator_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
-
contains:
-
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
-
- "$ref": "#/components/schemas/resource_artifact/properties/creator_id"
-
public_access:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/public_access"
-
not_eq:
-
"$ref": "#/components/schemas/resource_artifact/properties/public_access"
-
- "$ref": "#/components/schemas/resource_artifact/properties/public_access"
-
x-internal: true
-
patternProperties: {}
-
-
Get artifacts
GET
Operation
removed
/api/v2/artifacts/get
Schema changes
-
tags:
-
- Artifacts
-
summary: Get artifacts
-
responses:
-
'200':
-
"$ref": "#/components/responses/collection_artifact"
-
parameters:
-
- "$ref": "#/components/parameters/filter_artifact"
-
- "$ref": "#/components/parameters/sort_artifact"
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: artifacts-index
-
-
Create an artifact
POST
Operation
removed
/api/v2/artifacts/post
Schema changes
-
tags:
-
- Artifacts
-
summary: Create an artifact
-
responses:
-
'201':
-
"$ref": "#/components/responses/single_artifact"
-
'422':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
parameters:
-
- "$ref": "#/components/parameters/header_organization"
-
x-internal: true
-
operationId: artifacts-create
-
requestBody:
-
"$ref": "#/components/requestBodies/artifact"
-
-
Deletes an artifact
DELETE
Operation
removed
/api/v2/artifacts/{id}/delete
Schema changes
-
tags:
-
- Artifacts
-
summary: Deletes an artifact
-
responses:
-
'204': {}
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: artifacts-destroy
-
-
Gets an artifact
GET
Operation
removed
/api/v2/artifacts/{id}/get
Schema changes
-
tags:
-
- Artifacts
-
summary: Gets an artifact
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_artifact"
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: artifacts-show
-
-
Update an artifact
PATCH
Operation
removed
/api/v2/artifacts/{id}/patch
Schema changes
-
tags:
-
- Artifacts
-
summary: Update an artifact
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_artifact"
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
x-internal: true
-
operationId: artifacts-update
-
requestBody:
-
"$ref": "#/components/requestBodies/artifact"
-
-
Publishes an artifact
PATCH
Operation
removed
/api/v2/artifacts/{id}/publish/patch
Schema changes
-
tags:
-
- Artifacts
-
summary: Publishes an artifact
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_artifact"
-
'409':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: artifacts-publish-publish
-
-
Unpublishes an artifact
PATCH
Operation
removed
/api/v2/artifacts/{id}/unpublish/patch
Schema changes
-
tags:
-
- Artifacts
-
summary: Unpublishes an artifact
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_artifact"
-
'409':
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: artifacts-unpublish-unpublish
-
-
Gets a public artifact
GET
Operation
removed
/api/v2/public/artifacts/{uuid}/get
Schema changes
-
tags:
-
- Artifacts
-
summary: Gets a public artifact
-
security: []
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_artifact"
-
'404': {}
-
parameters:
-
- in: path
-
name: uuid
-
schema:
-
type: string
-
required: true
-
operationId: public-artifacts-show
-
-
Authenticates access to a public artifact attachment
GET
Operation
removed
/api/v2/public/artifacts/{uuid}/attachments/{id}/auth/get
Schema changes
-
tags:
-
- Artifacts
-
summary: Authenticates access to a public artifact attachment
-
security: []
-
responses:
-
'200': {}
-
'404': {}
-
parameters:
-
- in: path
-
name: uuid
-
schema:
-
type: string
-
required: true
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
operationId: public-artifacts-attachments-auth
-
+
Get deal contacts
GET
Operation
added
/api/v2/deal_contacts/get
Schema changes
+
tags:
+
- Deal Contacts
+
summary: Get deal contacts
+
responses:
+
'200':
+
"$ref": "#/components/responses/collection_deal_contact"
+
parameters:
+
- "$ref": "#/components/parameters/filter_deal_contact"
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: deal_contacts-index
+
+
Create a deal contact
POST
Operation
added
/api/v2/deal_contacts/post
Schema changes
+
tags:
+
- Deal Contacts
+
summary: Create a deal contact
+
responses:
+
'201':
+
"$ref": "#/components/responses/single_deal_contact"
+
'422':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
parameters:
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: deal_contacts-create
+
requestBody:
+
"$ref": "#/components/requestBodies/deal_contact"
+
+
Deletes a deal contact
DELETE
Operation
added
/api/v2/deal_contacts/{id}/delete
Schema changes
+
tags:
+
- Deal Contacts
+
summary: Deletes a deal contact
+
responses:
+
'204': {}
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: deal_contacts-destroy
+
+
Update deal contacts
PATCH
Operation
added
/api/v2/deal_contacts/patch
Schema changes
+
tags:
+
- Deal Contacts - Bulk
+
summary: Update deal contacts
+
responses:
+
'200':
+
"$ref": "#/components/responses/collection_deal_contact"
+
'422':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
parameters:
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: deal_contacts-update-bulk
+
requestBody:
+
"$ref": "#/components/requestBodies/deal_contact_bulk_update"
+
August 06, 2026
33 changes
33 changes
click to expand
+
Schema
added
resource_artifact
Schema changes
+
type: object
+
title: Artifact Resource
+
required: false
+
properties:
+
id:
+
type: integer
+
x-used-in:
+
- filter
+
name:
+
type: string
+
title: Name
+
x-used-in:
+
- serializer
+
- form
+
created_at:
+
type: string
+
title: Created At
+
format: date-time
+
x-used-in:
+
- serializer
+
creator_id:
+
type: integer
+
x-used-in:
+
- filter
+
updated_at:
+
type: string
+
title: Updated At
+
format: date-time
+
x-used-in:
+
- serializer
+
description:
+
type: string
+
title: Description
+
x-used-in:
+
- serializer
+
- form
+
public_uuid:
+
type: string
+
title: Public Uuid
+
x-used-in:
+
- serializer
+
public_access:
+
type: boolean
+
title: Public Access
+
x-used-in:
+
- serializer
+
+
Schema
added
_filter_root_artifact
Schema changes
+
oneOf:
+
- type: object
+
title: Advanced filters
+
required:
+
- "$op"
+
properties:
+
"$op":
+
enum:
+
- or
+
- and
+
type: string
+
x-enums:
+
or: OR
+
and: AND
+
patternProperties:
+
"^[0-9]+$":
+
"$ref": "#/components/schemas/_filter_root_artifact"
+
- "$ref": "#/components/schemas/filter_artifact"
+
required: false
+
x-internal: true
+
+
Schema
added
filter_artifact
Schema changes
+
type: object
+
title: Filter artifact
+
required: false
+
properties:
+
id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_artifact/properties/id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_artifact/properties/id"
+
contains:
+
"$ref": "#/components/schemas/resource_artifact/properties/id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_artifact/properties/id"
+
- "$ref": "#/components/schemas/resource_artifact/properties/id"
+
name:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_artifact/properties/name"
+
not_eq:
+
"$ref": "#/components/schemas/resource_artifact/properties/name"
+
contains:
+
"$ref": "#/components/schemas/resource_artifact/properties/name"
+
not_contain:
+
"$ref": "#/components/schemas/resource_artifact/properties/name"
+
- "$ref": "#/components/schemas/resource_artifact/properties/name"
+
created_at:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
+
not_eq:
+
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
+
contains:
+
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
+
not_contain:
+
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
+
- "$ref": "#/components/schemas/resource_artifact/properties/created_at"
+
creator_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
+
contains:
+
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_artifact/properties/creator_id"
+
- "$ref": "#/components/schemas/resource_artifact/properties/creator_id"
+
public_access:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_artifact/properties/public_access"
+
not_eq:
+
"$ref": "#/components/schemas/resource_artifact/properties/public_access"
+
- "$ref": "#/components/schemas/resource_artifact/properties/public_access"
+
x-internal: true
+
patternProperties: {}
+
+
Response
added
collection_artifact
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: array
+
items:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_artifact/properties/name"
+
created_at:
+
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
+
updated_at:
+
"$ref": "#/components/schemas/resource_artifact/properties/updated_at"
+
description:
+
"$ref": "#/components/schemas/resource_artifact/properties/description"
+
public_uuid:
+
"$ref": "#/components/schemas/resource_artifact/properties/public_uuid"
+
public_access:
+
"$ref": "#/components/schemas/resource_artifact/properties/public_access"
+
relationships:
+
type: object
+
properties:
+
creator:
+
"$ref": "#/components/schemas/_single_relationship"
+
attachment:
+
"$ref": "#/components/schemas/_single_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
single_artifact
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_artifact/properties/name"
+
created_at:
+
"$ref": "#/components/schemas/resource_artifact/properties/created_at"
+
updated_at:
+
"$ref": "#/components/schemas/resource_artifact/properties/updated_at"
+
description:
+
"$ref": "#/components/schemas/resource_artifact/properties/description"
+
public_uuid:
+
"$ref": "#/components/schemas/resource_artifact/properties/public_uuid"
+
public_access:
+
"$ref": "#/components/schemas/resource_artifact/properties/public_access"
+
relationships:
+
type: object
+
properties:
+
creator:
+
"$ref": "#/components/schemas/_single_relationship"
+
attachment:
+
"$ref": "#/components/schemas/_single_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Parameter
added
sort_artifact
Schema changes
+
in: query
+
name: sort
+
style: form
+
schema:
+
type: array
+
items:
+
enum:
+
- created_at
+
- "-created_at"
+
- name
+
- "-name"
+
- updated_at
+
- "-updated_at"
+
type: string
+
title: Sort artifact
+
explode: false
+
required: false
+
+
Parameter
added
filter_artifact
Schema changes
+
in: query
+
name: filter
+
style: deepObject
+
schema:
+
"$ref": "#/components/schemas/_filter_root_artifact"
+
required: false
+
+
Request body
added
artifact
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_artifact/properties/name"
+
description:
+
"$ref": "#/components/schemas/resource_artifact/properties/description"
+
+
Group
added
Artifacts
Schema changes
+
name: Artifacts
+
x-resource: resource_artifact
+
+
Get artifacts
GET
Operation
added
/api/v2/artifacts/get
Schema changes
+
tags:
+
- Artifacts
+
summary: Get artifacts
+
responses:
+
'200':
+
"$ref": "#/components/responses/collection_artifact"
+
parameters:
+
- "$ref": "#/components/parameters/filter_artifact"
+
- "$ref": "#/components/parameters/sort_artifact"
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: artifacts-index
+
+
Create an artifact
POST
Response
added
/api/v2/artifacts/post/responses/422
Schema changes
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
+
Create an artifact
POST
Operation
added
/api/v2/artifacts/post
Schema changes
+
tags:
+
- Artifacts
+
summary: Create an artifact
+
responses:
+
'201':
+
"$ref": "#/components/responses/single_artifact"
+
'422':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
parameters:
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: artifacts-create
+
requestBody:
+
"$ref": "#/components/requestBodies/artifact"
+
+
Deletes an artifact
DELETE
Parameter
added
/api/v2/artifacts/{id}/delete/parameters/id
Schema changes
+
in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
+
Deletes an artifact
DELETE
Operation
added
/api/v2/artifacts/{id}/delete
Schema changes
+
tags:
+
- Artifacts
+
summary: Deletes an artifact
+
responses:
+
'204': {}
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: artifacts-destroy
+
+
Deletes an artifact
DELETE
Response
added
/api/v2/artifacts/{id}/delete/responses/204
Schema changes
+
--- {}
+
+
Gets an artifact
GET
Operation
added
/api/v2/artifacts/{id}/get
Schema changes
+
tags:
+
- Artifacts
+
summary: Gets an artifact
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_artifact"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: artifacts-show
+
+
Gets an artifact
GET
Parameter
added
/api/v2/artifacts/{id}/get/parameters/id
Schema changes
+
in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
+
Update an artifact
PATCH
Parameter
added
/api/v2/artifacts/{id}/patch/parameters/id
Schema changes
+
in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
+
Update an artifact
PATCH
Operation
added
/api/v2/artifacts/{id}/patch
Schema changes
+
tags:
+
- Artifacts
+
summary: Update an artifact
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_artifact"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: artifacts-update
+
requestBody:
+
"$ref": "#/components/requestBodies/artifact"
+
+
Publishes an artifact
PATCH
Response
added
/api/v2/artifacts/{id}/publish/patch/responses/409
Schema changes
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
+
Publishes an artifact
PATCH
Operation
added
/api/v2/artifacts/{id}/publish/patch
Schema changes
+
tags:
+
- Artifacts
+
summary: Publishes an artifact
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_artifact"
+
'409':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: artifacts-publish-publish
+
+
Publishes an artifact
PATCH
Parameter
added
/api/v2/artifacts/{id}/publish/patch/parameters/id
Schema changes
+
in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
+
Unpublishes an artifact
PATCH
Response
added
/api/v2/artifacts/{id}/unpublish/patch/responses/409
Schema changes
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
+
Unpublishes an artifact
PATCH
Parameter
added
/api/v2/artifacts/{id}/unpublish/patch/parameters/id
Schema changes
+
in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
+
Unpublishes an artifact
PATCH
Operation
added
/api/v2/artifacts/{id}/unpublish/patch
Schema changes
+
tags:
+
- Artifacts
+
summary: Unpublishes an artifact
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_artifact"
+
'409':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: artifacts-unpublish-unpublish
+
+
Gets a public artifact
GET
Parameter
added
/api/v2/public/artifacts/{uuid}/get/parameters/uuid
Schema changes
+
in: path
+
name: uuid
+
schema:
+
type: string
+
required: true
+
+
Gets a public artifact
GET
Operation
added
/api/v2/public/artifacts/{uuid}/get
Schema changes
+
tags:
+
- Artifacts
+
summary: Gets a public artifact
+
security: []
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_artifact"
+
'404': {}
+
parameters:
+
- in: path
+
name: uuid
+
schema:
+
type: string
+
required: true
+
operationId: public-artifacts-show
+
+
Gets a public artifact
GET
Response
added
/api/v2/public/artifacts/{uuid}/get/responses/404
Schema changes
+
--- {}
+
+
Authenticates access to a public artifact attachment
GET
Operation
added
/api/v2/public/artifacts/{uuid}/attachments/{id}/auth/get
Schema changes
+
tags:
+
- Artifacts
+
summary: Authenticates access to a public artifact attachment
+
security: []
+
responses:
+
'200': {}
+
'404': {}
+
parameters:
+
- in: path
+
name: uuid
+
schema:
+
type: string
+
required: true
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
operationId: public-artifacts-attachments-auth
+
+
Authenticates access to a public artifact attachment
GET
Response
added
/api/v2/public/artifacts/{uuid}/attachments/{id}/auth/get/responses/404
Schema changes
+
--- {}
+
+
Authenticates access to a public artifact attachment
GET
Response
added
/api/v2/public/artifacts/{uuid}/attachments/{id}/auth/get/responses/200
Schema changes
+
--- {}
+
+
Authenticates access to a public artifact attachment
GET
Parameter
added
/api/v2/public/artifacts/{uuid}/attachments/{id}/auth/get/parameters/id
Schema changes
+
in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
+
Authenticates access to a public artifact attachment
GET
Parameter
added
/api/v2/public/artifacts/{uuid}/attachments/{id}/auth/get/parameters/uuid
Schema changes
+
in: path
+
name: uuid
+
schema:
+
type: string
+
required: true
+
Previous
Next
Showing page
1
of
21
(
146
dates with changes)
Previous
1
2
3
...
21
Next