Open main menu
API Reference
Guides
Download Spec
View Changelog
Loading groups...
API Changelog: API Documentation
Previous
Next
Showing page
1
of
16
(
112
dates with changes)
Previous
1
2
3
...
16
Next
June 08, 2026
5 changes
5 changes
click to expand
~
Schema
modified
filter_agent
Schema changes
not_contain:
"$ref": "#/components/schemas/resource_agent/properties/title"
- "$ref": "#/components/schemas/resource_agent/properties/title"
-
tools:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_agent/properties/tools"
-
not_eq:
-
"$ref": "#/components/schemas/resource_agent/properties/tools"
-
contains:
-
"$ref": "#/components/schemas/resource_agent/properties/tools"
-
not_contain:
-
"$ref": "#/components/schemas/resource_agent/properties/tools"
-
- "$ref": "#/components/schemas/resource_agent/properties/tools"
status:
oneOf:
- type: object
~
Schema
modified
resource_agent
Schema changes
- form
- filter
- sorter
-
tools:
-
type: array
-
items:
-
type: string
-
title: Tools
-
x-used-in:
-
- filter
person:
title: Person
x-used-in:
-
Schema
removed
resource_developer_portal_user
Schema changes
-
type: object
-
title: Developer Portal User Resource
-
required: false
-
properties:
-
name:
-
type: string
-
title: Name
-
x-used-in:
-
- serializer
-
sysadmin:
-
type: boolean
-
title: Sysadmin
-
x-used-in:
-
- serializer
-
feature_flags:
-
type: array
-
items:
-
type: string
-
title: Feature Flags
-
x-used-in:
-
- serializer
-
sysadmin_permissions:
-
type: array
-
items:
-
type: string
-
title: Sysadmin Permissions
-
x-used-in:
-
- serializer
-
x-internal: true
-
-
Group
removed
Developer Portal
Schema changes
-
name: Developer Portal
-
x-resource: resource_developer_portal_user
-
-
Current developer portal user
GET
Operation
removed
/api/v2/developer_portal_user/get
Schema changes
-
tags:
-
- Developer Portal
-
summary: Current developer portal user
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_developer_portal_user"
-
x-internal: true
-
x-resource: resource_developer_portal_user
-
operationId: developer-portal-user-show
-
June 03, 2026
4 changes
4 changes
click to expand
+
Group
added
Developer Portal
Schema changes
+
name: Developer Portal
+
x-resource: resource_developer_portal_user
+
+
Schema
added
resource_developer_portal_user
Schema changes
+
type: object
+
title: Developer Portal User Resource
+
required: false
+
properties:
+
name:
+
type: string
+
title: Name
+
x-used-in:
+
- serializer
+
sysadmin:
+
type: boolean
+
title: Sysadmin
+
x-used-in:
+
- serializer
+
feature_flags:
+
type: array
+
items:
+
type: string
+
title: Feature Flags
+
x-used-in:
+
- serializer
+
sysadmin_permissions:
+
type: array
+
items:
+
type: string
+
title: Sysadmin Permissions
+
x-used-in:
+
- serializer
+
x-internal: true
+
+
Response
added
single_developer_portal_user
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_developer_portal_user/properties/name"
+
sysadmin:
+
"$ref": "#/components/schemas/resource_developer_portal_user/properties/sysadmin"
+
feature_flags:
+
"$ref": "#/components/schemas/resource_developer_portal_user/properties/feature_flags"
+
sysadmin_permissions:
+
"$ref": "#/components/schemas/resource_developer_portal_user/properties/sysadmin_permissions"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Current developer portal user
GET
Operation
added
/api/v2/developer_portal_user/get
Schema changes
+
tags:
+
- Developer Portal
+
summary: Current developer portal user
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_developer_portal_user"
+
x-internal: true
+
x-resource: resource_developer_portal_user
+
operationId: developer-portal-user-show
+
June 02, 2026
51 changes
51 changes
click to expand
~
Response
modified
single_deal
Schema changes
relationships:
type: object
properties:
-
import:
-
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
contact:
~
Response
modified
collection_company
Schema changes
relationships:
type: object
properties:
-
import:
-
"$ref": "#/components/schemas/_single_relationship"
organization:
"$ref": "#/components/schemas/_single_relationship"
parent_company:
~
Response
modified
single_project
Schema changes
relationships:
type: object
properties:
-
import:
-
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
workflow:
~
Response
modified
single_service
Schema changes
properties:
deal:
"$ref": "#/components/schemas/_single_relationship"
-
import:
-
"$ref": "#/components/schemas/_single_relationship"
person:
"$ref": "#/components/schemas/_single_relationship"
section:
~
Response
modified
collection_project
Schema changes
relationships:
type: object
properties:
-
import:
-
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
workflow:
~
Response
modified
collection_person
Schema changes
properties:
teams:
"$ref": "#/components/schemas/_collection_relationship"
-
import:
-
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
manager:
~
Response
modified
collection_service
Schema changes
properties:
deal:
"$ref": "#/components/schemas/_single_relationship"
-
import:
-
"$ref": "#/components/schemas/_single_relationship"
person:
"$ref": "#/components/schemas/_single_relationship"
section:
~
Response
modified
single_company
Schema changes
relationships:
type: object
properties:
-
import:
-
"$ref": "#/components/schemas/_single_relationship"
organization:
"$ref": "#/components/schemas/_single_relationship"
parent_company:
~
Response
modified
collection_deal
Schema changes
relationships:
type: object
properties:
-
import:
-
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
contact:
~
Response
modified
single_person
Schema changes
properties:
teams:
"$ref": "#/components/schemas/_collection_relationship"
-
import:
-
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
manager:
~
Response
modified
single_company
Schema changes
relationships:
type: object
properties:
+
import:
+
"$ref": "#/components/schemas/_single_relationship"
organization:
"$ref": "#/components/schemas/_single_relationship"
parent_company:
~
Response
modified
collection_service
Schema changes
properties:
deal:
"$ref": "#/components/schemas/_single_relationship"
+
import:
+
"$ref": "#/components/schemas/_single_relationship"
person:
"$ref": "#/components/schemas/_single_relationship"
section:
~
Response
modified
single_service
Schema changes
properties:
deal:
"$ref": "#/components/schemas/_single_relationship"
+
import:
+
"$ref": "#/components/schemas/_single_relationship"
person:
"$ref": "#/components/schemas/_single_relationship"
section:
~
Response
modified
single_person
Schema changes
properties:
teams:
"$ref": "#/components/schemas/_collection_relationship"
+
import:
+
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
manager:
~
Response
modified
collection_deal
Schema changes
relationships:
type: object
properties:
+
import:
+
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
contact:
~
Response
modified
single_deal
Schema changes
relationships:
type: object
properties:
+
import:
+
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
contact:
~
Response
modified
single_project
Schema changes
relationships:
type: object
properties:
+
import:
+
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
workflow:
~
Response
modified
collection_person
Schema changes
properties:
teams:
"$ref": "#/components/schemas/_collection_relationship"
+
import:
+
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
manager:
~
Response
modified
collection_company
Schema changes
relationships:
type: object
properties:
+
import:
+
"$ref": "#/components/schemas/_single_relationship"
organization:
"$ref": "#/components/schemas/_single_relationship"
parent_company:
~
Response
modified
collection_project
Schema changes
relationships:
type: object
properties:
+
import:
+
"$ref": "#/components/schemas/_single_relationship"
company:
"$ref": "#/components/schemas/_single_relationship"
workflow:
+
Response
added
single_meilisearch_index
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
drift:
+
"$ref": "#/components/schemas/resource_meilisearch_index/properties/drift"
+
error:
+
"$ref": "#/components/schemas/resource_meilisearch_index/properties/error"
+
status:
+
"$ref": "#/components/schemas/resource_meilisearch_index/properties/status"
+
in_sync:
+
"$ref": "#/components/schemas/resource_meilisearch_index/properties/in_sync"
+
settings:
+
"$ref": "#/components/schemas/resource_meilisearch_index/properties/settings"
+
index_uid:
+
"$ref": "#/components/schemas/resource_meilisearch_index/properties/index_uid"
+
document_count:
+
"$ref": "#/components/schemas/resource_meilisearch_index/properties/document_count"
+
documents_by_type:
+
"$ref": "#/components/schemas/resource_meilisearch_index/properties/documents_by_type"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
collection_meilisearch_document
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: array
+
items:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
pid:
+
"$ref": "#/components/schemas/resource_meilisearch_document/properties/pid"
+
error:
+
"$ref": "#/components/schemas/resource_meilisearch_document/properties/error"
+
status:
+
"$ref": "#/components/schemas/resource_meilisearch_document/properties/status"
+
document:
+
"$ref": "#/components/schemas/resource_meilisearch_document/properties/document"
+
meta:
+
type: object
+
title: Meilisearch Documents Meta
+
properties:
+
count:
+
type: integer
+
error:
+
type: object
+
nullable: true
+
properties:
+
class:
+
type: string
+
message:
+
type: string
+
limit:
+
type: integer
+
total:
+
type: integer
+
nullable: true
+
filter:
+
type: string
+
offset:
+
type: integer
+
status:
+
enum:
+
- available
+
- unavailable
+
type: string
+
index_uid:
+
type: string
+
included:
+
type: array
+
items: {}
+
+
Response
added
single_meilisearch_document
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
pid:
+
"$ref": "#/components/schemas/resource_meilisearch_document/properties/pid"
+
error:
+
"$ref": "#/components/schemas/resource_meilisearch_document/properties/error"
+
status:
+
"$ref": "#/components/schemas/resource_meilisearch_document/properties/status"
+
document:
+
"$ref": "#/components/schemas/resource_meilisearch_document/properties/document"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
single_meilisearch_health
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
error:
+
"$ref": "#/components/schemas/resource_meilisearch_health/properties/error"
+
stats:
+
"$ref": "#/components/schemas/resource_meilisearch_health/properties/stats"
+
status:
+
"$ref": "#/components/schemas/resource_meilisearch_health/properties/status"
+
version:
+
"$ref": "#/components/schemas/resource_meilisearch_health/properties/version"
+
target_url:
+
"$ref": "#/components/schemas/resource_meilisearch_health/properties/target_url"
+
task_queue:
+
"$ref": "#/components/schemas/resource_meilisearch_health/properties/task_queue"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
~
Schema
modified
resource_invoice
Schema changes
- due_upon_receipt
type: string
title: Payment Terms Type
+
x-enums:
+
end_of_month: End of month
+
due_upon_receipt: Due upon receipt
+
days_after_invoice_date: Days after invoice date
nullable: true
x-used-in:
- serializer
-
Schema
removed
resource_import
Schema changes
-
type: object
-
title: Import Resource
-
required: false
-
properties:
-
sample:
-
type: boolean
-
title: Sample
-
x-used-in:
-
- serializer
-
creator:
-
title: Creator
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_person
-
failed_at:
-
type: string
-
title: Failed At
-
format: date-time
-
x-used-in:
-
- serializer
-
creator_id:
-
type: integer
-
title: Creator Id
-
x-used-in:
-
- serializer
-
started_at:
-
type: string
-
title: Started At
-
format: date-time
-
x-used-in:
-
- serializer
-
reverted_at:
-
type: string
-
title: Reverted At
-
format: date-time
-
x-used-in:
-
- serializer
-
processed_at:
-
type: string
-
title: Processed At
-
format: date-time
-
x-used-in:
-
- serializer
-
import_models:
-
type: string
-
title: Import Models
-
x-used-in:
-
- serializer
-
import_type_id:
-
type: integer
-
title: Import Type Id
-
x-used-in:
-
- serializer
-
import_model_id:
-
type: integer
-
title: Import Model Id
-
x-used-in:
-
- serializer
-
~
Schema
modified
resource_expense
Schema changes
enum:
- 1
- 2
-
type:
string
+
type:
integer
title: Allocation Status
x-enums:
'1': Allocated
~
Schema
modified
resource_project
Schema changes
title: Query
x-used-in:
- filter
-
import:
-
title: Import
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_import
number:
type: string
title: Number
~
Schema
modified
resource_invoice_template
Schema changes
- due_upon_receipt
type: string
title: Payment Terms Type
+
x-enums:
+
end_of_month: End of month
+
due_upon_receipt: Due upon receipt
+
days_after_invoice_date: Days after invoice date
nullable: true
x-used-in:
- serializer
~
Schema
modified
resource_company
Schema changes
x-used-in:
- serializer
- form
-
import:
-
title: Import
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_import
status:
enum:
- 1
...
- due_upon_receipt
type: string
title: Payment Terms Type
+
x-enums:
+
end_of_month: End of month
+
due_upon_receipt: Due upon receipt
+
days_after_invoice_date: Days after invoice date
nullable: true
x-used-in:
- serializer
~
Schema
modified
resource_person
Schema changes
- form
- filter
- sorter
-
import:
-
title: Import
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_import
status:
enum:
- 1
~
Schema
modified
resource_deal
Schema changes
title: Footer
x-used-in:
- serializer
-
import:
-
title: Import
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_import
number:
type: string
title: Number
~
Schema
modified
resource_organization
Schema changes
- due_upon_receipt
type: string
title: Payment Terms Type
+
x-enums:
+
end_of_month: End of month
+
due_upon_receipt: Due upon receipt
+
days_after_invoice_date: Days after invoice date
nullable: true
x-used-in:
- serializer
~
Schema
modified
resource_service
Schema changes
title: Budget
x-used-in:
- sorter
-
import:
-
title: Import
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_import
markup:
type: number
title: Markup
~
Schema
modified
resource_expense_report
Schema changes
enum:
- 1
- 2
-
type:
string
+
type:
integer
title: Allocation Status
x-enums:
'1': Allocated
~
Schema
modified
resource_project
Schema changes
title: Query
x-used-in:
- filter
+
import:
+
title: Import
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_import
number:
type: string
title: Number
~
Schema
modified
resource_deal
Schema changes
title: Footer
x-used-in:
- serializer
+
import:
+
title: Import
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_import
number:
type: string
title: Number
~
Schema
modified
resource_person
Schema changes
- form
- filter
- sorter
+
import:
+
title: Import
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_import
status:
enum:
- 1
~
Schema
modified
resource_service
Schema changes
title: Budget
x-used-in:
- sorter
+
import:
+
title: Import
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_import
markup:
type: number
title: Markup
~
Schema
modified
resource_company
Schema changes
x-used-in:
- serializer
- form
+
import:
+
title: Import
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_import
status:
enum:
- 1
+
Schema
added
resource_import
Schema changes
+
type: object
+
title: Import Resource
+
required: false
+
properties:
+
sample:
+
type: boolean
+
title: Sample
+
x-used-in:
+
- serializer
+
creator:
+
title: Creator
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_person
+
failed_at:
+
type: string
+
title: Failed At
+
format: date-time
+
x-used-in:
+
- serializer
+
creator_id:
+
type: integer
+
title: Creator Id
+
x-used-in:
+
- serializer
+
started_at:
+
type: string
+
title: Started At
+
format: date-time
+
x-used-in:
+
- serializer
+
reverted_at:
+
type: string
+
title: Reverted At
+
format: date-time
+
x-used-in:
+
- serializer
+
processed_at:
+
type: string
+
title: Processed At
+
format: date-time
+
x-used-in:
+
- serializer
+
import_models:
+
type: string
+
title: Import Models
+
x-used-in:
+
- serializer
+
import_type_id:
+
type: integer
+
title: Import Type Id
+
x-used-in:
+
- serializer
+
import_model_id:
+
type: integer
+
title: Import Model Id
+
x-used-in:
+
- serializer
+
+
Schema
added
resource_meilisearch_health
Schema changes
+
type: object
+
title: Meilisearch Health Resource
+
required: false
+
properties:
+
error:
+
type: object
+
title: Error
+
nullable: true
+
x-used-in:
+
- serializer
+
properties:
+
class:
+
type: string
+
message:
+
type: string
+
stats:
+
type: object
+
title: Stats
+
nullable: true
+
x-used-in:
+
- serializer
+
properties:
+
index_count:
+
type: integer
+
total_documents:
+
type: integer
+
database_size_bytes:
+
type: integer
+
status:
+
enum:
+
- available
+
- unavailable
+
type: string
+
title: Status
+
x-enums:
+
available: Instance reachable
+
unavailable: Instance unreachable
+
x-used-in:
+
- serializer
+
version:
+
type: object
+
title: Version
+
nullable: true
+
x-used-in:
+
- serializer
+
properties:
+
commit_sha:
+
type: string
+
commit_date:
+
type: string
+
pkg_version:
+
type: string
+
target_url:
+
type: string
+
title: Target URL
+
x-used-in:
+
- serializer
+
task_queue:
+
type: object
+
title: Task Queue
+
nullable: true
+
x-used-in:
+
- serializer
+
properties:
+
backlog:
+
type: integer
+
x-internal: true
+
+
Schema
added
resource_meilisearch_index
Schema changes
+
type: object
+
title: Meilisearch Index Resource
+
required: false
+
properties:
+
drift:
+
type: object
+
title: Drift
+
nullable: true
+
x-used-in:
+
- serializer
+
additionalProperties: true
+
error:
+
type: object
+
title: Error
+
nullable: true
+
x-used-in:
+
- serializer
+
properties:
+
class:
+
type: string
+
message:
+
type: string
+
status:
+
enum:
+
- available
+
- unavailable
+
type: string
+
title: Status
+
x-enums:
+
available: Index reachable
+
unavailable: Index unreadable
+
x-used-in:
+
- serializer
+
in_sync:
+
type: boolean
+
title: In Sync
+
nullable: true
+
x-used-in:
+
- serializer
+
settings:
+
type: object
+
title: Live Settings
+
nullable: true
+
x-used-in:
+
- serializer
+
additionalProperties: true
+
index_uid:
+
type: string
+
title: Index UID
+
x-used-in:
+
- serializer
+
document_count:
+
type: integer
+
title: Document Count
+
nullable: true
+
x-used-in:
+
- serializer
+
documents_by_type:
+
type: object
+
title: Documents By Type
+
nullable: true
+
x-used-in:
+
- serializer
+
additionalProperties:
+
type: integer
+
x-internal: true
+
+
Schema
added
resource_meilisearch_document
Schema changes
+
type: object
+
title: Meilisearch Document Resource
+
required: false
+
properties:
+
pid:
+
type: string
+
title: Primary Key
+
x-used-in:
+
- serializer
+
error:
+
type: object
+
title: Error
+
nullable: true
+
x-used-in:
+
- serializer
+
properties:
+
class:
+
type: string
+
message:
+
type: string
+
status:
+
enum:
+
- found
+
- not_found
+
- unavailable
+
type: string
+
title: Status
+
x-enums:
+
found: Document returned
+
not_found: Document or index missing
+
unavailable: Instance unreachable
+
x-used-in:
+
- serializer
+
document:
+
type: object
+
title: Raw Document
+
nullable: true
+
x-used-in:
+
- serializer
+
additionalProperties: true
+
x-internal: true
+
+
Group
added
Meilisearch
Schema changes
+
name: Meilisearch
+
+
Approves an approval status
PATCH
Request body
added
/api/v2/approval_statuses/{id}/approve/patch/requestBody
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
note:
+
allOf:
+
- "$ref": "#/components/schemas/resource_approval_status/properties/note"
+
- {}
+
+
Rejects an approval status
PATCH
Request body
added
/api/v2/approval_statuses/{id}/reject/patch/requestBody
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
note:
+
allOf:
+
- "$ref": "#/components/schemas/resource_approval_status/properties/note"
+
- {}
+
+
Meilisearch documents browse
GET
Operation
added
/backyard/meilisearch/documents/get
Schema changes
+
tags:
+
- Meilisearch
+
summary: Meilisearch documents browse
+
responses:
+
'200':
+
"$ref": "#/components/responses/collection_meilisearch_document"
+
parameters:
+
- in: query
+
name: org_id
+
schema:
+
type: string
+
required: true
+
- in: query
+
name: filter
+
schema:
+
type: string
+
required: false
+
- in: query
+
name: limit
+
schema:
+
type: integer
+
default: 20
+
required: false
+
- in: query
+
name: offset
+
schema:
+
type: integer
+
default: 0
+
required: false
+
- in: query
+
name: vectors
+
schema:
+
type: boolean
+
default: false
+
required: false
+
- in: query
+
name: url
+
schema:
+
type: string
+
required: false
+
- in: query
+
name: url_key
+
schema:
+
type: string
+
required: false
+
x-internal: true
+
x-resource: resource_meilisearch_document
+
operationId: backyard-meilisearch-documents-index
+
+
Meilisearch raw stored document
GET
Operation
added
/backyard/meilisearch/documents/{id}/get
Schema changes
+
tags:
+
- Meilisearch
+
summary: Meilisearch raw stored document
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_meilisearch_document"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- in: query
+
name: org_id
+
schema:
+
type: string
+
required: true
+
- in: query
+
name: vectors
+
schema:
+
type: boolean
+
default: true
+
required: false
+
- in: query
+
name: url
+
schema:
+
type: string
+
required: false
+
- in: query
+
name: url_key
+
schema:
+
type: string
+
required: false
+
x-internal: true
+
x-resource: resource_meilisearch_document
+
operationId: backyard-meilisearch-document-show
+
+
Meilisearch instance health
GET
Operation
added
/backyard/meilisearch/health/get
Schema changes
+
tags:
+
- Meilisearch
+
summary: Meilisearch instance health
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_meilisearch_health"
+
parameters:
+
- in: query
+
name: url
+
schema:
+
type: string
+
required: false
+
- in: query
+
name: url_key
+
schema:
+
type: string
+
required: false
+
x-internal: true
+
x-resource: resource_meilisearch_health
+
operationId: backyard-meilisearch-health-show
+
+
Meilisearch index settings and sync check
GET
Operation
added
/backyard/meilisearch/index/get
Schema changes
+
tags:
+
- Meilisearch
+
summary: Meilisearch index settings and sync check
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_meilisearch_index"
+
parameters:
+
- in: query
+
name: org_id
+
schema:
+
type: string
+
required: true
+
- in: query
+
name: url
+
schema:
+
type: string
+
required: false
+
- in: query
+
name: url_key
+
schema:
+
type: string
+
required: false
+
x-internal: true
+
x-resource: resource_meilisearch_index
+
operationId: backyard-meilisearch-index-show
+
June 01, 2026
102 changes
102 changes
click to expand
-
Schema
removed
resource_approval_status
Schema changes
-
type: object
-
title: Approval status Resource
-
required: false
-
properties:
-
id:
-
type: integer
-
title: Id
-
x-used-in:
-
- filter
-
note:
-
type: string
-
title: Note
-
x-used-in:
-
- serializer
-
booking:
-
title: Booking
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_booking
-
expense:
-
title: Expense
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_expense
-
approver:
-
title: Approver
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_person
-
booking_id:
-
type: integer
-
title: Booking
-
x-used-in:
-
- filter
-
expense_id:
-
type: integer
-
title: Expense
-
x-used-in:
-
- filter
-
time_entry:
-
title: Time Entry
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_time_entry
-
approved_at:
-
type: string
-
title: Approved At
-
format: date-time
-
x-used-in:
-
- serializer
-
approver_id:
-
type: integer
-
title: Approver
-
x-used-in:
-
- filter
-
rejected_at:
-
type: string
-
title: Rejected At
-
format: date-time
-
x-used-in:
-
- serializer
-
target_type:
-
enum:
-
- booking
-
- time_entry
-
- expense
-
type: string
-
title: Target Type
-
x-enums:
-
booking: Booking
-
expense: Expense
-
time_entry: Time Entry
-
x-used-in:
-
- serializer
-
time_entry_id:
-
type: integer
-
title: Time Entry
-
x-used-in:
-
- filter
-
actual_approver:
-
title: Actual Approver
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_person
-
approval_workflow:
-
title: Approval Workflow
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_approval_workflow
-
actual_approver_id:
-
type: integer
-
title: Actual Approver
-
x-used-in:
-
- filter
-
approver_group_key:
-
type: string
-
title: Approver Group Key
-
x-used-in:
-
- serializer
-
x-feature-flags:
-
- pmDynamicApproverOnAbsences
-
approval_workflow_id:
-
type: integer
-
title: Approval Workflow
-
x-used-in:
-
- filter
-
dynamic_approver_type_id:
-
enum:
-
- 1
-
- 2
-
- 3
-
- 4
-
type: integer
-
title: Dynamic Approver Type
-
x-enums:
-
'1': Manager
-
'2': Budget owner
-
'3': Project manager
-
'4': Designated approver
-
x-used-in:
-
- serializer
-
fallback_approver_type_id:
-
enum:
-
- 1
-
- 2
-
type: integer
-
title: Fallback Approver Type
-
x-enums:
-
'1': Organization owner
-
'2': Budget owner
-
x-used-in:
-
- serializer
-
-
Schema
removed
_filter_root_approval_status
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_approval_status"
-
- "$ref": "#/components/schemas/filter_approval_status"
-
required: false
-
x-internal: true
-
-
Schema
removed
_filter_root_backoffice_organization_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_backoffice_organization_report"
-
- "$ref": "#/components/schemas/filter_backoffice_organization_report"
-
required: false
-
x-internal: true
-
+
Schema
added
resource_agent
Schema changes
+
type: object
+
title: Agent Resource
+
required: false
+
properties:
+
id:
+
type: integer
+
title: Id
+
x-used-in:
+
- filter
+
name:
+
type: string
+
title: Name
+
x-used-in:
+
- serializer
+
- form
+
- filter
+
- sorter
+
query:
+
type: string
+
title: Query
+
x-used-in:
+
- filter
+
title:
+
type: string
+
title: Title
+
x-used-in:
+
- serializer
+
- form
+
- filter
+
- sorter
+
tools:
+
type: array
+
items:
+
type: string
+
title: Tools
+
x-used-in:
+
- filter
+
person:
+
title: Person
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_person
+
status:
+
enum:
+
- active
+
- deactivated
+
type: string
+
title: Status
+
x-enums:
+
active: Active
+
deactivated: Deactivated
+
x-used-in:
+
- serializer
+
manager:
+
title: Manager
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_person
+
status_id:
+
enum:
+
- 1
+
- 2
+
type: integer
+
title: Status
+
x-enums:
+
'1': Active
+
'2': Deactivated
+
x-used-in:
+
- filter
+
avatar_url:
+
type: string
+
title: Avatar URL
+
x-used-in:
+
- serializer
+
- form
+
created_at:
+
type: string
+
title: Created At
+
format: date-time
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
manager_id:
+
type: integer
+
title: Manager
+
x-used-in:
+
- form
+
- filter
+
updated_at:
+
type: string
+
title: Updated At
+
format: date-time
+
x-used-in:
+
- serializer
+
- sorter
+
custom_role:
+
title: Custom Role
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_role
+
agent_config:
+
title: Agent Config
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_agent_config
+
custom_role_id:
+
type: integer
+
title: Custom Role
+
x-used-in:
+
- form
+
- filter
+
deactivated_at:
+
type: string
+
title: Deactivated At
+
format: date-time
+
x-used-in:
+
- serializer
+
- filter
+
+
Schema
added
resource_agent_config
Schema changes
+
type: object
+
title: Agent Config Resource
+
required: false
+
properties:
+
id:
+
type: integer
+
title: Id
+
x-used-in:
+
- filter
+
agent:
+
title: Agent
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_agent
+
agent_id:
+
type: integer
+
title: Agent
+
x-used-in:
+
- form
+
- filter
+
created_at:
+
type: string
+
title: Created At
+
format: date-time
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
updated_at:
+
type: string
+
title: Updated At
+
format: date-time
+
x-used-in:
+
- serializer
+
- sorter
+
attachments:
+
title: Attachments
+
x-used-in:
+
- serializer
+
x-relationship: has_many
+
x-related-resource: resource_attachment
+
instructions:
+
type: string
+
title: Instructions
+
x-used-in:
+
- serializer
+
- form
+
+
Schema
added
filter_agent_config
Schema changes
+
type: object
+
title: Filter agent config
+
required: false
+
properties:
+
id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent_config/properties/id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent_config/properties/id"
+
contains:
+
"$ref": "#/components/schemas/resource_agent_config/properties/id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent_config/properties/id"
+
- "$ref": "#/components/schemas/resource_agent_config/properties/id"
+
agent_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent_config/properties/agent_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent_config/properties/agent_id"
+
contains:
+
"$ref": "#/components/schemas/resource_agent_config/properties/agent_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent_config/properties/agent_id"
+
- "$ref": "#/components/schemas/resource_agent_config/properties/agent_id"
+
x-internal: true
+
+
Schema
added
_filter_root_agent_config
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_agent_config"
+
- "$ref": "#/components/schemas/filter_agent_config"
+
required: false
+
x-internal: true
+
-
Schema
removed
filter_approval_status
Schema changes
-
type: object
-
title: Filter approval status
-
required: false
-
properties:
-
id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/id"
-
contains:
-
"$ref": "#/components/schemas/resource_approval_status/properties/id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_approval_status/properties/id"
-
- "$ref": "#/components/schemas/resource_approval_status/properties/id"
-
booking_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/booking_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/booking_id"
-
contains:
-
"$ref": "#/components/schemas/resource_approval_status/properties/booking_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_approval_status/properties/booking_id"
-
- "$ref": "#/components/schemas/resource_approval_status/properties/booking_id"
-
expense_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/expense_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/expense_id"
-
contains:
-
"$ref": "#/components/schemas/resource_approval_status/properties/expense_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_approval_status/properties/expense_id"
-
- "$ref": "#/components/schemas/resource_approval_status/properties/expense_id"
-
approver_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/approver_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/approver_id"
-
contains:
-
"$ref": "#/components/schemas/resource_approval_status/properties/approver_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_approval_status/properties/approver_id"
-
- "$ref": "#/components/schemas/resource_approval_status/properties/approver_id"
-
time_entry_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/time_entry_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/time_entry_id"
-
contains:
-
"$ref": "#/components/schemas/resource_approval_status/properties/time_entry_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_approval_status/properties/time_entry_id"
-
- "$ref": "#/components/schemas/resource_approval_status/properties/time_entry_id"
-
actual_approver_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/actual_approver_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/actual_approver_id"
-
contains:
-
"$ref": "#/components/schemas/resource_approval_status/properties/actual_approver_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_approval_status/properties/actual_approver_id"
-
- "$ref": "#/components/schemas/resource_approval_status/properties/actual_approver_id"
-
approval_workflow_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/approval_workflow_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_approval_status/properties/approval_workflow_id"
-
contains:
-
"$ref": "#/components/schemas/resource_approval_status/properties/approval_workflow_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_approval_status/properties/approval_workflow_id"
-
- "$ref": "#/components/schemas/resource_approval_status/properties/approval_workflow_id"
-
x-internal: true
-
patternProperties: {}
-
+
Schema
added
_filter_root_agent
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_agent"
+
- "$ref": "#/components/schemas/filter_agent"
+
required: false
+
x-internal: true
+
-
Schema
removed
resource_backoffice_organization_report
Schema changes
-
type: object
-
title: Backoffice Organization Report Resource
-
required: false
-
properties:
-
id:
-
title: ID
-
x-used-in:
-
- filter
-
flag:
-
type: string
-
title: Flag
-
x-used-in:
-
- filter
-
name:
-
type: string
-
title: Name
-
x-used-in:
-
- sorter
-
plan:
-
type: integer
-
title: Plan
-
x-used-in:
-
- serializer
-
- sorter
-
- grouper
-
count:
-
type: integer
-
title: Count
-
x-used-in:
-
- serializer
-
- sorter
-
cycle:
-
type: string
-
title: Cycle
-
x-used-in:
-
- serializer
-
- sorter
-
- grouper
-
group:
-
type: string
-
title: Group
-
x-used-in:
-
- serializer
-
query:
-
type: string
-
title: Query
-
x-used-in:
-
- filter
-
seats:
-
type: integer
-
title: Seats
-
x-used-in:
-
- filter
-
addons:
-
type: string
-
title: Addons
-
x-used-in:
-
- serializer
-
- filter
-
- sorter
-
- grouper
-
domain:
-
type: string
-
title: Domain
-
x-used-in:
-
- filter
-
status:
-
enum:
-
- 1
-
- 2
-
type: integer
-
title: Status
-
x-enums:
-
'1': Active
-
'2': Deactivated
-
x-used-in:
-
- serializer
-
- filter
-
- sorter
-
- grouper
-
country:
-
type: string
-
title: Country
-
x-used-in:
-
- serializer
-
- filter
-
- sorter
-
- grouper
-
erector:
-
title: Erector
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_person
-
contract:
-
type: boolean
-
title: Contract
-
x-used-in:
-
- filter
-
currency:
-
title: Currency
-
x-used-in:
-
- serializer
-
discount:
-
type: integer
-
title: Discount
-
x-used-in:
-
- serializer
-
- filter
-
- sorter
-
- grouper
-
products:
-
type: string
-
title: Products
-
x-used-in:
-
- serializer
-
- filter
-
- sorter
-
- grouper
-
referrer:
-
type: string
-
title: Referrer
-
x-used-in:
-
- serializer
-
- filter
-
- sorter
-
- grouper
-
champions:
-
type: integer
-
title: Champions
-
x-used-in:
-
- filter
-
seats_max:
-
type: integer
-
title: Seats Max
-
x-used-in:
-
- filter
-
stripe_id:
-
type: string
-
title: Stripe ID
-
x-used-in:
-
- filter
-
total_mrr:
-
type: number
-
title: Total MRR
-
x-used-in:
-
- serializer
-
- sorter
-
created_at:
-
type: string
-
title: Created At
-
format: date
-
x-used-in:
-
- filter
-
- sorter
-
- grouper
-
erector_id:
-
type: integer
-
title: Erector ID
-
x-used-in:
-
- filter
-
- sorter
-
- grouper
-
gtm_motion:
-
type: string
-
title: GTM Motion
-
x-used-in:
-
- serializer
-
- filter
-
- sorter
-
- grouper
-
lead_score:
-
type: integer
-
title: Lead Score
-
x-used-in:
-
- sorter
-
seats_used:
-
type: integer
-
title: Seats Used
-
x-used-in:
-
- filter
-
total_seats:
-
type: integer
-
title: Total Seats
-
x-used-in:
-
- serializer
-
- sorter
-
company_size:
-
type: string
-
title: Company Size
-
x-used-in:
-
- serializer
-
- filter
-
- sorter
-
- grouper
-
organization:
-
title: Organization
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_organization
-
contract_date:
-
type: string
-
title: Contract Date
-
format: date
-
x-used-in:
-
- filter
-
- sorter
-
- grouper
-
sales_deal_id:
-
type: integer
-
title: Sales Deal ID
-
x-used-in:
-
- filter
-
contract_seats:
-
type: integer
-
title: Contract Seats
-
x-used-in:
-
- filter
-
formula_fields:
-
title: Formula Fields
-
x-used-in:
-
- serializer
-
payment_method:
-
type: integer
-
title: Payment Method
-
x-used-in:
-
- serializer
-
- sorter
-
- grouper
-
contract_active:
-
type: boolean
-
title: Contract Active
-
x-used-in:
-
- filter
-
number_of_calls:
-
type: integer
-
title: Number Of Calls
-
x-used-in:
-
- filter
-
- sorter
-
release_channel:
-
enum:
-
- development
-
- alpha
-
- beta
-
- stable
-
type: string
-
title: Release Channel
-
x-enums:
-
beta: Beta
-
alpha: Alpha
-
stable: Stable
-
development: Development
-
x-used-in:
-
- serializer
-
- filter
-
- sorter
-
- grouper
-
total_seats_max:
-
type: integer
-
title: Total Seats Max
-
x-used-in:
-
- serializer
-
- sorter
-
trial_plan_ends:
-
type: string
-
title: Trial Plan Ends
-
format: date
-
x-used-in:
-
- filter
-
currency_default:
-
title: Currency Default
-
x-used-in:
-
- serializer
-
total_seats_used:
-
type: integer
-
title: Total Seats Used
-
x-used-in:
-
- serializer
-
- sorter
-
contract_end_date:
-
type: string
-
title: Contract End Date
-
format: date
-
x-used-in:
-
- filter
-
- sorter
-
- grouper
-
created_at_period:
-
type: string
-
title: Created At Period
-
x-used-in:
-
- serializer
-
deactivation_note:
-
type: string
-
title: Deactivation Note
-
x-used-in:
-
- filter
-
- sorter
-
total_mrr_default:
-
type: number
-
title: Total MRR Default
-
x-used-in:
-
- serializer
-
contract_min_seats:
-
type: integer
-
title: Contract Min Seats
-
x-used-in:
-
- filter
-
primary_contact_id:
-
type: integer
-
title: Primary Contact ID
-
x-used-in:
-
- filter
-
subscription_state:
-
type: integer
-
title: Subscription State
-
x-used-in:
-
- serializer
-
- sorter
-
- grouper
-
billing_group_admin:
-
type: boolean
-
title: Billing Group Admin
-
x-used-in:
-
- serializer
-
- filter
-
- sorter
-
- grouper
-
billing_group_owner:
-
title: Billing Group Owner
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_organization
-
verification_status:
-
type: integer
-
title: Verification Status
-
x-used-in:
-
- serializer
-
- sorter
-
- grouper
-
contract_date_period:
-
type: string
-
title: Contract Date Period
-
x-used-in:
-
- serializer
-
next_billing_cycle_at:
-
type: string
-
title: Next Billing Cycle At
-
format: date
-
x-used-in:
-
- filter
-
- sorter
-
- grouper
-
billing_group_owner_id:
-
type: integer
-
title: Billing Group Owner ID
-
x-used-in:
-
- filter
-
- sorter
-
- grouper
-
deactivation_reason_id:
-
type: integer
-
title: Deactivation Reason ID
-
x-used-in:
-
- filter
-
- sorter
-
verification_status_id:
-
type: integer
-
title: Verification Status ID
-
x-used-in:
-
- filter
-
contract_end_date_period:
-
type: string
-
title: Contract End Date Period
-
x-used-in:
-
- serializer
-
customer_success_specialist:
-
title: Customer Success Specialist
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_person
-
next_billing_cycle_at_period:
-
type: string
-
title: Next Billing Cycle At Period
-
x-used-in:
-
- serializer
-
customer_success_specialist_id:
-
type: integer
-
title: Customer Success Specialist ID
-
x-used-in:
-
- filter
-
- sorter
-
- grouper
-
x-internal: true
-
-
Schema
removed
filter_backoffice_organization_report
Schema changes
-
type: object
-
title: Filter backoffice organization report
-
required: false
-
properties:
-
id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/id"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/id"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/id"
-
flag:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/flag"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/flag"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/flag"
-
query:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/query"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/query"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/query"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/query"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/query"
-
seats:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats"
-
addons:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
-
domain:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/domain"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/domain"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/domain"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/domain"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/domain"
-
status:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/status"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/status"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/status"
-
country:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
-
contract:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract"
-
discount:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/discount"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/discount"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/discount"
-
products:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
-
referrer:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
-
champions:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/champions"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/champions"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/champions"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/champions"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/champions"
-
seats_max:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_max"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_max"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_max"
-
stripe_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/stripe_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/stripe_id"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/stripe_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/stripe_id"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/stripe_id"
-
created_at:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at"
-
erector_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/erector_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/erector_id"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/erector_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/erector_id"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/erector_id"
-
gtm_motion:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
-
seats_used:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_used"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_used"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_used"
-
company_size:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
-
contract_date:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date"
-
sales_deal_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/sales_deal_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/sales_deal_id"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/sales_deal_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/sales_deal_id"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/sales_deal_id"
-
contract_seats:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_seats"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_seats"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_seats"
-
contract_active:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_active"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_active"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_active"
-
number_of_calls:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/number_of_calls"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/number_of_calls"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/number_of_calls"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/number_of_calls"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/number_of_calls"
-
release_channel:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
-
trial_plan_ends:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/trial_plan_ends"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/trial_plan_ends"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/trial_plan_ends"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/trial_plan_ends"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/trial_plan_ends"
-
contract_end_date:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date"
-
deactivation_note:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_note"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_note"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_note"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_note"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_note"
-
contract_min_seats:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_min_seats"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_min_seats"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_min_seats"
-
primary_contact_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/primary_contact_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/primary_contact_id"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/primary_contact_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/primary_contact_id"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/primary_contact_id"
-
billing_group_admin:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_admin"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_admin"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_admin"
-
next_billing_cycle_at:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at"
-
billing_group_owner_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_owner_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_owner_id"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_owner_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_owner_id"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_owner_id"
-
deactivation_reason_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_reason_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_reason_id"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_reason_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_reason_id"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_reason_id"
-
verification_status_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status_id"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status_id"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status_id"
-
customer_success_specialist_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/customer_success_specialist_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/customer_success_specialist_id"
-
contains:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/customer_success_specialist_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/customer_success_specialist_id"
-
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/customer_success_specialist_id"
-
x-internal: true
-
patternProperties:
-
"^organization_subscription..*$":
-
title: Organization subscription relationship
-
+
Schema
added
filter_agent
Schema changes
+
type: object
+
title: Filter agent
+
required: false
+
properties:
+
id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent/properties/id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent/properties/id"
+
contains:
+
"$ref": "#/components/schemas/resource_agent/properties/id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent/properties/id"
+
- "$ref": "#/components/schemas/resource_agent/properties/id"
+
name:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent/properties/name"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent/properties/name"
+
contains:
+
"$ref": "#/components/schemas/resource_agent/properties/name"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent/properties/name"
+
- "$ref": "#/components/schemas/resource_agent/properties/name"
+
query:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent/properties/query"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent/properties/query"
+
contains:
+
"$ref": "#/components/schemas/resource_agent/properties/query"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent/properties/query"
+
- "$ref": "#/components/schemas/resource_agent/properties/query"
+
title:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent/properties/title"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent/properties/title"
+
contains:
+
"$ref": "#/components/schemas/resource_agent/properties/title"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent/properties/title"
+
- "$ref": "#/components/schemas/resource_agent/properties/title"
+
tools:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent/properties/tools"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent/properties/tools"
+
contains:
+
"$ref": "#/components/schemas/resource_agent/properties/tools"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent/properties/tools"
+
- "$ref": "#/components/schemas/resource_agent/properties/tools"
+
status:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent/properties/status_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent/properties/status_id"
+
contains:
+
"$ref": "#/components/schemas/resource_agent/properties/status_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent/properties/status_id"
+
- "$ref": "#/components/schemas/resource_agent/properties/status_id"
+
created_at:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent/properties/created_at"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent/properties/created_at"
+
contains:
+
"$ref": "#/components/schemas/resource_agent/properties/created_at"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent/properties/created_at"
+
- "$ref": "#/components/schemas/resource_agent/properties/created_at"
+
manager_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent/properties/manager_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent/properties/manager_id"
+
contains:
+
"$ref": "#/components/schemas/resource_agent/properties/manager_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent/properties/manager_id"
+
- "$ref": "#/components/schemas/resource_agent/properties/manager_id"
+
custom_role_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent/properties/custom_role_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent/properties/custom_role_id"
+
contains:
+
"$ref": "#/components/schemas/resource_agent/properties/custom_role_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent/properties/custom_role_id"
+
- "$ref": "#/components/schemas/resource_agent/properties/custom_role_id"
+
deactivated_at:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_agent/properties/deactivated_at"
+
not_eq:
+
"$ref": "#/components/schemas/resource_agent/properties/deactivated_at"
+
contains:
+
"$ref": "#/components/schemas/resource_agent/properties/deactivated_at"
+
not_contain:
+
"$ref": "#/components/schemas/resource_agent/properties/deactivated_at"
+
- "$ref": "#/components/schemas/resource_agent/properties/deactivated_at"
+
x-internal: true
+
patternProperties:
+
"^manager..*$":
+
title: Manager relationship
+
"^custom_role..*$":
+
title: Custom Role relationship
+
+
Schema
added
filter_backoffice_organization_report
Schema changes
+
type: object
+
title: Filter backoffice organization report
+
required: false
+
properties:
+
id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/id"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/id"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/id"
+
flag:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/flag"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/flag"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/flag"
+
query:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/query"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/query"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/query"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/query"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/query"
+
seats:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats"
+
addons:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
+
domain:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/domain"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/domain"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/domain"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/domain"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/domain"
+
status:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/status"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/status"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/status"
+
country:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
+
contract:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract"
+
discount:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/discount"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/discount"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/discount"
+
products:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
+
referrer:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
+
champions:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/champions"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/champions"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/champions"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/champions"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/champions"
+
seats_max:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_max"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_max"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_max"
+
stripe_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/stripe_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/stripe_id"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/stripe_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/stripe_id"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/stripe_id"
+
created_at:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at"
+
erector_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/erector_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/erector_id"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/erector_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/erector_id"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/erector_id"
+
gtm_motion:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
+
seats_used:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_used"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_used"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/seats_used"
+
company_size:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
+
contract_date:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date"
+
sales_deal_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/sales_deal_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/sales_deal_id"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/sales_deal_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/sales_deal_id"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/sales_deal_id"
+
contract_seats:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_seats"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_seats"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_seats"
+
contract_active:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_active"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_active"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_active"
+
number_of_calls:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/number_of_calls"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/number_of_calls"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/number_of_calls"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/number_of_calls"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/number_of_calls"
+
release_channel:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
+
trial_plan_ends:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/trial_plan_ends"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/trial_plan_ends"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/trial_plan_ends"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/trial_plan_ends"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/trial_plan_ends"
+
contract_end_date:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date"
+
deactivation_note:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_note"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_note"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_note"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_note"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_note"
+
contract_min_seats:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_min_seats"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_min_seats"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_min_seats"
+
primary_contact_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/primary_contact_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/primary_contact_id"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/primary_contact_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/primary_contact_id"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/primary_contact_id"
+
billing_group_admin:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_admin"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_admin"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_admin"
+
next_billing_cycle_at:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at"
+
billing_group_owner_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_owner_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_owner_id"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_owner_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_owner_id"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_owner_id"
+
deactivation_reason_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_reason_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_reason_id"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_reason_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_reason_id"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/deactivation_reason_id"
+
verification_status_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status_id"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status_id"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status_id"
+
customer_success_specialist_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/customer_success_specialist_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/customer_success_specialist_id"
+
contains:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/customer_success_specialist_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/customer_success_specialist_id"
+
- "$ref": "#/components/schemas/resource_backoffice_organization_report/properties/customer_success_specialist_id"
+
x-internal: true
+
patternProperties:
+
"^organization_subscription..*$":
+
title: Organization subscription relationship
+
+
Schema
added
resource_backoffice_organization_report
Schema changes
+
type: object
+
title: Backoffice Organization Report Resource
+
required: false
+
properties:
+
id:
+
title: ID
+
x-used-in:
+
- filter
+
flag:
+
type: string
+
title: Flag
+
x-used-in:
+
- filter
+
name:
+
type: string
+
title: Name
+
x-used-in:
+
- sorter
+
plan:
+
type: integer
+
title: Plan
+
x-used-in:
+
- serializer
+
- sorter
+
- grouper
+
count:
+
type: integer
+
title: Count
+
x-used-in:
+
- serializer
+
- sorter
+
cycle:
+
type: string
+
title: Cycle
+
x-used-in:
+
- serializer
+
- sorter
+
- grouper
+
group:
+
type: string
+
title: Group
+
x-used-in:
+
- serializer
+
query:
+
type: string
+
title: Query
+
x-used-in:
+
- filter
+
seats:
+
type: integer
+
title: Seats
+
x-used-in:
+
- filter
+
addons:
+
type: string
+
title: Addons
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
domain:
+
type: string
+
title: Domain
+
x-used-in:
+
- filter
+
status:
+
enum:
+
- 1
+
- 2
+
type: integer
+
title: Status
+
x-enums:
+
'1': Active
+
'2': Deactivated
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
country:
+
type: string
+
title: Country
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
erector:
+
title: Erector
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_person
+
contract:
+
type: boolean
+
title: Contract
+
x-used-in:
+
- filter
+
currency:
+
title: Currency
+
x-used-in:
+
- serializer
+
discount:
+
type: integer
+
title: Discount
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
products:
+
type: string
+
title: Products
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
referrer:
+
type: string
+
title: Referrer
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
champions:
+
type: integer
+
title: Champions
+
x-used-in:
+
- filter
+
seats_max:
+
type: integer
+
title: Seats Max
+
x-used-in:
+
- filter
+
stripe_id:
+
type: string
+
title: Stripe ID
+
x-used-in:
+
- filter
+
total_mrr:
+
type: number
+
title: Total MRR
+
x-used-in:
+
- serializer
+
- sorter
+
created_at:
+
type: string
+
title: Created At
+
format: date
+
x-used-in:
+
- filter
+
- sorter
+
- grouper
+
erector_id:
+
type: integer
+
title: Erector ID
+
x-used-in:
+
- filter
+
- sorter
+
- grouper
+
gtm_motion:
+
type: string
+
title: GTM Motion
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
lead_score:
+
type: integer
+
title: Lead Score
+
x-used-in:
+
- sorter
+
seats_used:
+
type: integer
+
title: Seats Used
+
x-used-in:
+
- filter
+
total_seats:
+
type: integer
+
title: Total Seats
+
x-used-in:
+
- serializer
+
- sorter
+
company_size:
+
type: string
+
title: Company Size
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
organization:
+
title: Organization
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_organization
+
contract_date:
+
type: string
+
title: Contract Date
+
format: date
+
x-used-in:
+
- filter
+
- sorter
+
- grouper
+
sales_deal_id:
+
type: integer
+
title: Sales Deal ID
+
x-used-in:
+
- filter
+
contract_seats:
+
type: integer
+
title: Contract Seats
+
x-used-in:
+
- filter
+
formula_fields:
+
title: Formula Fields
+
x-used-in:
+
- serializer
+
payment_method:
+
type: integer
+
title: Payment Method
+
x-used-in:
+
- serializer
+
- sorter
+
- grouper
+
contract_active:
+
type: boolean
+
title: Contract Active
+
x-used-in:
+
- filter
+
number_of_calls:
+
type: integer
+
title: Number Of Calls
+
x-used-in:
+
- filter
+
- sorter
+
release_channel:
+
enum:
+
- development
+
- alpha
+
- beta
+
- stable
+
type: string
+
title: Release Channel
+
x-enums:
+
beta: Beta
+
alpha: Alpha
+
stable: Stable
+
development: Development
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
total_seats_max:
+
type: integer
+
title: Total Seats Max
+
x-used-in:
+
- serializer
+
- sorter
+
trial_plan_ends:
+
type: string
+
title: Trial Plan Ends
+
format: date
+
x-used-in:
+
- filter
+
currency_default:
+
title: Currency Default
+
x-used-in:
+
- serializer
+
total_seats_used:
+
type: integer
+
title: Total Seats Used
+
x-used-in:
+
- serializer
+
- sorter
+
contract_end_date:
+
type: string
+
title: Contract End Date
+
format: date
+
x-used-in:
+
- filter
+
- sorter
+
- grouper
+
created_at_period:
+
type: string
+
title: Created At Period
+
x-used-in:
+
- serializer
+
deactivation_note:
+
type: string
+
title: Deactivation Note
+
x-used-in:
+
- filter
+
- sorter
+
total_mrr_default:
+
type: number
+
title: Total MRR Default
+
x-used-in:
+
- serializer
+
contract_min_seats:
+
type: integer
+
title: Contract Min Seats
+
x-used-in:
+
- filter
+
primary_contact_id:
+
type: integer
+
title: Primary Contact ID
+
x-used-in:
+
- filter
+
subscription_state:
+
type: integer
+
title: Subscription State
+
x-used-in:
+
- serializer
+
- sorter
+
- grouper
+
billing_group_admin:
+
type: boolean
+
title: Billing Group Admin
+
x-used-in:
+
- serializer
+
- filter
+
- sorter
+
- grouper
+
billing_group_owner:
+
title: Billing Group Owner
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_organization
+
verification_status:
+
type: integer
+
title: Verification Status
+
x-used-in:
+
- serializer
+
- sorter
+
- grouper
+
contract_date_period:
+
type: string
+
title: Contract Date Period
+
x-used-in:
+
- serializer
+
next_billing_cycle_at:
+
type: string
+
title: Next Billing Cycle At
+
format: date
+
x-used-in:
+
- filter
+
- sorter
+
- grouper
+
billing_group_owner_id:
+
type: integer
+
title: Billing Group Owner ID
+
x-used-in:
+
- filter
+
- sorter
+
- grouper
+
deactivation_reason_id:
+
type: integer
+
title: Deactivation Reason ID
+
x-used-in:
+
- filter
+
- sorter
+
verification_status_id:
+
type: integer
+
title: Verification Status ID
+
x-used-in:
+
- filter
+
contract_end_date_period:
+
type: string
+
title: Contract End Date Period
+
x-used-in:
+
- serializer
+
customer_success_specialist:
+
title: Customer Success Specialist
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_person
+
next_billing_cycle_at_period:
+
type: string
+
title: Next Billing Cycle At Period
+
x-used-in:
+
- serializer
+
customer_success_specialist_id:
+
type: integer
+
title: Customer Success Specialist ID
+
x-used-in:
+
- filter
+
- sorter
+
- grouper
+
x-internal: true
+
~
Schema
modified
filter_financial_item_report
Schema changes
not_contain:
"$ref": "#/components/schemas/resource_financial_item_report/properties/budget_used"
- "$ref": "#/components/schemas/resource_financial_item_report/properties/budget_used"
+
description:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_description"
+
not_eq:
+
"$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_description"
+
contains:
+
"$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_description"
+
not_contain:
+
"$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_description"
+
- "$ref": "#/components/schemas/resource_financial_item_report/properties/financial_item_description"
pipeline_id:
oneOf:
- type: object
~
Schema
modified
resource_financial_item_report
Schema changes
x-used-in:
- serializer
- sorter
+
- filter
total_budget_total_default:
title: Total Budget Total Default
x-used-in:
+
Schema
added
_filter_root_backoffice_organization_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_backoffice_organization_report"
+
- "$ref": "#/components/schemas/filter_backoffice_organization_report"
+
required: false
+
x-internal: true
+
~
Schema
modified
filter_task_list
Schema changes
not_contain:
"$ref": "#/components/schemas/resource_task_list/properties/status"
- "$ref": "#/components/schemas/resource_task_list/properties/status"
+
board_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
+
contains:
+
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
+
- "$ref": "#/components/schemas/resource_task_list/properties/board_id"
folder_id:
oneOf:
- type: object
...
- "$ref": "#/components/schemas/resource_task_list/properties/restorable"
x-internal: true
patternProperties:
+
"^board..*$":
+
title: Board relationship
"^folder..*$":
title: Folder relationship
"^project..*$":
~
Schema
modified
resource_task
Schema changes
- serializer
x-relationship: has_many
x-related-resource: resource_attachment
-
description:
-
type: string
-
title: Description
-
nullable: true
-
x-used-in:
-
- serializer
-
- form
due_date_on:
type: string
title: Due Date On
+
Schema
added
resource_approval_status
Schema changes
+
type: object
+
title: Approval status Resource
+
required: false
+
properties:
+
id:
+
type: integer
+
title: Id
+
x-used-in:
+
- filter
+
note:
+
type: string
+
title: Note
+
x-used-in:
+
- serializer
+
booking:
+
title: Booking
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_booking
+
expense:
+
title: Expense
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_expense
+
approver:
+
title: Approver
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_person
+
booking_id:
+
type: integer
+
title: Booking
+
x-used-in:
+
- filter
+
expense_id:
+
type: integer
+
title: Expense
+
x-used-in:
+
- filter
+
time_entry:
+
title: Time Entry
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_time_entry
+
approved_at:
+
type: string
+
title: Approved At
+
format: date-time
+
x-used-in:
+
- serializer
+
approver_id:
+
type: integer
+
title: Approver
+
x-used-in:
+
- filter
+
rejected_at:
+
type: string
+
title: Rejected At
+
format: date-time
+
x-used-in:
+
- serializer
+
target_type:
+
enum:
+
- booking
+
- time_entry
+
- expense
+
type: string
+
title: Target Type
+
x-enums:
+
booking: Booking
+
expense: Expense
+
time_entry: Time Entry
+
x-used-in:
+
- serializer
+
time_entry_id:
+
type: integer
+
title: Time Entry
+
x-used-in:
+
- filter
+
actual_approver:
+
title: Actual Approver
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_person
+
approval_workflow:
+
title: Approval Workflow
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_approval_workflow
+
actual_approver_id:
+
type: integer
+
title: Actual Approver
+
x-used-in:
+
- filter
+
approver_group_key:
+
type: string
+
title: Approver Group Key
+
x-used-in:
+
- serializer
+
x-feature-flags:
+
- pmDynamicApproverOnAbsences
+
approval_workflow_id:
+
type: integer
+
title: Approval Workflow
+
x-used-in:
+
- filter
+
dynamic_approver_type_id:
+
enum:
+
- 1
+
- 2
+
- 3
+
- 4
+
type: integer
+
title: Dynamic Approver Type
+
x-enums:
+
'1': Manager
+
'2': Budget owner
+
'3': Project manager
+
'4': Designated approver
+
x-used-in:
+
- serializer
+
fallback_approver_type_id:
+
enum:
+
- 1
+
- 2
+
type: integer
+
title: Fallback Approver Type
+
x-enums:
+
'1': Organization owner
+
'2': Budget owner
+
x-used-in:
+
- serializer
+
~
Schema
modified
resource_task_list
Schema changes
x-used-in:
- serializer
- form
+
board:
+
title: Board
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_board
query:
type: string
title: Query
...
- serializer
x-relationship: has_one
x-related-resource: resource_project
+
board_id:
+
type: integer
+
title: Board
+
x-used-in:
+
- form
+
- filter
position:
type: integer
title: Position
...
title: Placement
x-used-in:
- serializer
+
board_name:
+
title: Board Name
+
x-used-in:
+
- sorter
project_id:
type: integer
title: Project
...
x-used-in:
- serializer
folder_name:
-
type: string
title: Folder Name
x-used-in:
- sorter
company_name:
-
type: string
title: Company Name
x-used-in:
- sorter
...
x-relationship: has_one
x-related-resource: resource_organization
project_name:
-
type: string
title: Project Name
x-used-in:
- sorter
+
Schema
added
_filter_root_approval_status
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_approval_status"
+
- "$ref": "#/components/schemas/filter_approval_status"
+
required: false
+
x-internal: true
+
+
Schema
added
filter_approval_status
Schema changes
+
type: object
+
title: Filter approval status
+
required: false
+
properties:
+
id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/id"
+
contains:
+
"$ref": "#/components/schemas/resource_approval_status/properties/id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_approval_status/properties/id"
+
- "$ref": "#/components/schemas/resource_approval_status/properties/id"
+
booking_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/booking_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/booking_id"
+
contains:
+
"$ref": "#/components/schemas/resource_approval_status/properties/booking_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_approval_status/properties/booking_id"
+
- "$ref": "#/components/schemas/resource_approval_status/properties/booking_id"
+
expense_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/expense_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/expense_id"
+
contains:
+
"$ref": "#/components/schemas/resource_approval_status/properties/expense_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_approval_status/properties/expense_id"
+
- "$ref": "#/components/schemas/resource_approval_status/properties/expense_id"
+
approver_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approver_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approver_id"
+
contains:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approver_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approver_id"
+
- "$ref": "#/components/schemas/resource_approval_status/properties/approver_id"
+
time_entry_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/time_entry_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/time_entry_id"
+
contains:
+
"$ref": "#/components/schemas/resource_approval_status/properties/time_entry_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_approval_status/properties/time_entry_id"
+
- "$ref": "#/components/schemas/resource_approval_status/properties/time_entry_id"
+
actual_approver_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/actual_approver_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/actual_approver_id"
+
contains:
+
"$ref": "#/components/schemas/resource_approval_status/properties/actual_approver_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_approval_status/properties/actual_approver_id"
+
- "$ref": "#/components/schemas/resource_approval_status/properties/actual_approver_id"
+
approval_workflow_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approval_workflow_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approval_workflow_id"
+
contains:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approval_workflow_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approval_workflow_id"
+
- "$ref": "#/components/schemas/resource_approval_status/properties/approval_workflow_id"
+
x-internal: true
+
patternProperties: {}
+
~
Schema
modified
resource_todo
Schema changes
x-relationship: has_one
x-related-resource: resource_task
closed:
-
type: boolean
title: Closed
x-used-in:
- serializer
...
format: time
x-used-in:
- serializer
+
- form
position:
type: integer
title: Position
...
x-used-in:
- form
- filter
-
description:
-
type: string
-
title: Description
-
x-used-in:
-
- serializer
-
- form
organization:
title: Organization
x-used-in:
+
Parameter
added
sort_agent_config
Schema changes
+
in: query
+
name: sort
+
style: form
+
schema:
+
type: array
+
items:
+
type: string
+
title: Sort agent config
+
explode: false
+
required: false
+
+
Parameter
added
filter_agent_config
Schema changes
+
in: query
+
name: filter
+
style: deepObject
+
schema:
+
"$ref": "#/components/schemas/_filter_root_agent_config"
+
required: false
+
+
Parameter
added
sort_agent
Schema changes
+
in: query
+
name: sort
+
style: form
+
schema:
+
type: array
+
items:
+
type: string
+
title: Sort agent
+
explode: false
+
required: false
+
+
Parameter
added
filter_agent
Schema changes
+
in: query
+
name: filter
+
style: deepObject
+
schema:
+
"$ref": "#/components/schemas/_filter_root_agent"
+
required: false
+
+
Parameter
added
sort_backoffice_organization_report
Schema changes
+
in: query
+
name: sort
+
style: form
+
schema:
+
type: array
+
items:
+
enum:
+
- organization_id
+
- "-organization_id"
+
- name
+
- "-name"
+
- status
+
- "-status"
+
- subscription_state
+
- "-subscription_state"
+
- plan
+
- "-plan"
+
- payment_method
+
- "-payment_method"
+
- cycle
+
- "-cycle"
+
- lead_score
+
- "-lead_score"
+
- country
+
- "-country"
+
- erector
+
- "-erector"
+
- customer_success_specialist
+
- "-customer_success_specialist"
+
- billing_group_owner
+
- "-billing_group_owner"
+
- billing_group_admin
+
- "-billing_group_admin"
+
- number_of_calls
+
- "-number_of_calls"
+
- addons
+
- "-addons"
+
- deactivation_reason_id
+
- "-deactivation_reason_id"
+
- deactivation_note
+
- "-deactivation_note"
+
- verification_status
+
- "-verification_status"
+
- products
+
- "-products"
+
- discount
+
- "-discount"
+
- referrer
+
- "-referrer"
+
- company_size
+
- "-company_size"
+
- gtm_motion
+
- "-gtm_motion"
+
- release_channel
+
- "-release_channel"
+
- count
+
- "-count"
+
- total_seats
+
- "-total_seats"
+
- total_seats_used
+
- "-total_seats_used"
+
- total_seats_max
+
- "-total_seats_max"
+
- total_mrr
+
- "-total_mrr"
+
- organization_created_at
+
- "-organization_created_at"
+
- organization_contract_date
+
- "-organization_contract_date"
+
- organization_organization_subscription_next_billing_cycle_at
+
- "-organization_organization_subscription_next_billing_cycle_at"
+
- created_at
+
- "-created_at"
+
- contract_date
+
- "-contract_date"
+
- contract_end_date
+
- "-contract_end_date"
+
- next_billing_cycle_at
+
- "-next_billing_cycle_at"
+
type: string
+
title: Sort backoffice organization report
+
explode: false
+
required: false
+
+
Parameter
added
group_backoffice_organization_report
Schema changes
+
in: query
+
name: group
+
style: form
+
schema:
+
enum:
+
- root
+
- organization
+
- status
+
- subscription_state
+
- plan
+
- payment_method
+
- cycle
+
- country
+
- erector
+
- customer_success_specialist
+
- billing_group_owner
+
- billing_group_admin
+
- addons
+
- verification_status
+
- products
+
- discount
+
- referrer
+
- company_size
+
- gtm_motion
+
- release_channel
+
- created_at
+
- contract_date
+
- contract_end_date
+
- next_billing_cycle_at
+
type: string
+
title: Group backoffice organization report
+
x-enums:
+
plan: Plan
+
root: Root
+
cycle: Cycle
+
addons: Addons
+
status: Status
+
country: Country
+
erector: Erector
+
discount: Discount
+
products: Products
+
referrer: Referrer
+
created_at: Created At
+
gtm_motion: GTM Motion
+
company_size: Company Size
+
organization: Organization
+
contract_date: Contract Date
+
payment_method: Payment Method
+
release_channel: Release Channel
+
contract_end_date: Contract End Date
+
subscription_state: Subscription State
+
billing_group_admin: Billing Group Admin
+
billing_group_owner: Billing Group Owner
+
verification_status: Verification Status
+
next_billing_cycle_at: Next Billing Cycle At
+
customer_success_specialist: Customer Success Specialist
+
explode: false
+
required: false
+
+
Parameter
added
filter_backoffice_organization_report
Schema changes
+
in: query
+
name: filter
+
style: deepObject
+
schema:
+
"$ref": "#/components/schemas/_filter_root_backoffice_organization_report"
+
required: false
+
+
Parameter
added
filter_approval_status
Schema changes
+
in: query
+
name: filter
+
style: deepObject
+
schema:
+
"$ref": "#/components/schemas/_filter_root_approval_status"
+
required: false
+
-
Group
removed
Backoffice Organization Reports
Schema changes
-
name: Backoffice Organization Reports
-
x-resource: resource_backoffice_organization_report
-
+
Group
added
Agent Roles
Schema changes
+
name: Agent Roles
+
x-resource: resource_role
+
-
Group
removed
Approval Status
Schema changes
-
name: Approval Status
-
x-resource: resource_approval_status
-
+
Group
added
Agent Configs
Schema changes
+
name: Agent Configs
+
x-resource: resource_agent_config
+
+
Group
added
Agents
Schema changes
+
name: Agents
+
x-resource: resource_agent
+
+
Group
added
Backoffice Organization Reports
Schema changes
+
name: Backoffice Organization Reports
+
x-resource: resource_backoffice_organization_report
+
+
Group
added
Approval Status
Schema changes
+
name: Approval Status
+
x-resource: resource_approval_status
+
+
Response
added
collection_agent_config
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: array
+
items:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
created_at:
+
"$ref": "#/components/schemas/resource_agent_config/properties/created_at"
+
updated_at:
+
"$ref": "#/components/schemas/resource_agent_config/properties/updated_at"
+
instructions:
+
"$ref": "#/components/schemas/resource_agent_config/properties/instructions"
+
relationships:
+
type: object
+
properties:
+
agent:
+
"$ref": "#/components/schemas/_single_relationship"
+
attachments:
+
"$ref": "#/components/schemas/_collection_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
single_agent
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_agent/properties/name"
+
title:
+
"$ref": "#/components/schemas/resource_agent/properties/title"
+
status:
+
"$ref": "#/components/schemas/resource_agent/properties/status"
+
avatar_url:
+
"$ref": "#/components/schemas/resource_agent/properties/avatar_url"
+
created_at:
+
"$ref": "#/components/schemas/resource_agent/properties/created_at"
+
updated_at:
+
"$ref": "#/components/schemas/resource_agent/properties/updated_at"
+
deactivated_at:
+
"$ref": "#/components/schemas/resource_agent/properties/deactivated_at"
+
relationships:
+
type: object
+
properties:
+
person:
+
"$ref": "#/components/schemas/_single_relationship"
+
manager:
+
"$ref": "#/components/schemas/_single_relationship"
+
custom_role:
+
"$ref": "#/components/schemas/_single_relationship"
+
agent_config:
+
"$ref": "#/components/schemas/_single_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
single_agent_config
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
created_at:
+
"$ref": "#/components/schemas/resource_agent_config/properties/created_at"
+
updated_at:
+
"$ref": "#/components/schemas/resource_agent_config/properties/updated_at"
+
instructions:
+
"$ref": "#/components/schemas/resource_agent_config/properties/instructions"
+
relationships:
+
type: object
+
properties:
+
agent:
+
"$ref": "#/components/schemas/_single_relationship"
+
attachments:
+
"$ref": "#/components/schemas/_collection_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
collection_agent
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_agent/properties/name"
+
title:
+
"$ref": "#/components/schemas/resource_agent/properties/title"
+
status:
+
"$ref": "#/components/schemas/resource_agent/properties/status"
+
avatar_url:
+
"$ref": "#/components/schemas/resource_agent/properties/avatar_url"
+
created_at:
+
"$ref": "#/components/schemas/resource_agent/properties/created_at"
+
updated_at:
+
"$ref": "#/components/schemas/resource_agent/properties/updated_at"
+
deactivated_at:
+
"$ref": "#/components/schemas/resource_agent/properties/deactivated_at"
+
relationships:
+
type: object
+
properties:
+
person:
+
"$ref": "#/components/schemas/_single_relationship"
+
manager:
+
"$ref": "#/components/schemas/_single_relationship"
+
custom_role:
+
"$ref": "#/components/schemas/_single_relationship"
+
agent_config:
+
"$ref": "#/components/schemas/_single_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
collection_backoffice_organization_report
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: array
+
items:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
plan:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/plan"
+
count:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/count"
+
cycle:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/cycle"
+
group:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/group"
+
addons:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/addons"
+
status:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/status"
+
country:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/country"
+
currency:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/currency"
+
discount:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/discount"
+
products:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/products"
+
referrer:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/referrer"
+
total_mrr:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/total_mrr"
+
gtm_motion:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/gtm_motion"
+
total_seats:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/total_seats"
+
company_size:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/company_size"
+
formula_fields:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/formula_fields"
+
payment_method:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/payment_method"
+
release_channel:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/release_channel"
+
total_seats_max:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/total_seats_max"
+
currency_default:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/currency_default"
+
total_seats_used:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/total_seats_used"
+
created_at_period:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/created_at_period"
+
total_mrr_default:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/total_mrr_default"
+
subscription_state:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/subscription_state"
+
billing_group_admin:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/billing_group_admin"
+
verification_status:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/verification_status"
+
contract_date_period:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_date_period"
+
contract_end_date_period:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/contract_end_date_period"
+
next_billing_cycle_at_period:
+
"$ref": "#/components/schemas/resource_backoffice_organization_report/properties/next_billing_cycle_at_period"
+
relationships:
+
type: object
+
properties:
+
erector:
+
"$ref": "#/components/schemas/_single_relationship"
+
organization:
+
"$ref": "#/components/schemas/_single_relationship"
+
billing_group_owner:
+
"$ref": "#/components/schemas/_single_relationship"
+
customer_success_specialist:
+
"$ref": "#/components/schemas/_single_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Response
added
collection_approval_status
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: array
+
items:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
note:
+
"$ref": "#/components/schemas/resource_approval_status/properties/note"
+
approved_at:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approved_at"
+
rejected_at:
+
"$ref": "#/components/schemas/resource_approval_status/properties/rejected_at"
+
target_type:
+
"$ref": "#/components/schemas/resource_approval_status/properties/target_type"
+
approver_group_key:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approver_group_key"
+
dynamic_approver_type_id:
+
"$ref": "#/components/schemas/resource_approval_status/properties/dynamic_approver_type_id"
+
fallback_approver_type_id:
+
"$ref": "#/components/schemas/resource_approval_status/properties/fallback_approver_type_id"
+
relationships:
+
type: object
+
properties:
+
booking:
+
"$ref": "#/components/schemas/_single_relationship"
+
expense:
+
"$ref": "#/components/schemas/_single_relationship"
+
approver:
+
"$ref": "#/components/schemas/_single_relationship"
+
time_entry:
+
"$ref": "#/components/schemas/_single_relationship"
+
actual_approver:
+
"$ref": "#/components/schemas/_single_relationship"
+
approval_workflow:
+
"$ref": "#/components/schemas/_single_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
~
Response
modified
single_todo
Schema changes
"$ref": "#/components/schemas/resource_todo/properties/closed_at"
created_at:
"$ref": "#/components/schemas/resource_todo/properties/created_at"
-
description:
-
"$ref": "#/components/schemas/resource_todo/properties/description"
todoable_type:
"$ref": "#/components/schemas/resource_todo/properties/todoable_type"
relationships:
~
Response
modified
collection_todo
Schema changes
"$ref": "#/components/schemas/resource_todo/properties/closed_at"
created_at:
"$ref": "#/components/schemas/resource_todo/properties/created_at"
-
description:
-
"$ref": "#/components/schemas/resource_todo/properties/description"
todoable_type:
"$ref": "#/components/schemas/resource_todo/properties/todoable_type"
relationships:
+
Response
added
single_approval_status
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
note:
+
"$ref": "#/components/schemas/resource_approval_status/properties/note"
+
approved_at:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approved_at"
+
rejected_at:
+
"$ref": "#/components/schemas/resource_approval_status/properties/rejected_at"
+
target_type:
+
"$ref": "#/components/schemas/resource_approval_status/properties/target_type"
+
approver_group_key:
+
"$ref": "#/components/schemas/resource_approval_status/properties/approver_group_key"
+
dynamic_approver_type_id:
+
"$ref": "#/components/schemas/resource_approval_status/properties/dynamic_approver_type_id"
+
fallback_approver_type_id:
+
"$ref": "#/components/schemas/resource_approval_status/properties/fallback_approver_type_id"
+
relationships:
+
type: object
+
properties:
+
booking:
+
"$ref": "#/components/schemas/_single_relationship"
+
expense:
+
"$ref": "#/components/schemas/_single_relationship"
+
approver:
+
"$ref": "#/components/schemas/_single_relationship"
+
time_entry:
+
"$ref": "#/components/schemas/_single_relationship"
+
actual_approver:
+
"$ref": "#/components/schemas/_single_relationship"
+
approval_workflow:
+
"$ref": "#/components/schemas/_single_relationship"
+
meta:
+
"$ref": "#/components/schemas/_meta"
+
included:
+
type: array
+
items: {}
+
+
Request body
added
agent_config
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
required:
+
- agent_id
+
properties:
+
agent_id:
+
"$ref": "#/components/schemas/resource_agent_config/properties/agent_id"
+
instructions:
+
"$ref": "#/components/schemas/resource_agent_config/properties/instructions"
+
+
Request body
added
agent_role
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
permissions:
+
"$ref": "#/components/schemas/resource_role/properties/permissions"
+
+
Request body
added
agent_config_update
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
instructions:
+
"$ref": "#/components/schemas/resource_agent_config/properties/instructions"
+
+
Request body
added
agent
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
required:
+
- name
+
- manager_id
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_agent/properties/name"
+
title:
+
"$ref": "#/components/schemas/resource_agent/properties/title"
+
avatar_url:
+
"$ref": "#/components/schemas/resource_agent/properties/avatar_url"
+
manager_id:
+
"$ref": "#/components/schemas/resource_agent/properties/manager_id"
+
custom_role_id:
+
"$ref": "#/components/schemas/resource_agent/properties/custom_role_id"
+
~
Request body
modified
task_dependency
Schema changes
required:
- dependent_task_id
- task_id
-
- type_id
properties:
task_id:
"$ref": "#/components/schemas/resource_task_dependency/properties/task_id"
~
Request body
modified
task_list
Schema changes
required:
- name
- project_id
-
- folder_id
properties:
name:
"$ref": "#/components/schemas/resource_task_list/properties/name"
+
board_id:
+
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
+
x-required: Required if folder_id is not present
position:
"$ref": "#/components/schemas/resource_task_list/properties/position"
folder_id:
"$ref": "#/components/schemas/resource_task_list/properties/folder_id"
+
x-required: Required if board_id is not present
project_id:
"$ref": "#/components/schemas/resource_task_list/properties/project_id"
~
Request body
modified
folder
Schema changes
type: object
required:
- name
-
- project_id
properties:
name:
"$ref": "#/components/schemas/resource_folder/properties/name"
~
Request body
modified
task
Schema changes
"$ref": "#/components/schemas/resource_task/properties/start_date"
assignee_id:
"$ref": "#/components/schemas/resource_task/properties/assignee_id"
-
description:
-
"$ref": "#/components/schemas/resource_task/properties/description"
task_list_id:
"$ref": "#/components/schemas/resource_task/properties/task_list_id"
custom_fields:
~
Request body
modified
todo
Schema changes
properties:
attributes:
type: object
-
required:
-
- description
properties:
closed:
"$ref": "#/components/schemas/resource_todo/properties/closed"
...
x-required: Required if deal_id is not present
due_date:
"$ref": "#/components/schemas/resource_todo/properties/due_date"
+
x-required: Required if due_time is present
+
due_time:
+
"$ref": "#/components/schemas/resource_todo/properties/due_time"
position:
"$ref": "#/components/schemas/resource_todo/properties/position"
assignee_id:
"$ref": "#/components/schemas/resource_todo/properties/assignee_id"
-
description:
-
"$ref": "#/components/schemas/resource_todo/properties/description"
+
Get agent configs
GET
Operation
added
/api/v2/agent_configs/get
Schema changes
+
tags:
+
- Agent Configs
+
summary: Get agent configs
+
responses:
+
'200':
+
"$ref": "#/components/responses/collection_agent_config"
+
parameters:
+
- "$ref": "#/components/parameters/filter_agent_config"
+
- "$ref": "#/components/parameters/sort_agent_config"
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: agent-configs-index
+
+
Create an agent config
POST
Operation
added
/api/v2/agent_configs/post
Schema changes
+
tags:
+
- Agent Configs
+
summary: Create an agent config
+
responses:
+
'201':
+
"$ref": "#/components/responses/single_agent_config"
+
'422':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
parameters:
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: agent-configs-create
+
requestBody:
+
"$ref": "#/components/requestBodies/agent_config"
+
+
Delete an agent config
DELETE
Operation
added
/api/v2/agent_configs/{id}/delete
Schema changes
+
tags:
+
- Agent Configs
+
summary: Delete an agent config
+
responses:
+
'204': {}
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: agent-configs-destroy
+
+
Get an agent config
GET
Operation
added
/api/v2/agent_configs/{id}/get
Schema changes
+
tags:
+
- Agent Configs
+
summary: Get an agent config
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_agent_config"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: agent-configs-show
+
+
Update an agent config
PATCH
Operation
added
/api/v2/agent_configs/{id}/patch
Schema changes
+
tags:
+
- Agent Configs
+
summary: Update an agent config
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_agent_config"
+
'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"
+
operationId: agent-configs-update
+
requestBody:
+
"$ref": "#/components/requestBodies/agent_config_update"
+
+
Get an agent role
GET
Operation
added
/api/v2/agent_roles/{id}/get
Schema changes
+
tags:
+
- Agent Roles
+
summary: Get an agent role
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_role"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: agent-roles-show
+
+
Update an agent role
PATCH
Operation
added
/api/v2/agent_roles/{id}/patch
Schema changes
+
tags:
+
- Agent Roles
+
summary: Update an agent role
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_role"
+
'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"
+
operationId: agent-roles-update
+
requestBody:
+
"$ref": "#/components/requestBodies/agent_role"
+
+
Get agents
GET
Operation
added
/api/v2/agents/get
Schema changes
+
tags:
+
- Agents
+
summary: Get agents
+
responses:
+
'200':
+
"$ref": "#/components/responses/collection_agent"
+
parameters:
+
- "$ref": "#/components/parameters/filter_agent"
+
- "$ref": "#/components/parameters/sort_agent"
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: agents-index
+
+
Create an agent
POST
Operation
added
/api/v2/agents/post
Schema changes
+
tags:
+
- Agents
+
summary: Create an agent
+
responses:
+
'201':
+
"$ref": "#/components/responses/single_agent"
+
'422':
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
parameters:
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: agents-create
+
requestBody:
+
"$ref": "#/components/requestBodies/agent"
+
+
Get an agent
GET
Operation
added
/api/v2/agents/{id}/get
Schema changes
+
tags:
+
- Agents
+
summary: Get an agent
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_agent"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: agents-show
+
+
Update an agent
PATCH
Operation
added
/api/v2/agents/{id}/patch
Schema changes
+
tags:
+
- Agents
+
summary: Update an agent
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_agent"
+
'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"
+
operationId: agents-update
+
requestBody:
+
"$ref": "#/components/requestBodies/agent"
+
+
Activate an agent
PATCH
Operation
added
/api/v2/agents/{id}/activate/patch
Schema changes
+
tags:
+
- Agents
+
summary: Activate an agent
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_agent"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: agents-activate-activate
+
+
Deactivate an agent
PATCH
Operation
added
/api/v2/agents/{id}/deactivate/patch
Schema changes
+
tags:
+
- Agents
+
summary: Deactivate an agent
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_agent"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: agents-deactivate-deactivate
+
+
Generate a JWT for an agent
POST
Operation
added
/api/v2/agents/{id}/jwt/post
Schema changes
+
tags:
+
- Agents
+
summary: Generate a JWT for an agent
+
responses:
+
'201':
+
content:
+
application/json:
+
schema:
+
type: object
+
properties:
+
jwt:
+
type: string
+
payload:
+
type: object
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
x-internal: true
+
operationId: agents-jwt
+
-
Get approval statuses
GET
Operation
removed
/api/v2/approval_statuses/get
Schema changes
-
tags:
-
- Approval Status
-
summary: Get approval statuses
-
responses:
-
'200':
-
"$ref": "#/components/responses/collection_approval_status"
-
parameters:
-
- "$ref": "#/components/parameters/filter_approval_status"
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: approval_statuses-index
-
+
Get approval statuses
GET
Operation
added
/api/v2/approval_statuses/get
Schema changes
+
tags:
+
- Approval Status
+
summary: Get approval statuses
+
responses:
+
'200':
+
"$ref": "#/components/responses/collection_approval_status"
+
parameters:
+
- "$ref": "#/components/parameters/filter_approval_status"
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: approval_statuses-index
+
-
Gets the approval status
GET
Operation
removed
/api/v2/approval_statuses/{id}/get
Schema changes
-
tags:
-
- Approval Status
-
summary: Gets the approval status
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_approval_status"
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: approval_statuses-show
-
+
Gets the approval status
GET
Operation
added
/api/v2/approval_statuses/{id}/get
Schema changes
+
tags:
+
- Approval Status
+
summary: Gets the approval status
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_approval_status"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: approval_statuses-show
+
-
Approves an approval status
PATCH
Operation
removed
/api/v2/approval_statuses/{id}/approve/patch
Schema changes
-
tags:
-
- Approval Status
-
summary: Approves an approval status
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_approval_status"
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: approval_statuses-approve-approve
-
+
Approves an approval status
PATCH
Operation
added
/api/v2/approval_statuses/{id}/approve/patch
Schema changes
+
tags:
+
- Approval Status
+
summary: Approves an approval status
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_approval_status"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: approval_statuses-approve-approve
+
-
Rejects an approval status
PATCH
Operation
removed
/api/v2/approval_statuses/{id}/reject/patch
Schema changes
-
tags:
-
- Approval Status
-
summary: Rejects an approval status
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_approval_status"
-
parameters:
-
- in: path
-
name: id
-
schema:
-
type: string
-
required: true
-
- "$ref": "#/components/parameters/header_organization"
-
operationId: approval_statuses-reject-reject
-
+
Rejects an approval status
PATCH
Operation
added
/api/v2/approval_statuses/{id}/reject/patch
Schema changes
+
tags:
+
- Approval Status
+
summary: Rejects an approval status
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_approval_status"
+
parameters:
+
- in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
- "$ref": "#/components/parameters/header_organization"
+
operationId: approval_statuses-reject-reject
+
-
Get backoffice organization reports
GET
Operation
removed
/api/v2/backoffice/reports/organization_reports/get
Schema changes
-
tags:
-
- Backoffice Organization Reports
-
summary: Get backoffice organization reports
-
responses:
-
'200':
-
"$ref": "#/components/responses/collection_backoffice_organization_report"
-
parameters:
-
- "$ref": "#/components/parameters/filter_backoffice_organization_report"
-
- "$ref": "#/components/parameters/sort_backoffice_organization_report"
-
- "$ref": "#/components/parameters/group_backoffice_organization_report"
-
x-internal: true
-
x-resource: resource_backoffice_organization_report
-
operationId: backoffice-organization_reports-index
-
+
Get backoffice organization reports
GET
Operation
added
/api/v2/backoffice/reports/organization_reports/get
Schema changes
+
tags:
+
- Backoffice Organization Reports
+
summary: Get backoffice organization reports
+
responses:
+
'200':
+
"$ref": "#/components/responses/collection_backoffice_organization_report"
+
parameters:
+
- "$ref": "#/components/parameters/filter_backoffice_organization_report"
+
- "$ref": "#/components/parameters/sort_backoffice_organization_report"
+
- "$ref": "#/components/parameters/group_backoffice_organization_report"
+
x-internal: true
+
x-resource: resource_backoffice_organization_report
+
operationId: backoffice-organization_reports-index
+
-
Copy a folder
POST
Request body
removed
/api/v2/folders/copy/post/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/folder_copy"
-
~
Copy a folder
POST
Response
modified
/api/v2/folders/copy/post/responses/201
Schema changes
-
"$ref": "#/components/responses/single_folder"
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
-
Copy a folder
POST
Response
removed
/api/v2/folders/copy/post/responses/422
Schema changes
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
-
Move a folder
PATCH
Request body
removed
/api/v2/folders/{id}/move/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/folder_move"
-
-
Reposition a folder
PATCH
Request body
removed
/api/v2/folders/{id}/reposition/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/folder_reposition"
-
~
Get task dependencies
GET
Operation
modified
/api/v2/task_dependencies/get
Schema changes
tags:
- TaskDependency
-
summary: Get task
dependencies
+
summary: Get task
dependncies
operationId: task_dependencies-index
-
Create a task dependency
POST
Response
removed
/api/v2/task_dependencies/post/responses/403
Schema changes
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
-
Update a task dependency
PATCH
Response
removed
/api/v2/task_dependencies/{id}/patch/responses/403
Schema changes
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
-
Copies a task list
POST
Request body
removed
/api/v2/task_lists/copy/post/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/task_list_copy"
-
~
Copies a task list
POST
Response
modified
/api/v2/task_lists/copy/post/responses/201
Schema changes
-
"$ref": "#/components/responses/single_task_list"
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
-
Copies a task list
POST
Response
removed
/api/v2/task_lists/copy/post/responses/422
Schema changes
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
-
Update a task list
PATCH
Response
removed
/api/v2/task_lists/{id}/patch/responses/422
Schema changes
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
-
Moves a task list
PATCH
Request body
removed
/api/v2/task_lists/{id}/move/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/task_list_move"
-
~
Repositions a task list
PATCH
Operation
modified
/api/v2/task_lists/{id}/reposition/patch
Schema changes
tags:
- Task Lists
-
summary:
Repositions
a task list
+
summary:
Repoisition
a task list
operationId: task_lists-reposition-reposition
-
Repositions a task list
PATCH
Request body
removed
/api/v2/task_lists/{id}/reposition/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/task_list_reposition"
-
~
Copies a task
POST
Response
modified
/api/v2/tasks/copy/post/responses/201
Schema changes
-
"$ref": "#/components/responses/single_task"
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
-
Copies a task
POST
Request body
removed
/api/v2/tasks/copy/post/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/task_copy"
-
-
Moves a task and its dependent tasks by a given number of working days
PATCH
Operation
removed
/api/v2/tasks/{id}/move_dependent/patch
Schema changes
-
tags:
-
- Tasks
-
summary: Moves a task and its dependent tasks by a given number of working days
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_task"
-
'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"
-
operationId: tasks-move-dependent-move-dependent
-
requestBody:
-
"$ref": "#/components/requestBodies/task_move_dependent"
-
-
Repositions a task
PATCH
Request body
removed
/api/v2/tasks/{id}/reposition/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/task_reposition"
-
~
Repositions a task
PATCH
Response
modified
/api/v2/tasks/{id}/reposition/patch/responses/204
Schema changes
-
--- {}
+
content:
+
any: {}
+
headers: {}
-
Update a todo
PATCH
Response
removed
/api/v2/todos/{id}/patch/responses/403
Schema changes
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
May 29, 2026
28 changes
28 changes
click to expand
+
Request body
added
task_dependency_update
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
required:
+
- type_id
+
properties:
+
type_id:
+
"$ref": "#/components/schemas/resource_task_dependency/properties/type_id"
+
~
Request body
modified
task_dependency
Schema changes
required:
- dependent_task_id
- task_id
+
- type_id
properties:
task_id:
"$ref": "#/components/schemas/resource_task_dependency/properties/task_id"
~
Request body
modified
task_list
Schema changes
required:
- name
- project_id
-
- folder_id
properties:
name:
"$ref": "#/components/schemas/resource_task_list/properties/name"
+
board_id:
+
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
+
x-required: Required if folder_id is not present
position:
"$ref": "#/components/schemas/resource_task_list/properties/position"
folder_id:
"$ref": "#/components/schemas/resource_task_list/properties/folder_id"
+
x-required: Required if board_id is not present
project_id:
"$ref": "#/components/schemas/resource_task_list/properties/project_id"
~
Request body
modified
folder
Schema changes
type: object
required:
- name
-
- project_id
properties:
name:
"$ref": "#/components/schemas/resource_folder/properties/name"
~
Request body
modified
task
Schema changes
"$ref": "#/components/schemas/resource_task/properties/start_date"
assignee_id:
"$ref": "#/components/schemas/resource_task/properties/assignee_id"
-
description:
-
"$ref": "#/components/schemas/resource_task/properties/description"
task_list_id:
"$ref": "#/components/schemas/resource_task/properties/task_list_id"
custom_fields:
~
Schema
modified
filter_task_list
Schema changes
not_contain:
"$ref": "#/components/schemas/resource_task_list/properties/status"
- "$ref": "#/components/schemas/resource_task_list/properties/status"
+
board_id:
+
oneOf:
+
- type: object
+
title: Operation
+
properties:
+
eq:
+
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
+
not_eq:
+
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
+
contains:
+
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
+
not_contain:
+
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
+
- "$ref": "#/components/schemas/resource_task_list/properties/board_id"
folder_id:
oneOf:
- type: object
...
- "$ref": "#/components/schemas/resource_task_list/properties/restorable"
x-internal: true
patternProperties:
+
"^board..*$":
+
title: Board relationship
"^folder..*$":
title: Folder relationship
"^project..*$":
~
Schema
modified
resource_task_list
Schema changes
x-used-in:
- serializer
- form
+
board:
+
title: Board
+
x-used-in:
+
- serializer
+
x-relationship: has_one
+
x-related-resource: resource_board
query:
type: string
title: Query
...
- serializer
x-relationship: has_one
x-related-resource: resource_project
+
board_id:
+
type: integer
+
title: Board
+
x-used-in:
+
- form
+
- filter
position:
type: integer
title: Position
...
title: Placement
x-used-in:
- serializer
+
board_name:
+
title: Board Name
+
x-used-in:
+
- sorter
project_id:
type: integer
title: Project
...
x-used-in:
- serializer
folder_name:
-
type: string
title: Folder Name
x-used-in:
- sorter
company_name:
-
type: string
title: Company Name
x-used-in:
- sorter
...
x-relationship: has_one
x-related-resource: resource_organization
project_name:
-
type: string
title: Project Name
x-used-in:
- sorter
~
Schema
modified
resource_task
Schema changes
- serializer
x-relationship: has_many
x-related-resource: resource_attachment
-
description:
-
type: string
-
title: Description
-
nullable: true
-
x-used-in:
-
- serializer
-
- form
due_date_on:
type: string
title: Due Date On
-
Copy a folder
POST
Response
removed
/api/v2/folders/copy/post/responses/422
Schema changes
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
~
Copy a folder
POST
Response
modified
/api/v2/folders/copy/post/responses/201
Schema changes
-
"$ref": "#/components/responses/single_folder"
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
-
Copy a folder
POST
Request body
removed
/api/v2/folders/copy/post/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/folder_copy"
-
-
Move a folder
PATCH
Request body
removed
/api/v2/folders/{id}/move/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/folder_move"
-
-
Reposition a folder
PATCH
Request body
removed
/api/v2/folders/{id}/reposition/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/folder_reposition"
-
~
Get task dependencies
GET
Operation
modified
/api/v2/task_dependencies/get
Schema changes
tags:
- TaskDependency
-
summary: Get task
dependncies
+
summary: Get task
dependencies
operationId: task_dependencies-index
+
Create a task dependency
POST
Response
added
/api/v2/task_dependencies/post/responses/403
Schema changes
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
+
Update a task dependency
PATCH
Response
added
/api/v2/task_dependencies/{id}/patch/responses/403
Schema changes
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
-
Copies a task list
POST
Response
removed
/api/v2/task_lists/copy/post/responses/422
Schema changes
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
~
Copies a task list
POST
Response
modified
/api/v2/task_lists/copy/post/responses/201
Schema changes
-
"$ref": "#/components/responses/single_task_list"
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
-
Copies a task list
POST
Request body
removed
/api/v2/task_lists/copy/post/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/task_list_copy"
-
-
Update a task list
PATCH
Response
removed
/api/v2/task_lists/{id}/patch/responses/422
Schema changes
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
-
Moves a task list
PATCH
Request body
removed
/api/v2/task_lists/{id}/move/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/task_list_move"
-
-
Repositions a task list
PATCH
Request body
removed
/api/v2/task_lists/{id}/reposition/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/task_list_reposition"
-
~
Repositions a task list
PATCH
Operation
modified
/api/v2/task_lists/{id}/reposition/patch
Schema changes
tags:
- Task Lists
-
summary:
Repositions
a task list
+
summary:
Repoisition
a task list
operationId: task_lists-reposition-reposition
~
Copies a task
POST
Response
modified
/api/v2/tasks/copy/post/responses/201
Schema changes
-
"$ref": "#/components/responses/single_task"
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
-
Copies a task
POST
Request body
removed
/api/v2/tasks/copy/post/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/task_copy"
-
-
Moves a task and its dependent tasks by a given number of working days
PATCH
Operation
removed
/api/v2/tasks/{id}/move_dependent/patch
Schema changes
-
tags:
-
- Tasks
-
summary: Moves a task and its dependent tasks by a given number of working days
-
responses:
-
'200':
-
"$ref": "#/components/responses/single_task"
-
'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"
-
operationId: tasks-move-dependent-move-dependent
-
requestBody:
-
"$ref": "#/components/requestBodies/task_move_dependent"
-
-
Repositions a task
PATCH
Request body
removed
/api/v2/tasks/{id}/reposition/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/task_reposition"
-
~
Repositions a task
PATCH
Response
modified
/api/v2/tasks/{id}/reposition/patch/responses/204
Schema changes
-
--- {}
+
content:
+
any: {}
+
headers: {}
May 28, 2026
33 changes
33 changes
click to expand
+
Request body
added
todo_update
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
closed:
+
"$ref": "#/components/schemas/resource_todo/properties/closed"
+
deal_id:
+
"$ref": "#/components/schemas/resource_todo/properties/deal_id"
+
x-required: Required if task_id is not present
+
task_id:
+
"$ref": "#/components/schemas/resource_todo/properties/task_id"
+
x-required: Required if deal_id is not present
+
due_date:
+
"$ref": "#/components/schemas/resource_todo/properties/due_date"
+
position:
+
"$ref": "#/components/schemas/resource_todo/properties/position"
+
assignee_id:
+
"$ref": "#/components/schemas/resource_todo/properties/assignee_id"
+
description:
+
"$ref": "#/components/schemas/resource_todo/properties/description"
+
-
Request body
removed
folder_reposition
Schema changes
-
content:
-
application/vnd.api+json:
-
schema:
-
type: object
-
properties:
-
data:
-
type: object
-
properties:
-
attributes:
-
type: object
-
properties:
-
move_after_id:
-
type: integer
-
move_before_id:
-
type: integer
-
~
Request body
modified
todo
Schema changes
properties:
attributes:
type: object
+
required:
+
- description
properties:
closed:
"$ref": "#/components/schemas/resource_todo/properties/closed"
...
x-required: Required if deal_id is not present
due_date:
"$ref": "#/components/schemas/resource_todo/properties/due_date"
-
x-required: Required if due_time is present
-
due_time:
-
"$ref": "#/components/schemas/resource_todo/properties/due_time"
position:
"$ref": "#/components/schemas/resource_todo/properties/position"
assignee_id:
"$ref": "#/components/schemas/resource_todo/properties/assignee_id"
+
description:
+
"$ref": "#/components/schemas/resource_todo/properties/description"
-
Request body
removed
folder_copy
Schema changes
-
content:
-
application/vnd.api+json:
-
schema:
-
type: object
-
properties:
-
data:
-
type: object
-
properties:
-
attributes:
-
type: object
-
required:
-
- name
-
- template_id
-
- project_id
-
properties:
-
name:
-
"$ref": "#/components/schemas/resource_folder/properties/name"
-
project_id:
-
"$ref": "#/components/schemas/resource_folder/properties/project_id"
-
template_id:
-
type: integer
-
-
Request body
removed
folder_move
Schema changes
-
content:
-
application/vnd.api+json:
-
schema:
-
type: object
-
properties:
-
data:
-
type: object
-
properties:
-
attributes:
-
type: object
-
required:
-
- project_id
-
properties:
-
map:
-
type: object
-
additionalProperties:
-
type: integer
-
project_id:
-
"$ref": "#/components/schemas/resource_folder/properties/project_id"
-
-
Request body
removed
folder_update
Schema changes
-
content:
-
application/vnd.api+json:
-
schema:
-
type: object
-
properties:
-
data:
-
type: object
-
properties:
-
attributes:
-
type: object
-
properties:
-
name:
-
"$ref": "#/components/schemas/resource_folder/properties/name"
-
hidden:
-
"$ref": "#/components/schemas/resource_folder/properties/hidden"
-
position:
-
"$ref": "#/components/schemas/resource_folder/properties/position"
-
project_id:
-
"$ref": "#/components/schemas/resource_folder/properties/project_id"
-
+
Request body
added
task_list_reposition
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
move_after_id:
+
type: integer
+
move_before_id:
+
type: integer
+
+
Request body
added
task_list_move
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
required:
+
- folder_id
+
properties:
+
map:
+
type: object
+
additionalProperties:
+
type: integer
+
folder_id:
+
"$ref": "#/components/schemas/resource_task_list/properties/folder_id"
+
+
Request body
added
task_list_update
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_task_list/properties/name"
+
position:
+
"$ref": "#/components/schemas/resource_task_list/properties/position"
+
folder_id:
+
"$ref": "#/components/schemas/resource_task_list/properties/folder_id"
+
project_id:
+
"$ref": "#/components/schemas/resource_task_list/properties/project_id"
+
+
Request body
added
task_list_copy
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
required:
+
- name
+
- template_id
+
- project_id
+
- folder_id
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_task_list/properties/name"
+
folder_id:
+
"$ref": "#/components/schemas/resource_task_list/properties/folder_id"
+
project_id:
+
"$ref": "#/components/schemas/resource_task_list/properties/project_id"
+
template_id:
+
type: integer
+
~
Request body
modified
task_list
Schema changes
required:
- name
- project_id
+
- folder_id
properties:
name:
"$ref": "#/components/schemas/resource_task_list/properties/name"
-
board_id:
-
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
-
x-required: Required if folder_id is not present
position:
"$ref": "#/components/schemas/resource_task_list/properties/position"
folder_id:
"$ref": "#/components/schemas/resource_task_list/properties/folder_id"
-
x-required: Required if board_id is not present
project_id:
"$ref": "#/components/schemas/resource_task_list/properties/project_id"
+
Request body
added
task_update
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
title:
+
"$ref": "#/components/schemas/resource_task/properties/title"
+
private:
+
"$ref": "#/components/schemas/resource_task/properties/private"
+
type_id:
+
"$ref": "#/components/schemas/resource_task/properties/type_id"
+
due_date:
+
"$ref": "#/components/schemas/resource_task/properties/due_date"
+
x-required: Required if due_time or start_date is present
+
due_time:
+
"$ref": "#/components/schemas/resource_task/properties/due_time"
+
tag_list:
+
"$ref": "#/components/schemas/resource_task/properties/tag_list"
+
project_id:
+
"$ref": "#/components/schemas/resource_task/properties/project_id"
+
service_id:
+
"$ref": "#/components/schemas/resource_task/properties/service_id"
+
start_date:
+
"$ref": "#/components/schemas/resource_task/properties/start_date"
+
assignee_id:
+
"$ref": "#/components/schemas/resource_task/properties/assignee_id"
+
description:
+
"$ref": "#/components/schemas/resource_task/properties/description"
+
task_list_id:
+
"$ref": "#/components/schemas/resource_task/properties/task_list_id"
+
custom_fields:
+
"$ref": "#/components/schemas/resource_task/properties/custom_fields"
+
attachment_ids:
+
"$ref": "#/components/schemas/resource_task/properties/attachment_ids"
+
parent_task_id:
+
"$ref": "#/components/schemas/resource_task/properties/parent_task_id"
+
remaining_time:
+
"$ref": "#/components/schemas/resource_task/properties/remaining_time"
+
repeat_on_date:
+
"$ref": "#/components/schemas/resource_task/properties/repeat_on_date"
+
x-required: Required for yearly repeat schedules
+
subscriber_ids:
+
"$ref": "#/components/schemas/resource_task/properties/subscriber_ids"
+
skip_reposition:
+
"$ref": "#/components/schemas/resource_task/properties/skip_reposition"
+
initial_estimate:
+
"$ref": "#/components/schemas/resource_task/properties/initial_estimate"
+
repeat_on_weekday:
+
"$ref": "#/components/schemas/resource_task/properties/repeat_on_weekday"
+
x-required: Required for weekly repeat schedules
+
repeat_on_interval:
+
"$ref": "#/components/schemas/resource_task/properties/repeat_on_interval"
+
x-required: Required if repeat_schedule_id is present
+
repeat_on_monthday:
+
"$ref": "#/components/schemas/resource_task/properties/repeat_on_monthday"
+
x-required: Required for monthly repeat schedules
+
repeat_schedule_id:
+
"$ref": "#/components/schemas/resource_task/properties/repeat_schedule_id"
+
workflow_status_id:
+
"$ref": "#/components/schemas/resource_task/properties/workflow_status_id"
+
+
Request body
added
folder_copy
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
required:
+
- name
+
- template_id
+
- project_id
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_folder/properties/name"
+
project_id:
+
"$ref": "#/components/schemas/resource_folder/properties/project_id"
+
template_id:
+
type: integer
+
~
Request body
modified
folder
Schema changes
type: object
required:
- name
+
- project_id
properties:
name:
"$ref": "#/components/schemas/resource_folder/properties/name"
+
Request body
added
folder_reposition
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
move_after_id:
+
type: integer
+
move_before_id:
+
type: integer
+
+
Request body
added
folder_move
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
required:
+
- project_id
+
properties:
+
map:
+
type: object
+
additionalProperties:
+
type: integer
+
project_id:
+
"$ref": "#/components/schemas/resource_folder/properties/project_id"
+
+
Request body
added
folder_update
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
name:
+
"$ref": "#/components/schemas/resource_folder/properties/name"
+
hidden:
+
"$ref": "#/components/schemas/resource_folder/properties/hidden"
+
position:
+
"$ref": "#/components/schemas/resource_folder/properties/position"
+
project_id:
+
"$ref": "#/components/schemas/resource_folder/properties/project_id"
+
~
Schema
modified
resource_todo
Schema changes
x-relationship: has_one
x-related-resource: resource_task
closed:
+
type: boolean
title: Closed
x-used-in:
- serializer
...
format: time
x-used-in:
- serializer
-
- form
position:
type: integer
title: Position
...
x-used-in:
- form
- filter
+
description:
+
type: string
+
title: Description
+
x-used-in:
+
- serializer
+
- form
organization:
title: Organization
x-used-in:
~
Schema
modified
filter_task_list
Schema changes
not_contain:
"$ref": "#/components/schemas/resource_task_list/properties/status"
- "$ref": "#/components/schemas/resource_task_list/properties/status"
-
board_id:
-
oneOf:
-
- type: object
-
title: Operation
-
properties:
-
eq:
-
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
-
not_eq:
-
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
-
contains:
-
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
-
not_contain:
-
"$ref": "#/components/schemas/resource_task_list/properties/board_id"
-
- "$ref": "#/components/schemas/resource_task_list/properties/board_id"
folder_id:
oneOf:
- type: object
...
- "$ref": "#/components/schemas/resource_task_list/properties/restorable"
x-internal: true
patternProperties:
-
"^board..*$":
-
title: Board relationship
"^folder..*$":
title: Folder relationship
"^project..*$":
~
Schema
modified
resource_task_list
Schema changes
x-used-in:
- serializer
- form
-
board:
-
title: Board
-
x-used-in:
-
- serializer
-
x-relationship: has_one
-
x-related-resource: resource_board
query:
type: string
title: Query
...
- serializer
x-relationship: has_one
x-related-resource: resource_project
-
board_id:
-
type: integer
-
title: Board
-
x-used-in:
-
- form
-
- filter
position:
type: integer
title: Position
...
title: Placement
x-used-in:
- serializer
-
board_name:
-
title: Board Name
-
x-used-in:
-
- sorter
project_id:
type: integer
title: Project
...
x-used-in:
- serializer
folder_name:
+
type: string
title: Folder Name
x-used-in:
- sorter
company_name:
+
type: string
title: Company Name
x-used-in:
- sorter
...
x-relationship: has_one
x-related-resource: resource_organization
project_name:
+
type: string
title: Project Name
x-used-in:
- sorter
~
Response
modified
single_todo
Schema changes
"$ref": "#/components/schemas/resource_todo/properties/closed_at"
created_at:
"$ref": "#/components/schemas/resource_todo/properties/created_at"
+
description:
+
"$ref": "#/components/schemas/resource_todo/properties/description"
todoable_type:
"$ref": "#/components/schemas/resource_todo/properties/todoable_type"
relationships:
~
Response
modified
collection_todo
Schema changes
"$ref": "#/components/schemas/resource_todo/properties/closed_at"
created_at:
"$ref": "#/components/schemas/resource_todo/properties/created_at"
+
description:
+
"$ref": "#/components/schemas/resource_todo/properties/description"
todoable_type:
"$ref": "#/components/schemas/resource_todo/properties/todoable_type"
relationships:
-
Copy a folder
POST
Response
removed
/api/v2/folders/copy/post/responses/422
Schema changes
-
content:
-
application/vnd.api+json: {}
-
headers:
-
Content-Type:
-
schema:
-
type: string
-
-
Copy a folder
POST
Response
removed
/api/v2/folders/copy/post/responses/200
Schema changes
-
"$ref": "#/components/responses/single_folder"
-
+
Copy a folder
POST
Response
added
/api/v2/folders/copy/post/responses/422
Schema changes
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
-
Copy a folder
POST
Request body
removed
/api/v2/folders/copy/post/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/folder_copy"
-
-
Move a folder
PATCH
Request body
removed
/api/v2/folders/{id}/move/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/folder_move"
-
-
Reposition a folder
PATCH
Request body
removed
/api/v2/folders/{id}/reposition/patch/requestBody
Schema changes
-
"$ref": "#/components/requestBodies/folder_reposition"
-
-
Copies a task list
POST
Response
removed
/api/v2/task_lists/copy/post/responses/200
Schema changes
-
"$ref": "#/components/responses/single_task_list"
-
+
Copies a task list
POST
Response
added
/api/v2/task_lists/copy/post/responses/422
Schema changes
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
+
Update a task list
PATCH
Response
added
/api/v2/task_lists/{id}/patch/responses/422
Schema changes
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
~
Repositions a task list
PATCH
Operation
modified
/api/v2/task_lists/{id}/reposition/patch
Schema changes
tags:
- Task Lists
-
summary:
Repoisition
a task list
+
summary:
Repositions
a task list
operationId: task_lists-reposition-reposition
+
Update a todo
PATCH
Response
added
/api/v2/todos/{id}/patch/responses/403
Schema changes
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
May 27, 2026
11 changes
11 changes
click to expand
~
Schema
modified
resource_task
Schema changes
- serializer
x-relationship: has_many
x-related-resource: resource_attachment
+
description:
+
type: string
+
title: Description
+
nullable: true
+
x-used-in:
+
- serializer
+
- form
due_date_on:
type: string
title: Due Date On
+
Request body
added
task_copy
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
required:
+
- title
+
- template_id
+
- project_id
+
- task_list_id
+
- workflow_status_id
+
- private
+
properties:
+
title:
+
"$ref": "#/components/schemas/resource_task/properties/title"
+
private:
+
"$ref": "#/components/schemas/resource_task/properties/private"
+
project_id:
+
"$ref": "#/components/schemas/resource_task/properties/project_id"
+
template_id:
+
type: integer
+
task_list_id:
+
"$ref": "#/components/schemas/resource_task/properties/task_list_id"
+
parent_task_id:
+
"$ref": "#/components/schemas/resource_task/properties/parent_task_id"
+
x-required: Required when copying as a subtask.
+
workflow_status_id:
+
"$ref": "#/components/schemas/resource_task/properties/workflow_status_id"
+
template_description:
+
type: string
+
copy_as_task_template:
+
type: boolean
+
+
Request body
added
task_reposition
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
properties:
+
subtask:
+
type: boolean
+
move_after_id:
+
type: integer
+
move_before_id:
+
type: integer
+
+
Request body
added
task_move_dependent
Schema changes
+
content:
+
application/vnd.api+json:
+
schema:
+
type: object
+
properties:
+
data:
+
type: object
+
properties:
+
attributes:
+
type: object
+
required:
+
- days_count
+
properties:
+
days_count:
+
type: integer
+
skip_root_task:
+
type: boolean
+
default: false
+
~
Request body
modified
task
Schema changes
"$ref": "#/components/schemas/resource_task/properties/start_date"
assignee_id:
"$ref": "#/components/schemas/resource_task/properties/assignee_id"
+
description:
+
"$ref": "#/components/schemas/resource_task/properties/description"
task_list_id:
"$ref": "#/components/schemas/resource_task/properties/task_list_id"
custom_fields:
-
Copies a task
POST
Response
removed
/api/v2/tasks/copy/post/responses/200
Schema changes
-
"$ref": "#/components/responses/single_task"
-
+
Moves a task and its dependent tasks by a given number of working days
PATCH
Parameter
added
/api/v2/tasks/{id}/move_dependent/patch/parameters/id
Schema changes
+
in: path
+
name: id
+
schema:
+
type: string
+
required: true
+
+
Moves a task and its dependent tasks by a given number of working days
PATCH
Operation
added
/api/v2/tasks/{id}/move_dependent/patch
Schema changes
+
tags:
+
- Tasks
+
summary: Moves a task and its dependent tasks by a given number of working days
+
responses:
+
'200':
+
"$ref": "#/components/responses/single_task"
+
'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"
+
operationId: tasks-move-dependent-move-dependent
+
requestBody:
+
"$ref": "#/components/requestBodies/task_move_dependent"
+
+
Moves a task and its dependent tasks by a given number of working days
PATCH
Response
added
/api/v2/tasks/{id}/move_dependent/patch/responses/422
Schema changes
+
content:
+
application/vnd.api+json: {}
+
headers:
+
Content-Type:
+
schema:
+
type: string
+
~
Repositions a task
PATCH
Response
modified
/api/v2/tasks/{id}/reposition/patch/responses/204
Schema changes
-
content:
+
--- {}
-
any: {}
-
headers: {}
-
Repositions a task
PATCH
Response
removed
/api/v2/tasks/{id}/reposition/patch/responses/200
Schema changes
-
"$ref": "#/components/responses/single_task"
-
Previous
Next
Showing page
1
of
16
(
112
dates with changes)
Previous
1
2
3
...
16
Next