{ "openapi": "3.1.1", "info": { "title": "Twenty Api", "description": "Use this page to explore and call the **REST API**.\n\n## Authentication\n\nSend a Bearer token with each request:\n\n```http\nAuthorization: Bearer \n```\n\nExample cURL:\n\n```bash\ncurl -H 'Authorization: Bearer ' /rest/core/companies\n```\n\nTokens can be generated in Settings → Playground and are workspace-scoped.\n\n\n## Filters\n\nUse the `filter` query parameter to narrow results.\n\n- Format: `field[COMPARATOR]:value`\n- Multiple conditions: `field1[eq]:1,field2[gte]:10` (root conjunction is AND)\n- Composite fields: `field.subField[COMPARATOR]:value`\n- Common comparators: `eq`, `neq`, `in`, `containsAny`, `is`, `gt`, `gte`, `lt`, `lte`, `startsWith`, `like`, `ilike`\n- Wildcards: For `like`/`ilike`, use `%` as a wildcard (e.g. `%value%` for substring match)\n\nExamples:\n\n```text\nfilter=status[eq]:\"open\"\nfilter=createdAt[gte]:\"2024-01-01\"\nfilter=owner.name[ilike]:\"%smith%\"\nfilter=id[in]:[\"id-1\",\"id-2\"]\nfilter=deletedAt[is]:NULL\nfilter=isActive[eq]:true\n```\n\nAdvanced (optional): `and(...)`, `or(...)`, `not(...)` (`not` wraps one condition)\n\n```text\nfilter=or(status[eq]:\"open\",assigneeId[is]:NULL)\n```\n\nNotes: Strings and dates are quoted; numbers are not.\n\n## Pagination and ordering\n\nAll list endpoints use cursor-based pagination.\n\n- Use **limit** to cap page size (default: 60, max: 60).\n- Use **starting_after** to fetch the next page (forward).\n- Use **ending_before** to fetch the previous page (backward).\n- Responses include **pageInfo** with `hasNextPage`, `startCursor`, and `endCursor`.\n\nExamples:\n\n```bash\n# First page\ncurl -H 'Authorization: Bearer ' \\\n '/rest/core/companies?limit=60'\n\n# Next page\ncurl -H 'Authorization: Bearer ' \\\n '/rest/core/companies?limit=60&starting_after='\n\n# Previous page\ncurl -H 'Authorization: Bearer ' \\\n '/rest/core/companies?limit=60&ending_before='\n```\n\nYou can combine pagination with filters and ordering.\n\nOrdering with `order_by`:\n- Shape: `field1,field2[DIRECTION2]`\n- Directions: AscNullsFirst, AscNullsLast, DescNullsFirst, DescNullsLast\n- Default per-field direction: AscNullsFirst\n\nExamples:\n```text\norder_by=createdAt\norder_by=id[AscNullsFirst],createdAt[DescNullsLast]\n```\n\n## Usage with LLMs\n\nYou can use AI to generate code based on the OpenAPI schema with the following URLs:\n\n```text\nCore: https://twenty.mardu.systems/rest/open-api/core?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MjNkMjUzZi01YzFlLTQ1NzktOWM0Yi1hZWJhOGQwYzViYjQiLCJ0eXBlIjoiQVBJX0tFWSIsIndvcmtzcGFjZUlkIjoiNjIzZDI1M2YtNWMxZS00NTc5LTljNGItYWViYThkMGM1YmI0IiwiaWF0IjoxNzcyMzk3NzI0LCJleHAiOjQ5MjU5OTc3MjMsImp0aSI6IjRiM2YzZWUwLTJmNWMtNGE4OS1hMzNjLTgyYTY4Mzk5YzRhNiJ9.tItC59wNx5x6jeF3jAm2405NxIUBhDMjYCIHlX-WYm0\nMetadata: https://twenty.mardu.systems/rest/open-api/metadata?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MjNkMjUzZi01YzFlLTQ1NzktOWM0Yi1hZWJhOGQwYzViYjQiLCJ0eXBlIjoiQVBJX0tFWSIsIndvcmtzcGFjZUlkIjoiNjIzZDI1M2YtNWMxZS00NTc5LTljNGItYWViYThkMGM1YmI0IiwiaWF0IjoxNzcyMzk3NzI0LCJleHAiOjQ5MjU5OTc3MjMsImp0aSI6IjRiM2YzZWUwLTJmNWMtNGE4OS1hMzNjLTgyYTY4Mzk5YzRhNiJ9.tItC59wNx5x6jeF3jAm2405NxIUBhDMjYCIHlX-WYm0\n```\n\nQuick prompt example (Cursor or any agent):\n\n```text\nHere is an OpenAPI schema for the Twenty REST API:\nhttps://twenty.mardu.systems/rest/open-api/core?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiI2MjNkMjUzZi01YzFlLTQ1NzktOWM0Yi1hZWJhOGQwYzViYjQiLCJ0eXBlIjoiQVBJX0tFWSIsIndvcmtzcGFjZUlkIjoiNjIzZDI1M2YtNWMxZS00NTc5LTljNGItYWViYThkMGM1YmI0IiwiaWF0IjoxNzcyMzk3NzI0LCJleHAiOjQ5MjU5OTc3MjMsImp0aSI6IjRiM2YzZWUwLTJmNWMtNGE4OS1hMzNjLTgyYTY4Mzk5YzRhNiJ9.tItC59wNx5x6jeF3jAm2405NxIUBhDMjYCIHlX-WYm0\n\nUse it to list companies created after 2024-01-01, ordered by createdAt desc, and include only 20 results.\n```\n\nNotes:\n- Treat the token like a secret; prefer a short-lived Playground token.\n- Most editors can fetch and process the schema even if it's large.\n", "termsOfService": "https://github.com/twentyhq/twenty?tab=coc-ov-file#readme", "contact": { "email": "felix@twenty.com" }, "license": { "name": "AGPL-3.0", "url": "https://github.com/twentyhq/twenty?tab=License-1-ov-file#readme" }, "version": "v0.1" }, "servers": [ { "url": "https://twenty.mardu.systems/rest/", "description": "Production Development" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Enter the token with the `Bearer: ` prefix, e.g. \"Bearer abcde12345\"." } }, "schemas": { "Attachment": { "type": "object", "description": "An attachment", "properties": { "name": { "type": "string", "description": "Attachment name" }, "fullPath": { "type": "string", "description": "Attachment full path" }, "fileCategory": { "type": "string", "enum": [ "ARCHIVE", "AUDIO", "IMAGE", "PRESENTATION", "SPREADSHEET", "TEXT_DOCUMENT", "VIDEO", "OTHER" ], "description": "Attachment file category" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "taskId": { "type": "string", "format": "uuid" }, "noteId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" }, "dashboardId": { "type": "string", "format": "uuid" }, "workflowId": { "type": "string", "format": "uuid" } }, "example": { "name": "Attachment name", "fileCategory": "ARCHIVE" } }, "AttachmentForUpdate": { "type": "object", "description": "An attachment", "properties": { "name": { "type": "string", "description": "Attachment name" }, "fullPath": { "type": "string", "description": "Attachment full path" }, "fileCategory": { "type": "string", "enum": [ "ARCHIVE", "AUDIO", "IMAGE", "PRESENTATION", "SPREADSHEET", "TEXT_DOCUMENT", "VIDEO", "OTHER" ], "description": "Attachment file category" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "taskId": { "type": "string", "format": "uuid" }, "noteId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" }, "dashboardId": { "type": "string", "format": "uuid" }, "workflowId": { "type": "string", "format": "uuid" } }, "example": { "name": "Attachment name", "fileCategory": "ARCHIVE" } }, "AttachmentForResponse": { "type": "object", "description": "An attachment", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "name": { "type": "string", "description": "Attachment name" }, "fullPath": { "type": "string", "description": "Attachment full path" }, "fileCategory": { "type": "string", "enum": [ "ARCHIVE", "AUDIO", "IMAGE", "PRESENTATION", "SPREADSHEET", "TEXT_DOCUMENT", "VIDEO", "OTHER" ], "description": "Attachment file category" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The workspace member who last updated the record" }, "taskId": { "type": "string", "format": "uuid" }, "noteId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" }, "dashboardId": { "type": "string", "format": "uuid" }, "workflowId": { "type": "string", "format": "uuid" }, "task": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TaskForResponse" } ], "description": "Attachment task" }, "note": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/NoteForResponse" } ], "description": "Attachment note" }, "person": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PersonForResponse" } ], "description": "Attachment person" }, "company": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CompanyForResponse" } ], "description": "Attachment company" }, "opportunity": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/OpportunityForResponse" } ], "description": "Attachment opportunity" }, "dashboard": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DashboardForResponse" } ], "description": "Attachment dashboard" }, "workflow": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkflowForResponse" } ], "description": "Attachment workflow" } } }, "Blocklist": { "type": "object", "description": "Blocklist", "properties": { "handle": { "type": "string", "description": "Handle" }, "workspaceMemberId": { "type": "string", "format": "uuid" } }, "example": { "workspaceMember": null }, "required": [ "workspaceMember" ] }, "BlocklistForUpdate": { "type": "object", "description": "Blocklist", "properties": { "handle": { "type": "string", "description": "Handle" }, "workspaceMemberId": { "type": "string", "format": "uuid" } }, "example": { "workspaceMember": null } }, "BlocklistForResponse": { "type": "object", "description": "Blocklist", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "handle": { "type": "string", "description": "Handle" }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "workspaceMember": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } ], "description": "WorkspaceMember" } } }, "CalendarChannelEventAssociation": { "type": "object", "description": "Calendar Channel Event Associations", "properties": { "eventExternalId": { "type": "string", "description": "Event external ID" }, "recurringEventExternalId": { "type": "string", "description": "Recurring Event ID" }, "calendarChannelId": { "type": "string", "format": "uuid" }, "calendarEventId": { "type": "string", "format": "uuid" } }, "example": { "calendarChannel": null, "calendarEvent": null }, "required": [ "calendarChannel", "calendarEvent" ] }, "CalendarChannelEventAssociationForUpdate": { "type": "object", "description": "Calendar Channel Event Associations", "properties": { "eventExternalId": { "type": "string", "description": "Event external ID" }, "recurringEventExternalId": { "type": "string", "description": "Recurring Event ID" }, "calendarChannelId": { "type": "string", "format": "uuid" }, "calendarEventId": { "type": "string", "format": "uuid" } }, "example": { "calendarChannel": null, "calendarEvent": null } }, "CalendarChannelEventAssociationForResponse": { "type": "object", "description": "Calendar Channel Event Associations", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "eventExternalId": { "type": "string", "description": "Event external ID" }, "recurringEventExternalId": { "type": "string", "description": "Recurring Event ID" }, "calendarChannelId": { "type": "string", "format": "uuid" }, "calendarEventId": { "type": "string", "format": "uuid" }, "calendarChannel": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CalendarChannelForResponse" } ], "description": "Channel ID" }, "calendarEvent": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CalendarEventForResponse" } ], "description": "Event ID" } } }, "CalendarChannel": { "type": "object", "description": "Calendar Channels", "properties": { "handle": { "type": "string", "description": "Handle" }, "visibility": { "type": "string", "enum": [ "METADATA", "SHARE_EVERYTHING" ], "description": "Visibility" }, "isContactAutoCreationEnabled": { "type": "boolean", "description": "Is Contact Auto Creation Enabled" }, "contactAutoCreationPolicy": { "type": "string", "enum": [ "AS_PARTICIPANT_AND_ORGANIZER", "AS_PARTICIPANT", "AS_ORGANIZER", "NONE" ], "description": "Automatically create records for people you participated with in an event." }, "isSyncEnabled": { "type": "boolean", "description": "Is Sync Enabled" }, "syncCursor": { "type": "string", "description": "Sync Cursor. Used for syncing events from the calendar provider" }, "syncStatus": { "type": "string", "enum": [ "ONGOING", "NOT_SYNCED", "ACTIVE", "FAILED_INSUFFICIENT_PERMISSIONS", "FAILED_UNKNOWN" ], "description": "Sync status" }, "syncStage": { "type": "string", "enum": [ "CALENDAR_EVENT_LIST_FETCH_PENDING", "CALENDAR_EVENT_LIST_FETCH_SCHEDULED", "CALENDAR_EVENT_LIST_FETCH_ONGOING", "CALENDAR_EVENTS_IMPORT_PENDING", "CALENDAR_EVENTS_IMPORT_SCHEDULED", "CALENDAR_EVENTS_IMPORT_ONGOING", "FAILED", "PENDING_CONFIGURATION" ], "description": "Sync stage" }, "syncStageStartedAt": { "type": "string", "format": "date-time", "description": "Sync stage started at" }, "syncedAt": { "type": "string", "format": "date-time", "description": "Last sync date" }, "throttleFailureCount": { "type": "integer", "description": "Throttle Failure Count" }, "connectedAccountId": { "type": "string", "format": "uuid" } }, "example": { "visibility": "METADATA", "contactAutoCreationPolicy": "AS_PARTICIPANT_AND_ORGANIZER", "syncStatus": "ONGOING", "syncStage": "CALENDAR_EVENT_LIST_FETCH_PENDING", "connectedAccount": null, "calendarChannelEventAssociations": null }, "required": [ "connectedAccount", "calendarChannelEventAssociations" ] }, "CalendarChannelForUpdate": { "type": "object", "description": "Calendar Channels", "properties": { "handle": { "type": "string", "description": "Handle" }, "visibility": { "type": "string", "enum": [ "METADATA", "SHARE_EVERYTHING" ], "description": "Visibility" }, "isContactAutoCreationEnabled": { "type": "boolean", "description": "Is Contact Auto Creation Enabled" }, "contactAutoCreationPolicy": { "type": "string", "enum": [ "AS_PARTICIPANT_AND_ORGANIZER", "AS_PARTICIPANT", "AS_ORGANIZER", "NONE" ], "description": "Automatically create records for people you participated with in an event." }, "isSyncEnabled": { "type": "boolean", "description": "Is Sync Enabled" }, "syncCursor": { "type": "string", "description": "Sync Cursor. Used for syncing events from the calendar provider" }, "syncStatus": { "type": "string", "enum": [ "ONGOING", "NOT_SYNCED", "ACTIVE", "FAILED_INSUFFICIENT_PERMISSIONS", "FAILED_UNKNOWN" ], "description": "Sync status" }, "syncStage": { "type": "string", "enum": [ "CALENDAR_EVENT_LIST_FETCH_PENDING", "CALENDAR_EVENT_LIST_FETCH_SCHEDULED", "CALENDAR_EVENT_LIST_FETCH_ONGOING", "CALENDAR_EVENTS_IMPORT_PENDING", "CALENDAR_EVENTS_IMPORT_SCHEDULED", "CALENDAR_EVENTS_IMPORT_ONGOING", "FAILED", "PENDING_CONFIGURATION" ], "description": "Sync stage" }, "syncStageStartedAt": { "type": "string", "format": "date-time", "description": "Sync stage started at" }, "syncedAt": { "type": "string", "format": "date-time", "description": "Last sync date" }, "throttleFailureCount": { "type": "integer", "description": "Throttle Failure Count" }, "connectedAccountId": { "type": "string", "format": "uuid" } }, "example": { "visibility": "METADATA", "contactAutoCreationPolicy": "AS_PARTICIPANT_AND_ORGANIZER", "syncStatus": "ONGOING", "syncStage": "CALENDAR_EVENT_LIST_FETCH_PENDING", "connectedAccount": null, "calendarChannelEventAssociations": null } }, "CalendarChannelForResponse": { "type": "object", "description": "Calendar Channels", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "handle": { "type": "string", "description": "Handle" }, "visibility": { "type": "string", "enum": [ "METADATA", "SHARE_EVERYTHING" ], "description": "Visibility" }, "isContactAutoCreationEnabled": { "type": "boolean", "description": "Is Contact Auto Creation Enabled" }, "contactAutoCreationPolicy": { "type": "string", "enum": [ "AS_PARTICIPANT_AND_ORGANIZER", "AS_PARTICIPANT", "AS_ORGANIZER", "NONE" ], "description": "Automatically create records for people you participated with in an event." }, "isSyncEnabled": { "type": "boolean", "description": "Is Sync Enabled" }, "syncCursor": { "type": "string", "description": "Sync Cursor. Used for syncing events from the calendar provider" }, "syncStatus": { "type": "string", "enum": [ "ONGOING", "NOT_SYNCED", "ACTIVE", "FAILED_INSUFFICIENT_PERMISSIONS", "FAILED_UNKNOWN" ], "description": "Sync status" }, "syncStage": { "type": "string", "enum": [ "CALENDAR_EVENT_LIST_FETCH_PENDING", "CALENDAR_EVENT_LIST_FETCH_SCHEDULED", "CALENDAR_EVENT_LIST_FETCH_ONGOING", "CALENDAR_EVENTS_IMPORT_PENDING", "CALENDAR_EVENTS_IMPORT_SCHEDULED", "CALENDAR_EVENTS_IMPORT_ONGOING", "FAILED", "PENDING_CONFIGURATION" ], "description": "Sync stage" }, "syncStageStartedAt": { "type": "string", "format": "date-time", "description": "Sync stage started at" }, "syncedAt": { "type": "string", "format": "date-time", "description": "Last sync date" }, "throttleFailureCount": { "type": "integer", "description": "Throttle Failure Count" }, "connectedAccountId": { "type": "string", "format": "uuid" }, "connectedAccount": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ConnectedAccountForResponse" } ], "description": "Connected Account" }, "calendarChannelEventAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" }, "description": "Calendar Channel Event Associations" } } }, "CalendarEventParticipant": { "type": "object", "description": "Calendar event participants", "properties": { "handle": { "type": "string", "description": "Handle" }, "displayName": { "type": "string", "description": "Display Name" }, "isOrganizer": { "type": "boolean", "description": "Is Organizer" }, "responseStatus": { "type": "string", "enum": [ "NEEDS_ACTION", "DECLINED", "TENTATIVE", "ACCEPTED" ], "description": "Response Status" }, "calendarEventId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "workspaceMemberId": { "type": "string", "format": "uuid" } }, "example": { "responseStatus": "NEEDS_ACTION", "calendarEvent": null }, "required": [ "calendarEvent" ] }, "CalendarEventParticipantForUpdate": { "type": "object", "description": "Calendar event participants", "properties": { "handle": { "type": "string", "description": "Handle" }, "displayName": { "type": "string", "description": "Display Name" }, "isOrganizer": { "type": "boolean", "description": "Is Organizer" }, "responseStatus": { "type": "string", "enum": [ "NEEDS_ACTION", "DECLINED", "TENTATIVE", "ACCEPTED" ], "description": "Response Status" }, "calendarEventId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "workspaceMemberId": { "type": "string", "format": "uuid" } }, "example": { "responseStatus": "NEEDS_ACTION", "calendarEvent": null } }, "CalendarEventParticipantForResponse": { "type": "object", "description": "Calendar event participants", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "handle": { "type": "string", "description": "Handle" }, "displayName": { "type": "string", "description": "Display Name" }, "isOrganizer": { "type": "boolean", "description": "Is Organizer" }, "responseStatus": { "type": "string", "enum": [ "NEEDS_ACTION", "DECLINED", "TENTATIVE", "ACCEPTED" ], "description": "Response Status" }, "calendarEventId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "calendarEvent": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CalendarEventForResponse" } ], "description": "Event ID" }, "person": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PersonForResponse" } ], "description": "Person" }, "workspaceMember": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } ], "description": "Workspace Member" } } }, "CalendarEvent": { "type": "object", "description": "Calendar events", "properties": { "title": { "type": "string", "description": "Title" }, "isCanceled": { "type": "boolean", "description": "Is canceled" }, "isFullDay": { "type": "boolean", "description": "Is Full Day" }, "startsAt": { "type": "string", "format": "date-time", "description": "Start Date" }, "endsAt": { "type": "string", "format": "date-time", "description": "End Date" }, "externalCreatedAt": { "type": "string", "format": "date-time", "description": "Creation DateTime" }, "externalUpdatedAt": { "type": "string", "format": "date-time", "description": "Update DateTime" }, "description": { "type": "string", "description": "Description" }, "location": { "type": "string", "description": "Location" }, "iCalUid": { "type": "string", "description": "iCal UID" }, "conferenceSolution": { "type": "string", "description": "Conference Solution" }, "conferenceLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "Meet Link" } }, "example": { "conferenceLink": { "primaryLinkLabel": "", "primaryLinkUrl": "https://roasted-solution.info", "secondaryLinks": [] }, "calendarChannelEventAssociations": null, "calendarEventParticipants": null }, "required": [ "calendarChannelEventAssociations", "calendarEventParticipants" ] }, "CalendarEventForUpdate": { "type": "object", "description": "Calendar events", "properties": { "title": { "type": "string", "description": "Title" }, "isCanceled": { "type": "boolean", "description": "Is canceled" }, "isFullDay": { "type": "boolean", "description": "Is Full Day" }, "startsAt": { "type": "string", "format": "date-time", "description": "Start Date" }, "endsAt": { "type": "string", "format": "date-time", "description": "End Date" }, "externalCreatedAt": { "type": "string", "format": "date-time", "description": "Creation DateTime" }, "externalUpdatedAt": { "type": "string", "format": "date-time", "description": "Update DateTime" }, "description": { "type": "string", "description": "Description" }, "location": { "type": "string", "description": "Location" }, "iCalUid": { "type": "string", "description": "iCal UID" }, "conferenceSolution": { "type": "string", "description": "Conference Solution" }, "conferenceLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "Meet Link" } }, "example": { "conferenceLink": { "primaryLinkLabel": "", "primaryLinkUrl": "https://pointed-tabletop.biz", "secondaryLinks": [] }, "calendarChannelEventAssociations": null, "calendarEventParticipants": null } }, "CalendarEventForResponse": { "type": "object", "description": "Calendar events", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "title": { "type": "string", "description": "Title" }, "isCanceled": { "type": "boolean", "description": "Is canceled" }, "isFullDay": { "type": "boolean", "description": "Is Full Day" }, "startsAt": { "type": "string", "format": "date-time", "description": "Start Date" }, "endsAt": { "type": "string", "format": "date-time", "description": "End Date" }, "externalCreatedAt": { "type": "string", "format": "date-time", "description": "Creation DateTime" }, "externalUpdatedAt": { "type": "string", "format": "date-time", "description": "Update DateTime" }, "description": { "type": "string", "description": "Description" }, "location": { "type": "string", "description": "Location" }, "iCalUid": { "type": "string", "description": "iCal UID" }, "conferenceSolution": { "type": "string", "description": "Conference Solution" }, "conferenceLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "Meet Link" }, "calendarChannelEventAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" }, "description": "Calendar Channel Event Associations" }, "calendarEventParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" }, "description": "Event Participants" } } }, "Company": { "type": "object", "description": "A company", "properties": { "name": { "type": "string", "description": "The company name" }, "domainName": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "The company website URL. We use this url to fetch the company icon" }, "address": { "type": "object", "properties": { "addressStreet1": { "type": "string" }, "addressStreet2": { "type": "string" }, "addressCity": { "type": "string" }, "addressPostcode": { "type": "string" }, "addressState": { "type": "string" }, "addressCountry": { "type": "string" }, "addressLat": { "type": "number" }, "addressLng": { "type": "number" } }, "description": "Address of the company" }, "employees": { "type": "integer", "description": "Number of employees in the company" }, "linkedinLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "The company Linkedin account" }, "xLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "The company Twitter/X account" }, "annualRecurringRevenue": { "type": "object", "properties": { "amountMicros": { "type": "number" }, "currencyCode": { "type": "string" } }, "description": "Annual Recurring Revenue: The actual or estimated annual revenue of the company" }, "idealCustomerProfile": { "type": "boolean", "description": "Ideal Customer Profile: Indicates whether the company is the most suitable and valuable customer for you" }, "position": { "type": "number", "description": "Company record position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "accountOwnerId": { "type": "string", "format": "uuid" } }, "example": { "name": "Company name", "domainName": { "primaryLinkLabel": "", "primaryLinkUrl": "https://impractical-stir-fry.biz", "secondaryLinks": [] }, "linkedinLink": { "primaryLinkLabel": "", "primaryLinkUrl": "https://agreeable-rubric.name", "secondaryLinks": [] }, "xLink": { "primaryLinkLabel": "", "primaryLinkUrl": "https://graceful-duffel.com/", "secondaryLinks": [] }, "annualRecurringRevenue": { "amountMicros": "153000000", "currencyCode": "EUR" } } }, "CompanyForUpdate": { "type": "object", "description": "A company", "properties": { "name": { "type": "string", "description": "The company name" }, "domainName": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "The company website URL. We use this url to fetch the company icon" }, "address": { "type": "object", "properties": { "addressStreet1": { "type": "string" }, "addressStreet2": { "type": "string" }, "addressCity": { "type": "string" }, "addressPostcode": { "type": "string" }, "addressState": { "type": "string" }, "addressCountry": { "type": "string" }, "addressLat": { "type": "number" }, "addressLng": { "type": "number" } }, "description": "Address of the company" }, "employees": { "type": "integer", "description": "Number of employees in the company" }, "linkedinLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "The company Linkedin account" }, "xLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "The company Twitter/X account" }, "annualRecurringRevenue": { "type": "object", "properties": { "amountMicros": { "type": "number" }, "currencyCode": { "type": "string" } }, "description": "Annual Recurring Revenue: The actual or estimated annual revenue of the company" }, "idealCustomerProfile": { "type": "boolean", "description": "Ideal Customer Profile: Indicates whether the company is the most suitable and valuable customer for you" }, "position": { "type": "number", "description": "Company record position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "accountOwnerId": { "type": "string", "format": "uuid" } }, "example": { "name": "Company name", "domainName": { "primaryLinkLabel": "", "primaryLinkUrl": "https://greedy-disappointment.com/", "secondaryLinks": [] }, "linkedinLink": { "primaryLinkLabel": "", "primaryLinkUrl": "https://pleasant-conversation.com/", "secondaryLinks": [] }, "xLink": { "primaryLinkLabel": "", "primaryLinkUrl": "https://adolescent-simple.biz/", "secondaryLinks": [] }, "annualRecurringRevenue": { "amountMicros": "138000000", "currencyCode": "EUR" } } }, "CompanyForResponse": { "type": "object", "description": "A company", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "name": { "type": "string", "description": "The company name" }, "domainName": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "The company website URL. We use this url to fetch the company icon" }, "address": { "type": "object", "properties": { "addressStreet1": { "type": "string" }, "addressStreet2": { "type": "string" }, "addressCity": { "type": "string" }, "addressPostcode": { "type": "string" }, "addressState": { "type": "string" }, "addressCountry": { "type": "string" }, "addressLat": { "type": "number" }, "addressLng": { "type": "number" } }, "description": "Address of the company" }, "employees": { "type": "integer", "description": "Number of employees in the company" }, "linkedinLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "The company Linkedin account" }, "xLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "The company Twitter/X account" }, "annualRecurringRevenue": { "type": "object", "properties": { "amountMicros": { "type": "number" }, "currencyCode": { "type": "string" } }, "description": "Annual Recurring Revenue: The actual or estimated annual revenue of the company" }, "idealCustomerProfile": { "type": "boolean", "description": "Ideal Customer Profile: Indicates whether the company is the most suitable and valuable customer for you" }, "position": { "type": "number", "description": "Company record position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The workspace member who last updated the record" }, "accountOwnerId": { "type": "string", "format": "uuid" }, "people": { "type": "array", "items": { "$ref": "#/components/schemas/PersonForResponse" }, "description": "People linked to the company." }, "accountOwner": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } ], "description": "Your team member responsible for managing the company account" }, "taskTargets": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTargetForResponse" }, "description": "Tasks tied to the company" }, "noteTargets": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTargetForResponse" }, "description": "Notes tied to the company" }, "opportunities": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityForResponse" }, "description": "Opportunities linked to the company." }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites linked to the company" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" }, "description": "Attachments linked to the company" }, "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "description": "Timeline Activities linked to the company" } } }, "ConnectedAccount": { "type": "object", "description": "A connected account", "properties": { "handle": { "type": "string", "description": "The account handle (email, username, phone number, etc.)" }, "provider": { "type": "string", "description": "The account provider" }, "accessToken": { "type": "string", "description": "Messaging provider access token" }, "refreshToken": { "type": "string", "description": "Messaging provider refresh token" }, "lastSyncHistoryId": { "type": "string", "description": "Last sync history ID" }, "authFailedAt": { "type": "string", "format": "date-time", "description": "Auth failed at" }, "lastCredentialsRefreshedAt": { "type": "string", "format": "date-time", "description": "Last credentials refreshed at" }, "handleAliases": { "type": "string", "description": "Handle Aliases" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Scopes" }, "connectionParameters": { "type": "object", "description": "JSON object containing custom connection parameters" }, "accountOwnerId": { "type": "string", "format": "uuid" } }, "example": { "accountOwner": null, "messageChannels": null, "calendarChannels": null }, "required": [ "accountOwner", "messageChannels", "calendarChannels" ] }, "ConnectedAccountForUpdate": { "type": "object", "description": "A connected account", "properties": { "handle": { "type": "string", "description": "The account handle (email, username, phone number, etc.)" }, "provider": { "type": "string", "description": "The account provider" }, "accessToken": { "type": "string", "description": "Messaging provider access token" }, "refreshToken": { "type": "string", "description": "Messaging provider refresh token" }, "lastSyncHistoryId": { "type": "string", "description": "Last sync history ID" }, "authFailedAt": { "type": "string", "format": "date-time", "description": "Auth failed at" }, "lastCredentialsRefreshedAt": { "type": "string", "format": "date-time", "description": "Last credentials refreshed at" }, "handleAliases": { "type": "string", "description": "Handle Aliases" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Scopes" }, "connectionParameters": { "type": "object", "description": "JSON object containing custom connection parameters" }, "accountOwnerId": { "type": "string", "format": "uuid" } }, "example": { "accountOwner": null, "messageChannels": null, "calendarChannels": null } }, "ConnectedAccountForResponse": { "type": "object", "description": "A connected account", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "handle": { "type": "string", "description": "The account handle (email, username, phone number, etc.)" }, "provider": { "type": "string", "description": "The account provider" }, "accessToken": { "type": "string", "description": "Messaging provider access token" }, "refreshToken": { "type": "string", "description": "Messaging provider refresh token" }, "lastSyncHistoryId": { "type": "string", "description": "Last sync history ID" }, "authFailedAt": { "type": "string", "format": "date-time", "description": "Auth failed at" }, "lastCredentialsRefreshedAt": { "type": "string", "format": "date-time", "description": "Last credentials refreshed at" }, "handleAliases": { "type": "string", "description": "Handle Aliases" }, "scopes": { "type": "array", "items": { "type": "string" }, "description": "Scopes" }, "connectionParameters": { "type": "object", "description": "JSON object containing custom connection parameters" }, "accountOwnerId": { "type": "string", "format": "uuid" }, "accountOwner": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } ], "description": "Account Owner" }, "messageChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelForResponse" }, "description": "Message Channels" }, "calendarChannels": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelForResponse" }, "description": "Calendar Channels" } } }, "Dashboard": { "type": "object", "description": "A dashboard", "properties": { "title": { "type": "string", "description": "Dashboard title" }, "position": { "type": "number", "description": "Dashboard record Position" }, "pageLayoutId": { "type": "string", "format": "uuid", "description": "Dashboard page layout" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" } }, "example": { "favorites": null }, "required": [ "favorites" ] }, "DashboardForUpdate": { "type": "object", "description": "A dashboard", "properties": { "title": { "type": "string", "description": "Dashboard title" }, "position": { "type": "number", "description": "Dashboard record Position" }, "pageLayoutId": { "type": "string", "format": "uuid", "description": "Dashboard page layout" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" } }, "example": { "favorites": null } }, "DashboardForResponse": { "type": "object", "description": "A dashboard", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "title": { "type": "string", "description": "Dashboard title" }, "position": { "type": "number", "description": "Dashboard record Position" }, "pageLayoutId": { "type": "string", "format": "uuid", "description": "Dashboard page layout" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The workspace member who last updated the record" }, "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "description": "Timeline activities linked to the dashboard" }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites linked to the dashboard" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" }, "description": "Attachments linked to the dashboard" } } }, "FavoriteFolder": { "type": "object", "description": "A favorite folder", "properties": { "position": { "type": "integer", "description": "Favorite folder position" }, "name": { "type": "string", "description": "Name of the favorite folder" } }, "example": { "name": "Favorite Folder name", "favorites": null }, "required": [ "favorites" ] }, "FavoriteFolderForUpdate": { "type": "object", "description": "A favorite folder", "properties": { "position": { "type": "integer", "description": "Favorite folder position" }, "name": { "type": "string", "description": "Name of the favorite folder" } }, "example": { "name": "Favorite Folder name", "favorites": null } }, "FavoriteFolderForResponse": { "type": "object", "description": "A favorite folder", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "position": { "type": "integer", "description": "Favorite folder position" }, "name": { "type": "string", "description": "Name of the favorite folder" }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites in this folder" } } }, "Favorite": { "type": "object", "description": "A favorite", "properties": { "position": { "type": "integer", "description": "Favorite position" }, "viewId": { "type": "string", "format": "uuid", "description": "ViewId" }, "forWorkspaceMemberId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" }, "workflowId": { "type": "string", "format": "uuid" }, "workflowVersionId": { "type": "string", "format": "uuid" }, "workflowRunId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "noteId": { "type": "string", "format": "uuid" }, "dashboardId": { "type": "string", "format": "uuid" }, "favoriteFolderId": { "type": "string", "format": "uuid" } }, "example": {} }, "FavoriteForUpdate": { "type": "object", "description": "A favorite", "properties": { "position": { "type": "integer", "description": "Favorite position" }, "viewId": { "type": "string", "format": "uuid", "description": "ViewId" }, "forWorkspaceMemberId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" }, "workflowId": { "type": "string", "format": "uuid" }, "workflowVersionId": { "type": "string", "format": "uuid" }, "workflowRunId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "noteId": { "type": "string", "format": "uuid" }, "dashboardId": { "type": "string", "format": "uuid" }, "favoriteFolderId": { "type": "string", "format": "uuid" } }, "example": {} }, "FavoriteForResponse": { "type": "object", "description": "A favorite", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "position": { "type": "integer", "description": "Favorite position" }, "viewId": { "type": "string", "format": "uuid", "description": "ViewId" }, "forWorkspaceMemberId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" }, "workflowId": { "type": "string", "format": "uuid" }, "workflowVersionId": { "type": "string", "format": "uuid" }, "workflowRunId": { "type": "string", "format": "uuid" }, "taskId": { "type": "string", "format": "uuid" }, "noteId": { "type": "string", "format": "uuid" }, "dashboardId": { "type": "string", "format": "uuid" }, "favoriteFolderId": { "type": "string", "format": "uuid" }, "forWorkspaceMember": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } ], "description": "Favorite workspace member" }, "person": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PersonForResponse" } ], "description": "Favorite person" }, "company": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CompanyForResponse" } ], "description": "Favorite company" }, "opportunity": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/OpportunityForResponse" } ], "description": "Favorite opportunity" }, "workflow": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkflowForResponse" } ], "description": "Favorite workflow" }, "workflowVersion": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkflowVersionForResponse" } ], "description": "Favorite workflow version" }, "workflowRun": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkflowRunForResponse" } ], "description": "Favorite workflow run" }, "task": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TaskForResponse" } ], "description": "Favorite task" }, "note": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/NoteForResponse" } ], "description": "Favorite note" }, "dashboard": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DashboardForResponse" } ], "description": "Favorite dashboard" }, "favoriteFolder": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/FavoriteFolderForResponse" } ], "description": "The folder this favorite belongs to" } } }, "MessageChannelMessageAssociation": { "type": "object", "description": "Message Synced with a Message Channel", "properties": { "messageExternalId": { "type": "string", "description": "Message id from the messaging provider" }, "messageThreadExternalId": { "type": "string", "description": "Thread id from the messaging provider" }, "direction": { "type": "string", "enum": [ "INCOMING", "OUTGOING" ], "description": "Message Direction" }, "messageChannelId": { "type": "string", "format": "uuid" }, "messageThreadId": { "type": "string", "format": "uuid" }, "messageId": { "type": "string", "format": "uuid" } }, "example": { "direction": "INCOMING" } }, "MessageChannelMessageAssociationForUpdate": { "type": "object", "description": "Message Synced with a Message Channel", "properties": { "messageExternalId": { "type": "string", "description": "Message id from the messaging provider" }, "messageThreadExternalId": { "type": "string", "description": "Thread id from the messaging provider" }, "direction": { "type": "string", "enum": [ "INCOMING", "OUTGOING" ], "description": "Message Direction" }, "messageChannelId": { "type": "string", "format": "uuid" }, "messageThreadId": { "type": "string", "format": "uuid" }, "messageId": { "type": "string", "format": "uuid" } }, "example": { "direction": "INCOMING" } }, "MessageChannelMessageAssociationForResponse": { "type": "object", "description": "Message Synced with a Message Channel", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "messageExternalId": { "type": "string", "description": "Message id from the messaging provider" }, "messageThreadExternalId": { "type": "string", "description": "Thread id from the messaging provider" }, "direction": { "type": "string", "enum": [ "INCOMING", "OUTGOING" ], "description": "Message Direction" }, "messageChannelId": { "type": "string", "format": "uuid" }, "messageThreadId": { "type": "string", "format": "uuid" }, "messageId": { "type": "string", "format": "uuid" }, "messageChannel": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MessageChannelForResponse" } ], "description": "Message Channel Id" }, "messageThread": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MessageThreadForResponse" } ], "description": "Message Thread Id" }, "message": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MessageForResponse" } ], "description": "Message Id" } } }, "MessageChannel": { "type": "object", "description": "Message Channels", "properties": { "isSyncEnabled": { "type": "boolean", "description": "Is Sync Enabled" }, "visibility": { "type": "string", "enum": [ "METADATA", "SUBJECT", "SHARE_EVERYTHING" ], "description": "Visibility" }, "handle": { "type": "string", "description": "Handle" }, "type": { "type": "string", "enum": [ "EMAIL", "SMS" ], "description": "Channel Type" }, "isContactAutoCreationEnabled": { "type": "boolean", "description": "Is Contact Auto Creation Enabled" }, "contactAutoCreationPolicy": { "type": "string", "enum": [ "SENT_AND_RECEIVED", "SENT", "NONE" ], "description": "Automatically create People records when receiving or sending emails" }, "messageFolderImportPolicy": { "type": "string", "enum": [ "ALL_FOLDERS", "SELECTED_FOLDERS" ], "description": "Message folder import policy" }, "excludeNonProfessionalEmails": { "type": "boolean", "description": "Exclude non professional emails" }, "excludeGroupEmails": { "type": "boolean", "description": "Exclude group emails" }, "pendingGroupEmailsAction": { "type": "string", "enum": [ "GROUP_EMAILS_DELETION", "GROUP_EMAILS_IMPORT", "NONE" ], "description": "Pending action for group emails" }, "syncCursor": { "type": "string", "description": "Last sync cursor" }, "syncedAt": { "type": "string", "format": "date-time", "description": "Last sync date" }, "syncStatus": { "type": "string", "enum": [ "ONGOING", "NOT_SYNCED", "ACTIVE", "FAILED_INSUFFICIENT_PERMISSIONS", "FAILED_UNKNOWN" ], "description": "Sync status" }, "syncStage": { "type": "string", "enum": [ "MESSAGE_LIST_FETCH_PENDING", "MESSAGE_LIST_FETCH_SCHEDULED", "MESSAGE_LIST_FETCH_ONGOING", "MESSAGES_IMPORT_PENDING", "MESSAGES_IMPORT_SCHEDULED", "MESSAGES_IMPORT_ONGOING", "FAILED", "PENDING_CONFIGURATION" ], "description": "Sync stage" }, "syncStageStartedAt": { "type": "string", "format": "date-time", "description": "Sync stage started at" }, "throttleFailureCount": { "type": "integer", "description": "Throttle Failure Count" }, "connectedAccountId": { "type": "string", "format": "uuid" } }, "example": { "visibility": "METADATA", "type": "EMAIL", "contactAutoCreationPolicy": "SENT_AND_RECEIVED", "messageFolderImportPolicy": "ALL_FOLDERS", "pendingGroupEmailsAction": "GROUP_EMAILS_DELETION", "syncStatus": "ONGOING", "syncStage": "MESSAGE_LIST_FETCH_PENDING", "connectedAccount": null }, "required": [ "connectedAccount" ] }, "MessageChannelForUpdate": { "type": "object", "description": "Message Channels", "properties": { "isSyncEnabled": { "type": "boolean", "description": "Is Sync Enabled" }, "visibility": { "type": "string", "enum": [ "METADATA", "SUBJECT", "SHARE_EVERYTHING" ], "description": "Visibility" }, "handle": { "type": "string", "description": "Handle" }, "type": { "type": "string", "enum": [ "EMAIL", "SMS" ], "description": "Channel Type" }, "isContactAutoCreationEnabled": { "type": "boolean", "description": "Is Contact Auto Creation Enabled" }, "contactAutoCreationPolicy": { "type": "string", "enum": [ "SENT_AND_RECEIVED", "SENT", "NONE" ], "description": "Automatically create People records when receiving or sending emails" }, "messageFolderImportPolicy": { "type": "string", "enum": [ "ALL_FOLDERS", "SELECTED_FOLDERS" ], "description": "Message folder import policy" }, "excludeNonProfessionalEmails": { "type": "boolean", "description": "Exclude non professional emails" }, "excludeGroupEmails": { "type": "boolean", "description": "Exclude group emails" }, "pendingGroupEmailsAction": { "type": "string", "enum": [ "GROUP_EMAILS_DELETION", "GROUP_EMAILS_IMPORT", "NONE" ], "description": "Pending action for group emails" }, "syncCursor": { "type": "string", "description": "Last sync cursor" }, "syncedAt": { "type": "string", "format": "date-time", "description": "Last sync date" }, "syncStatus": { "type": "string", "enum": [ "ONGOING", "NOT_SYNCED", "ACTIVE", "FAILED_INSUFFICIENT_PERMISSIONS", "FAILED_UNKNOWN" ], "description": "Sync status" }, "syncStage": { "type": "string", "enum": [ "MESSAGE_LIST_FETCH_PENDING", "MESSAGE_LIST_FETCH_SCHEDULED", "MESSAGE_LIST_FETCH_ONGOING", "MESSAGES_IMPORT_PENDING", "MESSAGES_IMPORT_SCHEDULED", "MESSAGES_IMPORT_ONGOING", "FAILED", "PENDING_CONFIGURATION" ], "description": "Sync stage" }, "syncStageStartedAt": { "type": "string", "format": "date-time", "description": "Sync stage started at" }, "throttleFailureCount": { "type": "integer", "description": "Throttle Failure Count" }, "connectedAccountId": { "type": "string", "format": "uuid" } }, "example": { "visibility": "METADATA", "type": "EMAIL", "contactAutoCreationPolicy": "SENT_AND_RECEIVED", "messageFolderImportPolicy": "ALL_FOLDERS", "pendingGroupEmailsAction": "GROUP_EMAILS_DELETION", "syncStatus": "ONGOING", "syncStage": "MESSAGE_LIST_FETCH_PENDING", "connectedAccount": null } }, "MessageChannelForResponse": { "type": "object", "description": "Message Channels", "properties": { "isSyncEnabled": { "type": "boolean", "description": "Is Sync Enabled" }, "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "visibility": { "type": "string", "enum": [ "METADATA", "SUBJECT", "SHARE_EVERYTHING" ], "description": "Visibility" }, "handle": { "type": "string", "description": "Handle" }, "type": { "type": "string", "enum": [ "EMAIL", "SMS" ], "description": "Channel Type" }, "isContactAutoCreationEnabled": { "type": "boolean", "description": "Is Contact Auto Creation Enabled" }, "contactAutoCreationPolicy": { "type": "string", "enum": [ "SENT_AND_RECEIVED", "SENT", "NONE" ], "description": "Automatically create People records when receiving or sending emails" }, "messageFolderImportPolicy": { "type": "string", "enum": [ "ALL_FOLDERS", "SELECTED_FOLDERS" ], "description": "Message folder import policy" }, "excludeNonProfessionalEmails": { "type": "boolean", "description": "Exclude non professional emails" }, "excludeGroupEmails": { "type": "boolean", "description": "Exclude group emails" }, "pendingGroupEmailsAction": { "type": "string", "enum": [ "GROUP_EMAILS_DELETION", "GROUP_EMAILS_IMPORT", "NONE" ], "description": "Pending action for group emails" }, "syncCursor": { "type": "string", "description": "Last sync cursor" }, "syncedAt": { "type": "string", "format": "date-time", "description": "Last sync date" }, "syncStatus": { "type": "string", "enum": [ "ONGOING", "NOT_SYNCED", "ACTIVE", "FAILED_INSUFFICIENT_PERMISSIONS", "FAILED_UNKNOWN" ], "description": "Sync status" }, "syncStage": { "type": "string", "enum": [ "MESSAGE_LIST_FETCH_PENDING", "MESSAGE_LIST_FETCH_SCHEDULED", "MESSAGE_LIST_FETCH_ONGOING", "MESSAGES_IMPORT_PENDING", "MESSAGES_IMPORT_SCHEDULED", "MESSAGES_IMPORT_ONGOING", "FAILED", "PENDING_CONFIGURATION" ], "description": "Sync stage" }, "syncStageStartedAt": { "type": "string", "format": "date-time", "description": "Sync stage started at" }, "throttleFailureCount": { "type": "integer", "description": "Throttle Failure Count" }, "connectedAccountId": { "type": "string", "format": "uuid" }, "connectedAccount": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ConnectedAccountForResponse" } ], "description": "Connected Account" }, "messageChannelMessageAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" }, "description": "Messages from the channel." }, "messageFolders": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFolderForResponse" }, "description": "Message Folders" } } }, "MessageFolder": { "type": "object", "description": "Message Folders", "properties": { "name": { "type": "string", "description": "Folder name" }, "syncCursor": { "type": "string", "description": "Sync Cursor" }, "isSentFolder": { "type": "boolean", "description": "Is Sent Folder" }, "isSynced": { "type": "boolean", "description": "Is Synced" }, "parentFolderId": { "type": "string", "description": "Parent Folder ID" }, "externalId": { "type": "string", "description": "External ID" }, "pendingSyncAction": { "type": "string", "enum": [ "FOLDER_DELETION", "NONE" ], "description": "Pending action for folder sync" }, "messageChannelId": { "type": "string", "format": "uuid" } }, "example": { "name": "Message Folder name", "pendingSyncAction": "FOLDER_DELETION", "messageChannel": null }, "required": [ "messageChannel" ] }, "MessageFolderForUpdate": { "type": "object", "description": "Message Folders", "properties": { "name": { "type": "string", "description": "Folder name" }, "syncCursor": { "type": "string", "description": "Sync Cursor" }, "isSentFolder": { "type": "boolean", "description": "Is Sent Folder" }, "isSynced": { "type": "boolean", "description": "Is Synced" }, "parentFolderId": { "type": "string", "description": "Parent Folder ID" }, "externalId": { "type": "string", "description": "External ID" }, "pendingSyncAction": { "type": "string", "enum": [ "FOLDER_DELETION", "NONE" ], "description": "Pending action for folder sync" }, "messageChannelId": { "type": "string", "format": "uuid" } }, "example": { "name": "Message Folder name", "pendingSyncAction": "FOLDER_DELETION", "messageChannel": null } }, "MessageFolderForResponse": { "type": "object", "description": "Message Folders", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "name": { "type": "string", "description": "Folder name" }, "syncCursor": { "type": "string", "description": "Sync Cursor" }, "isSentFolder": { "type": "boolean", "description": "Is Sent Folder" }, "isSynced": { "type": "boolean", "description": "Is Synced" }, "parentFolderId": { "type": "string", "description": "Parent Folder ID" }, "externalId": { "type": "string", "description": "External ID" }, "pendingSyncAction": { "type": "string", "enum": [ "FOLDER_DELETION", "NONE" ], "description": "Pending action for folder sync" }, "messageChannelId": { "type": "string", "format": "uuid" }, "messageChannel": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MessageChannelForResponse" } ], "description": "Message Channel" } } }, "MessageParticipant": { "type": "object", "description": "Message Participants", "properties": { "handle": { "type": "string", "description": "Handle" }, "role": { "type": "string", "enum": [ "FROM", "TO", "CC", "BCC" ], "description": "Role" }, "displayName": { "type": "string", "description": "Display Name" }, "messageId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "workspaceMemberId": { "type": "string", "format": "uuid" } }, "example": { "role": "FROM", "message": null }, "required": [ "message" ] }, "MessageParticipantForUpdate": { "type": "object", "description": "Message Participants", "properties": { "handle": { "type": "string", "description": "Handle" }, "role": { "type": "string", "enum": [ "FROM", "TO", "CC", "BCC" ], "description": "Role" }, "displayName": { "type": "string", "description": "Display Name" }, "messageId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "workspaceMemberId": { "type": "string", "format": "uuid" } }, "example": { "role": "FROM", "message": null } }, "MessageParticipantForResponse": { "type": "object", "description": "Message Participants", "properties": { "handle": { "type": "string", "description": "Handle" }, "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "role": { "type": "string", "enum": [ "FROM", "TO", "CC", "BCC" ], "description": "Role" }, "displayName": { "type": "string", "description": "Display Name" }, "messageId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "message": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MessageForResponse" } ], "description": "Message" }, "person": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PersonForResponse" } ], "description": "Person" }, "workspaceMember": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } ], "description": "Workspace member" } } }, "Message": { "type": "object", "description": "Message", "properties": { "headerMessageId": { "type": "string", "description": "Message id from the message header" }, "direction": { "type": "string", "enum": [ "INCOMING", "OUTGOING" ], "description": "Message Direction" }, "subject": { "type": "string", "description": "Subject" }, "text": { "type": "string", "description": "Text" }, "receivedAt": { "type": "string", "format": "date-time", "description": "The date the message was received" }, "messageThreadId": { "type": "string", "format": "uuid" } }, "example": { "direction": "INCOMING" } }, "MessageForUpdate": { "type": "object", "description": "Message", "properties": { "headerMessageId": { "type": "string", "description": "Message id from the message header" }, "direction": { "type": "string", "enum": [ "INCOMING", "OUTGOING" ], "description": "Message Direction" }, "subject": { "type": "string", "description": "Subject" }, "text": { "type": "string", "description": "Text" }, "receivedAt": { "type": "string", "format": "date-time", "description": "The date the message was received" }, "messageThreadId": { "type": "string", "format": "uuid" } }, "example": { "direction": "INCOMING" } }, "MessageForResponse": { "type": "object", "description": "Message", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "headerMessageId": { "type": "string", "description": "Message id from the message header" }, "direction": { "type": "string", "enum": [ "INCOMING", "OUTGOING" ], "description": "Message Direction" }, "subject": { "type": "string", "description": "Subject" }, "text": { "type": "string", "description": "Text" }, "receivedAt": { "type": "string", "format": "date-time", "description": "The date the message was received" }, "messageThreadId": { "type": "string", "format": "uuid" }, "messageThread": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/MessageThreadForResponse" } ], "description": "Message Thread Id" }, "messageParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParticipantForResponse" }, "description": "Message Participants" }, "messageChannelMessageAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" }, "description": "Messages from the channel." } } }, "MessageThread": { "type": "object", "description": "Message Thread", "properties": {}, "example": {} }, "MessageThreadForUpdate": { "type": "object", "description": "Message Thread", "properties": {}, "example": {} }, "MessageThreadForResponse": { "type": "object", "description": "Message Thread", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/MessageForResponse" }, "description": "Messages from the thread." }, "messageChannelMessageAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" }, "description": "Messages from the channel." } } }, "Note": { "type": "object", "description": "A note", "properties": { "position": { "type": "number", "description": "Note record position" }, "title": { "type": "string", "description": "Note title" }, "bodyV2": { "type": "object", "properties": { "blocknote": { "type": "string" }, "markdown": { "type": "string" } }, "description": "Note body" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" } }, "example": { "favorites": null }, "required": [ "favorites" ] }, "NoteForUpdate": { "type": "object", "description": "A note", "properties": { "position": { "type": "number", "description": "Note record position" }, "title": { "type": "string", "description": "Note title" }, "bodyV2": { "type": "object", "properties": { "blocknote": { "type": "string" }, "markdown": { "type": "string" } }, "description": "Note body" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" } }, "example": { "favorites": null } }, "NoteForResponse": { "type": "object", "description": "A note", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "position": { "type": "number", "description": "Note record position" }, "title": { "type": "string", "description": "Note title" }, "bodyV2": { "type": "object", "properties": { "blocknote": { "type": "string" }, "markdown": { "type": "string" } }, "description": "Note body" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The workspace member who last updated the record" }, "noteTargets": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTargetForResponse" }, "description": "Note targets" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" }, "description": "Note attachments" }, "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "description": "Timeline Activities linked to the note." }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites linked to the note" } } }, "NoteTarget": { "type": "object", "description": "A note target", "properties": { "noteId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" } }, "example": {} }, "NoteTargetForUpdate": { "type": "object", "description": "A note target", "properties": { "noteId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" } }, "example": {} }, "NoteTargetForResponse": { "type": "object", "description": "A note target", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "noteId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" }, "note": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/NoteForResponse" } ], "description": "NoteTarget note" }, "person": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PersonForResponse" } ], "description": "NoteTarget person" }, "company": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CompanyForResponse" } ], "description": "NoteTarget company" }, "opportunity": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/OpportunityForResponse" } ], "description": "NoteTarget opportunity" } } }, "Opportunity": { "type": "object", "description": "An opportunity", "properties": { "name": { "type": "string", "description": "The opportunity name" }, "amount": { "type": "object", "properties": { "amountMicros": { "type": "number" }, "currencyCode": { "type": "string" } }, "description": "Opportunity amount" }, "closeDate": { "type": "string", "format": "date-time", "description": "Opportunity close date" }, "stage": { "type": "string", "enum": [ "NEW", "SCREENING", "MEETING", "PROPOSAL", "CUSTOMER" ], "description": "Opportunity stage" }, "position": { "type": "number", "description": "Opportunity record position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "pointOfContactId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "ownerId": { "type": "string", "format": "uuid" } }, "example": { "name": "Opportunity name", "amount": { "amountMicros": "211000000", "currencyCode": "EUR" }, "stage": "NEW" } }, "OpportunityForUpdate": { "type": "object", "description": "An opportunity", "properties": { "name": { "type": "string", "description": "The opportunity name" }, "amount": { "type": "object", "properties": { "amountMicros": { "type": "number" }, "currencyCode": { "type": "string" } }, "description": "Opportunity amount" }, "closeDate": { "type": "string", "format": "date-time", "description": "Opportunity close date" }, "stage": { "type": "string", "enum": [ "NEW", "SCREENING", "MEETING", "PROPOSAL", "CUSTOMER" ], "description": "Opportunity stage" }, "position": { "type": "number", "description": "Opportunity record position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "pointOfContactId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "ownerId": { "type": "string", "format": "uuid" } }, "example": { "name": "Opportunity name", "amount": { "amountMicros": "770000000", "currencyCode": "EUR" }, "stage": "NEW" } }, "OpportunityForResponse": { "type": "object", "description": "An opportunity", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "name": { "type": "string", "description": "The opportunity name" }, "amount": { "type": "object", "properties": { "amountMicros": { "type": "number" }, "currencyCode": { "type": "string" } }, "description": "Opportunity amount" }, "closeDate": { "type": "string", "format": "date-time", "description": "Opportunity close date" }, "stage": { "type": "string", "enum": [ "NEW", "SCREENING", "MEETING", "PROPOSAL", "CUSTOMER" ], "description": "Opportunity stage" }, "position": { "type": "number", "description": "Opportunity record position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The workspace member who last updated the record" }, "pointOfContactId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "ownerId": { "type": "string", "format": "uuid" }, "pointOfContact": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PersonForResponse" } ], "description": "Opportunity point of contact" }, "company": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CompanyForResponse" } ], "description": "Opportunity company" }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites linked to the opportunity" }, "taskTargets": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTargetForResponse" }, "description": "Tasks tied to the opportunity" }, "noteTargets": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTargetForResponse" }, "description": "Notes tied to the opportunity" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" }, "description": "Attachments linked to the opportunity" }, "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "description": "Timeline Activities linked to the opportunity." }, "owner": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } ], "description": "Opportunity owner" } } }, "Person": { "type": "object", "description": "A person", "properties": { "name": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "description": "Contact's name" }, "emails": { "type": "object", "properties": { "primaryEmail": { "type": "string" }, "additionalEmails": { "type": "array", "items": { "type": "string", "format": "email" } } }, "description": "Contact's Emails" }, "linkedinLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "Contact's Linkedin account" }, "xLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "Contact's X/Twitter account" }, "jobTitle": { "type": "string", "description": "Contact's job title" }, "phones": { "properties": { "additionalPhones": { "type": "array", "items": { "type": "string" } }, "primaryPhoneCountryCode": { "type": "string" }, "primaryPhoneCallingCode": { "type": "string" }, "primaryPhoneNumber": { "type": "string" } }, "type": "object", "description": "Contact's phone numbers" }, "city": { "type": "string", "description": "Contact's city" }, "avatarUrl": { "type": "string", "description": "Contact's avatar" }, "position": { "type": "number", "description": "Person record Position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "companyId": { "type": "string", "format": "uuid" }, "typeCustom": { "type": "array", "items": { "type": "string", "enum": [ "CUSTOMER", "PARTNER", "SUPPLIER", "INFORMATION_SOURCE" ] } } }, "example": { "name": { "firstName": "Anabel", "lastName": "Price" }, "emails": { "primaryEmail": "felipa.prohaska@yahoo.com", "additionalEmails": null }, "linkedinLink": { "primaryLinkLabel": "", "primaryLinkUrl": "https://utter-atrium.net/", "secondaryLinks": [] }, "xLink": { "primaryLinkLabel": "", "primaryLinkUrl": "https://gullible-innovation.info/", "secondaryLinks": [] }, "phones": { "primaryPhoneNumber": "06 10 20 30 40", "primaryPhoneCallingCode": "+33", "primaryPhoneCountryCode": "FR", "additionalPhones": [] }, "typeCustom": [ "CUSTOMER" ] } }, "PersonForUpdate": { "type": "object", "description": "A person", "properties": { "name": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "description": "Contact's name" }, "emails": { "type": "object", "properties": { "primaryEmail": { "type": "string" }, "additionalEmails": { "type": "array", "items": { "type": "string", "format": "email" } } }, "description": "Contact's Emails" }, "linkedinLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "Contact's Linkedin account" }, "xLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "Contact's X/Twitter account" }, "jobTitle": { "type": "string", "description": "Contact's job title" }, "phones": { "properties": { "additionalPhones": { "type": "array", "items": { "type": "string" } }, "primaryPhoneCountryCode": { "type": "string" }, "primaryPhoneCallingCode": { "type": "string" }, "primaryPhoneNumber": { "type": "string" } }, "type": "object", "description": "Contact's phone numbers" }, "city": { "type": "string", "description": "Contact's city" }, "avatarUrl": { "type": "string", "description": "Contact's avatar" }, "position": { "type": "number", "description": "Person record Position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "companyId": { "type": "string", "format": "uuid" }, "typeCustom": { "type": "array", "items": { "type": "string", "enum": [ "CUSTOMER", "PARTNER", "SUPPLIER", "INFORMATION_SOURCE" ] } } }, "example": { "name": { "firstName": "Meghan", "lastName": "Welch" }, "emails": { "primaryEmail": "arlene.pouros53@gmail.com", "additionalEmails": null }, "linkedinLink": { "primaryLinkLabel": "", "primaryLinkUrl": "https://expensive-conservation.biz", "secondaryLinks": [] }, "xLink": { "primaryLinkLabel": "", "primaryLinkUrl": "https://second-self-confidence.com/", "secondaryLinks": [] }, "phones": { "primaryPhoneNumber": "06 10 20 30 40", "primaryPhoneCallingCode": "+33", "primaryPhoneCountryCode": "FR", "additionalPhones": [] }, "typeCustom": [ "CUSTOMER" ] } }, "PersonForResponse": { "type": "object", "description": "A person", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "name": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "description": "Contact's name" }, "emails": { "type": "object", "properties": { "primaryEmail": { "type": "string" }, "additionalEmails": { "type": "array", "items": { "type": "string", "format": "email" } } }, "description": "Contact's Emails" }, "linkedinLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "Contact's Linkedin account" }, "xLink": { "type": "object", "properties": { "primaryLinkLabel": { "type": "string" }, "primaryLinkUrl": { "type": "string" }, "secondaryLinks": { "type": "array", "items": { "type": "object", "description": "A secondary link", "properties": { "url": { "type": "string", "format": "uri" }, "label": { "type": "string" } } } } }, "description": "Contact's X/Twitter account" }, "jobTitle": { "type": "string", "description": "Contact's job title" }, "phones": { "properties": { "additionalPhones": { "type": "array", "items": { "type": "string" } }, "primaryPhoneCountryCode": { "type": "string" }, "primaryPhoneCallingCode": { "type": "string" }, "primaryPhoneNumber": { "type": "string" } }, "type": "object", "description": "Contact's phone numbers" }, "city": { "type": "string", "description": "Contact's city" }, "avatarUrl": { "type": "string", "description": "Contact's avatar" }, "position": { "type": "number", "description": "Person record Position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The workspace member who last updated the record" }, "companyId": { "type": "string", "format": "uuid" }, "typeCustom": { "type": "array", "items": { "type": "string", "enum": [ "CUSTOMER", "PARTNER", "SUPPLIER", "INFORMATION_SOURCE" ] } }, "company": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CompanyForResponse" } ], "description": "Contact's company" }, "pointOfContactForOpportunities": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityForResponse" }, "description": "List of opportunities for which that person is the point of contact" }, "taskTargets": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTargetForResponse" }, "description": "Tasks tied to the contact" }, "noteTargets": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTargetForResponse" }, "description": "Notes tied to the contact" }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites linked to the contact" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" }, "description": "Attachments linked to the contact." }, "messageParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParticipantForResponse" }, "description": "Message Participants" }, "calendarEventParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" }, "description": "Calendar Event Participants" }, "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "description": "Events linked to the person" } } }, "Task": { "type": "object", "description": "A task", "properties": { "position": { "type": "number", "description": "Task record position" }, "title": { "type": "string", "description": "Task title" }, "bodyV2": { "type": "object", "properties": { "blocknote": { "type": "string" }, "markdown": { "type": "string" } }, "description": "Task body" }, "dueAt": { "type": "string", "format": "date-time", "description": "Task due date" }, "status": { "type": "string", "enum": [ "TODO", "IN_PROGRESS", "DONE" ], "description": "Task status" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "assigneeId": { "type": "string", "format": "uuid" } }, "example": { "status": "TODO", "favorites": null }, "required": [ "favorites" ] }, "TaskForUpdate": { "type": "object", "description": "A task", "properties": { "position": { "type": "number", "description": "Task record position" }, "title": { "type": "string", "description": "Task title" }, "bodyV2": { "type": "object", "properties": { "blocknote": { "type": "string" }, "markdown": { "type": "string" } }, "description": "Task body" }, "dueAt": { "type": "string", "format": "date-time", "description": "Task due date" }, "status": { "type": "string", "enum": [ "TODO", "IN_PROGRESS", "DONE" ], "description": "Task status" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "assigneeId": { "type": "string", "format": "uuid" } }, "example": { "status": "TODO", "favorites": null } }, "TaskForResponse": { "type": "object", "description": "A task", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "position": { "type": "number", "description": "Task record position" }, "title": { "type": "string", "description": "Task title" }, "bodyV2": { "type": "object", "properties": { "blocknote": { "type": "string" }, "markdown": { "type": "string" } }, "description": "Task body" }, "dueAt": { "type": "string", "format": "date-time", "description": "Task due date" }, "status": { "type": "string", "enum": [ "TODO", "IN_PROGRESS", "DONE" ], "description": "Task status" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The workspace member who last updated the record" }, "assigneeId": { "type": "string", "format": "uuid" }, "taskTargets": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTargetForResponse" }, "description": "Task targets" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" }, "description": "Task attachments" }, "assignee": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } ], "description": "Task assignee" }, "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "description": "Timeline Activities linked to the task." }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites linked to the task" } } }, "TaskTarget": { "type": "object", "description": "A task target", "properties": { "taskId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" } }, "example": {} }, "TaskTargetForUpdate": { "type": "object", "description": "A task target", "properties": { "taskId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" } }, "example": {} }, "TaskTargetForResponse": { "type": "object", "description": "A task target", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "taskId": { "type": "string", "format": "uuid" }, "personId": { "type": "string", "format": "uuid" }, "companyId": { "type": "string", "format": "uuid" }, "opportunityId": { "type": "string", "format": "uuid" }, "task": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/TaskForResponse" } ], "description": "TaskTarget task" }, "person": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/PersonForResponse" } ], "description": "TaskTarget person" }, "company": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/CompanyForResponse" } ], "description": "TaskTarget company" }, "opportunity": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/OpportunityForResponse" } ], "description": "TaskTarget opportunity" } } }, "TimelineActivity": { "type": "object", "description": "Aggregated / filtered event to be displayed on the timeline", "properties": { "linkedRecordId": { "type": "string", "format": "uuid", "description": "Linked Record id" }, "linkedObjectMetadataId": { "type": "string", "format": "uuid", "description": "Linked Object Metadata Id" }, "happensAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "name": { "type": "string", "description": "Event name" }, "properties": { "type": "object", "description": "Json value for event details" }, "linkedRecordCachedName": { "type": "string", "description": "Cached record name" }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "targetPerson": { "type": "string", "description": "Event person" }, "targetCompany": { "type": "string", "description": "Event company" }, "targetOpportunity": { "type": "string", "description": "Event opportunity" }, "targetNote": { "type": "string", "description": "Event note" }, "targetTask": { "type": "string", "description": "Event task" }, "targetWorkflow": { "type": "string", "description": "Event workflow" }, "targetWorkflowVersion": { "type": "string", "description": "Event workflow version" }, "targetWorkflowRun": { "type": "string", "description": "Event workflow run" }, "targetDashboard": { "type": "string", "description": "Event dashboard" } }, "example": { "name": "Timeline Activity name" } }, "TimelineActivityForUpdate": { "type": "object", "description": "Aggregated / filtered event to be displayed on the timeline", "properties": { "linkedRecordId": { "type": "string", "format": "uuid", "description": "Linked Record id" }, "linkedObjectMetadataId": { "type": "string", "format": "uuid", "description": "Linked Object Metadata Id" }, "happensAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "name": { "type": "string", "description": "Event name" }, "properties": { "type": "object", "description": "Json value for event details" }, "linkedRecordCachedName": { "type": "string", "description": "Cached record name" }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "targetPerson": { "type": "string", "description": "Event person" }, "targetCompany": { "type": "string", "description": "Event company" }, "targetOpportunity": { "type": "string", "description": "Event opportunity" }, "targetNote": { "type": "string", "description": "Event note" }, "targetTask": { "type": "string", "description": "Event task" }, "targetWorkflow": { "type": "string", "description": "Event workflow" }, "targetWorkflowVersion": { "type": "string", "description": "Event workflow version" }, "targetWorkflowRun": { "type": "string", "description": "Event workflow run" }, "targetDashboard": { "type": "string", "description": "Event dashboard" } }, "example": { "name": "Timeline Activity name" } }, "TimelineActivityForResponse": { "type": "object", "description": "Aggregated / filtered event to be displayed on the timeline", "properties": { "linkedRecordId": { "type": "string", "format": "uuid", "description": "Linked Record id" }, "linkedObjectMetadataId": { "type": "string", "format": "uuid", "description": "Linked Object Metadata Id" }, "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "happensAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "name": { "type": "string", "description": "Event name" }, "properties": { "type": "object", "description": "Json value for event details" }, "linkedRecordCachedName": { "type": "string", "description": "Cached record name" }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "targetPerson": { "type": "string", "description": "Event person" }, "targetCompany": { "type": "string", "description": "Event company" }, "targetOpportunity": { "type": "string", "description": "Event opportunity" }, "targetNote": { "type": "string", "description": "Event note" }, "targetTask": { "type": "string", "description": "Event task" }, "targetWorkflow": { "type": "string", "description": "Event workflow" }, "targetWorkflowVersion": { "type": "string", "description": "Event workflow version" }, "targetWorkflowRun": { "type": "string", "description": "Event workflow run" }, "targetDashboard": { "type": "string", "description": "Event dashboard" }, "workspaceMember": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } ], "description": "Event workspace member" } } }, "WorkflowAutomatedTrigger": { "type": "object", "description": "A workflow automated trigger", "properties": { "type": { "type": "string", "enum": [ "DATABASE_EVENT", "CRON" ], "description": "The workflow automated trigger type" }, "settings": { "type": "object", "description": "The workflow automated trigger settings" }, "workflowId": { "type": "string", "format": "uuid" } }, "example": { "type": "DATABASE_EVENT", "settings": {}, "workflow": null }, "required": [ "type", "settings", "workflow" ] }, "WorkflowAutomatedTriggerForUpdate": { "type": "object", "description": "A workflow automated trigger", "properties": { "type": { "type": "string", "enum": [ "DATABASE_EVENT", "CRON" ], "description": "The workflow automated trigger type" }, "settings": { "type": "object", "description": "The workflow automated trigger settings" }, "workflowId": { "type": "string", "format": "uuid" } }, "example": { "type": "DATABASE_EVENT", "settings": {}, "workflow": null } }, "WorkflowAutomatedTriggerForResponse": { "type": "object", "description": "A workflow automated trigger", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "type": { "type": "string", "enum": [ "DATABASE_EVENT", "CRON" ], "description": "The workflow automated trigger type" }, "settings": { "type": "object", "description": "The workflow automated trigger settings" }, "workflowId": { "type": "string", "format": "uuid" }, "workflow": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkflowForResponse" } ], "description": "WorkflowAutomatedTrigger workflow" } } }, "WorkflowRun": { "type": "object", "description": "A workflow run", "properties": { "name": { "type": "string", "description": "Name of the workflow run" }, "enqueuedAt": { "type": "string", "format": "date-time", "description": "Workflow run enqueued at" }, "startedAt": { "type": "string", "format": "date-time", "description": "Workflow run started at" }, "endedAt": { "type": "string", "format": "date-time", "description": "Workflow run ended at" }, "status": { "type": "string", "enum": [ "NOT_STARTED", "RUNNING", "COMPLETED", "FAILED", "ENQUEUED", "STOPPING", "STOPPED" ], "description": "Workflow run status" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The executor of the workflow" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "state": { "type": "object", "description": "State of the workflow run" }, "context": { "type": "object", "description": "Context of the workflow run" }, "output": { "type": "object", "description": "Output of the workflow run" }, "position": { "type": "number", "description": "Workflow run position" }, "workflowVersionId": { "type": "string", "format": "uuid" }, "workflowId": { "type": "string", "format": "uuid" } }, "example": { "name": "Workflow Run name", "status": "NOT_STARTED", "state": {}, "workflowVersion": null, "workflow": null, "favorites": null, "timelineActivities": null }, "required": [ "state", "workflowVersion", "workflow", "favorites", "timelineActivities" ] }, "WorkflowRunForUpdate": { "type": "object", "description": "A workflow run", "properties": { "name": { "type": "string", "description": "Name of the workflow run" }, "enqueuedAt": { "type": "string", "format": "date-time", "description": "Workflow run enqueued at" }, "startedAt": { "type": "string", "format": "date-time", "description": "Workflow run started at" }, "endedAt": { "type": "string", "format": "date-time", "description": "Workflow run ended at" }, "status": { "type": "string", "enum": [ "NOT_STARTED", "RUNNING", "COMPLETED", "FAILED", "ENQUEUED", "STOPPING", "STOPPED" ], "description": "Workflow run status" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The executor of the workflow" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" }, "state": { "type": "object", "description": "State of the workflow run" }, "context": { "type": "object", "description": "Context of the workflow run" }, "output": { "type": "object", "description": "Output of the workflow run" }, "position": { "type": "number", "description": "Workflow run position" }, "workflowVersionId": { "type": "string", "format": "uuid" }, "workflowId": { "type": "string", "format": "uuid" } }, "example": { "name": "Workflow Run name", "status": "NOT_STARTED", "state": {}, "workflowVersion": null, "workflow": null, "favorites": null, "timelineActivities": null } }, "WorkflowRunForResponse": { "type": "object", "description": "A workflow run", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "name": { "type": "string", "description": "Name of the workflow run" }, "enqueuedAt": { "type": "string", "format": "date-time", "description": "Workflow run enqueued at" }, "startedAt": { "type": "string", "format": "date-time", "description": "Workflow run started at" }, "endedAt": { "type": "string", "format": "date-time", "description": "Workflow run ended at" }, "status": { "type": "string", "enum": [ "NOT_STARTED", "RUNNING", "COMPLETED", "FAILED", "ENQUEUED", "STOPPING", "STOPPED" ], "description": "Workflow run status" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The executor of the workflow" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The workspace member who last updated the record" }, "state": { "type": "object", "description": "State of the workflow run" }, "context": { "type": "object", "description": "Context of the workflow run" }, "output": { "type": "object", "description": "Output of the workflow run" }, "position": { "type": "number", "description": "Workflow run position" }, "workflowVersionId": { "type": "string", "format": "uuid" }, "workflowId": { "type": "string", "format": "uuid" }, "workflowVersion": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkflowVersionForResponse" } ], "description": "Workflow version linked to the run." }, "workflow": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkflowForResponse" } ], "description": "Workflow linked to the run." }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites linked to the workflow run" }, "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "description": "Timeline activities linked to the run" } } }, "Workflow": { "type": "object", "description": "A workflow", "properties": { "name": { "type": "string", "description": "The workflow name" }, "lastPublishedVersionId": { "type": "string", "description": "The workflow last published version id" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "DEACTIVATED" ] }, "description": "The current statuses of the workflow versions" }, "position": { "type": "number", "description": "Workflow record position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" } }, "example": { "name": "Workflow name", "statuses": [ "DRAFT" ], "versions": null, "runs": null, "automatedTriggers": null, "favorites": null, "timelineActivities": null, "attachments": null }, "required": [ "versions", "runs", "automatedTriggers", "favorites", "timelineActivities", "attachments" ] }, "WorkflowForUpdate": { "type": "object", "description": "A workflow", "properties": { "name": { "type": "string", "description": "The workflow name" }, "lastPublishedVersionId": { "type": "string", "description": "The workflow last published version id" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "DEACTIVATED" ] }, "description": "The current statuses of the workflow versions" }, "position": { "type": "number", "description": "Workflow record position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] } }, "description": "The workspace member who last updated the record" } }, "example": { "name": "Workflow name", "statuses": [ "DRAFT" ], "versions": null, "runs": null, "automatedTriggers": null, "favorites": null, "timelineActivities": null, "attachments": null } }, "WorkflowForResponse": { "type": "object", "description": "A workflow", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "name": { "type": "string", "description": "The workflow name" }, "lastPublishedVersionId": { "type": "string", "description": "The workflow last published version id" }, "statuses": { "type": "array", "items": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "DEACTIVATED" ] }, "description": "The current statuses of the workflow versions" }, "position": { "type": "number", "description": "Workflow record position" }, "createdBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The creator of the record" }, "updatedBy": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "EMAIL", "CALENDAR", "WORKFLOW", "AGENT", "API", "IMPORT", "MANUAL", "SYSTEM", "WEBHOOK" ] }, "workspaceMemberId": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "description": "The workspace member who last updated the record" }, "versions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVersionForResponse" }, "description": "Workflow versions linked to the workflow." }, "runs": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRunForResponse" }, "description": "Workflow runs linked to the workflow." }, "automatedTriggers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" }, "description": "Workflow automated triggers linked to the workflow." }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites linked to the workflow" }, "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "description": "Timeline activities linked to the workflow" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" }, "description": "Attachments linked to the workflow" } } }, "WorkflowVersion": { "type": "object", "description": "A workflow version", "properties": { "name": { "type": "string", "description": "The workflow version name" }, "trigger": { "type": "object", "description": "Json object to provide trigger" }, "steps": { "type": "object", "description": "Json object to provide steps" }, "status": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "DEACTIVATED", "ARCHIVED" ], "description": "The workflow version status" }, "position": { "type": "number", "description": "Workflow version position" }, "workflowId": { "type": "string", "format": "uuid" } }, "example": { "name": "Workflow Version name", "status": "DRAFT", "favorites": null, "timelineActivities": null }, "required": [ "favorites", "timelineActivities" ] }, "WorkflowVersionForUpdate": { "type": "object", "description": "A workflow version", "properties": { "name": { "type": "string", "description": "The workflow version name" }, "trigger": { "type": "object", "description": "Json object to provide trigger" }, "steps": { "type": "object", "description": "Json object to provide steps" }, "status": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "DEACTIVATED", "ARCHIVED" ], "description": "The workflow version status" }, "position": { "type": "number", "description": "Workflow version position" }, "workflowId": { "type": "string", "format": "uuid" } }, "example": { "name": "Workflow Version name", "status": "DRAFT", "favorites": null, "timelineActivities": null } }, "WorkflowVersionForResponse": { "type": "object", "description": "A workflow version", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "name": { "type": "string", "description": "The workflow version name" }, "trigger": { "type": "object", "description": "Json object to provide trigger" }, "steps": { "type": "object", "description": "Json object to provide steps" }, "status": { "type": "string", "enum": [ "DRAFT", "ACTIVE", "DEACTIVATED", "ARCHIVED" ], "description": "The workflow version status" }, "position": { "type": "number", "description": "Workflow version position" }, "workflowId": { "type": "string", "format": "uuid" }, "workflow": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WorkflowForResponse" } ], "description": "WorkflowVersion workflow" }, "runs": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRunForResponse" }, "description": "Workflow runs linked to the version." }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites linked to the workflow version" }, "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "description": "Timeline activities linked to the version" } } }, "WorkspaceMember": { "type": "object", "description": "A workspace member", "properties": { "position": { "type": "number", "description": "Workspace member position" }, "name": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "description": "Workspace member name" }, "colorScheme": { "type": "string", "description": "Preferred color scheme" }, "locale": { "type": "string", "description": "Preferred language" }, "avatarUrl": { "type": "string", "description": "Workspace member avatar" }, "userEmail": { "type": "string", "description": "Related user email address" }, "calendarStartDay": { "type": "integer", "description": "User's preferred start day of the week" }, "userId": { "type": "string", "format": "uuid", "description": "Associated User Id" }, "timeZone": { "type": "string", "description": "User time zone" }, "dateFormat": { "type": "string", "enum": [ "SYSTEM", "MONTH_FIRST", "DAY_FIRST", "YEAR_FIRST" ], "description": "User's preferred date format" }, "timeFormat": { "type": "string", "enum": [ "SYSTEM", "HOUR_24", "HOUR_12" ], "description": "User's preferred time format" }, "numberFormat": { "type": "string", "enum": [ "SYSTEM", "COMMAS_AND_DOT", "SPACES_AND_COMMA", "DOTS_AND_COMMA", "APOSTROPHE_AND_DOT" ], "description": "User's preferred number format" } }, "example": { "name": { "firstName": "Joan", "lastName": "Johnson" }, "userId": "e25d49cb-1978-486c-96a5-2b344bbef65d", "dateFormat": "SYSTEM", "timeFormat": "SYSTEM", "numberFormat": "SYSTEM", "assignedTasks": null, "favorites": null, "accountOwnerForCompanies": null, "connectedAccounts": null, "messageParticipants": null, "blocklist": null, "calendarEventParticipants": null, "ownedOpportunities": null }, "required": [ "name", "userId", "assignedTasks", "favorites", "accountOwnerForCompanies", "connectedAccounts", "messageParticipants", "blocklist", "calendarEventParticipants", "ownedOpportunities" ] }, "WorkspaceMemberForUpdate": { "type": "object", "description": "A workspace member", "properties": { "position": { "type": "number", "description": "Workspace member position" }, "name": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "description": "Workspace member name" }, "colorScheme": { "type": "string", "description": "Preferred color scheme" }, "locale": { "type": "string", "description": "Preferred language" }, "avatarUrl": { "type": "string", "description": "Workspace member avatar" }, "userEmail": { "type": "string", "description": "Related user email address" }, "calendarStartDay": { "type": "integer", "description": "User's preferred start day of the week" }, "userId": { "type": "string", "format": "uuid", "description": "Associated User Id" }, "timeZone": { "type": "string", "description": "User time zone" }, "dateFormat": { "type": "string", "enum": [ "SYSTEM", "MONTH_FIRST", "DAY_FIRST", "YEAR_FIRST" ], "description": "User's preferred date format" }, "timeFormat": { "type": "string", "enum": [ "SYSTEM", "HOUR_24", "HOUR_12" ], "description": "User's preferred time format" }, "numberFormat": { "type": "string", "enum": [ "SYSTEM", "COMMAS_AND_DOT", "SPACES_AND_COMMA", "DOTS_AND_COMMA", "APOSTROPHE_AND_DOT" ], "description": "User's preferred number format" } }, "example": { "name": { "firstName": "Deron", "lastName": "Johns" }, "userId": "caa944ce-2c0b-4ee4-bb67-0f69d5a0be2c", "dateFormat": "SYSTEM", "timeFormat": "SYSTEM", "numberFormat": "SYSTEM", "assignedTasks": null, "favorites": null, "accountOwnerForCompanies": null, "connectedAccounts": null, "messageParticipants": null, "blocklist": null, "calendarEventParticipants": null, "ownedOpportunities": null } }, "WorkspaceMemberForResponse": { "type": "object", "description": "A workspace member", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id" }, "createdAt": { "type": "string", "format": "date-time", "description": "Creation date" }, "updatedAt": { "type": "string", "format": "date-time", "description": "Last time the record was changed" }, "deletedAt": { "type": "string", "format": "date-time", "description": "Date when the record was deleted" }, "position": { "type": "number", "description": "Workspace member position" }, "name": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } }, "description": "Workspace member name" }, "colorScheme": { "type": "string", "description": "Preferred color scheme" }, "locale": { "type": "string", "description": "Preferred language" }, "avatarUrl": { "type": "string", "description": "Workspace member avatar" }, "userEmail": { "type": "string", "description": "Related user email address" }, "calendarStartDay": { "type": "integer", "description": "User's preferred start day of the week" }, "userId": { "type": "string", "format": "uuid", "description": "Associated User Id" }, "timeZone": { "type": "string", "description": "User time zone" }, "dateFormat": { "type": "string", "enum": [ "SYSTEM", "MONTH_FIRST", "DAY_FIRST", "YEAR_FIRST" ], "description": "User's preferred date format" }, "timeFormat": { "type": "string", "enum": [ "SYSTEM", "HOUR_24", "HOUR_12" ], "description": "User's preferred time format" }, "numberFormat": { "type": "string", "enum": [ "SYSTEM", "COMMAS_AND_DOT", "SPACES_AND_COMMA", "DOTS_AND_COMMA", "APOSTROPHE_AND_DOT" ], "description": "User's preferred number format" }, "assignedTasks": { "type": "array", "items": { "$ref": "#/components/schemas/TaskForResponse" }, "description": "Tasks assigned to the workspace member" }, "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" }, "description": "Favorites linked to the workspace member" }, "accountOwnerForCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyForResponse" }, "description": "Account owner for companies" }, "connectedAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedAccountForResponse" }, "description": "Connected accounts" }, "messageParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParticipantForResponse" }, "description": "Message Participants" }, "blocklist": { "type": "array", "items": { "$ref": "#/components/schemas/BlocklistForResponse" }, "description": "Blocklisted handles" }, "calendarEventParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" }, "description": "Calendar Event Participants" }, "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "description": "Events linked to the workspace member" }, "ownedOpportunities": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityForResponse" }, "description": "Opportunities owned by the workspace member" } } } }, "parameters": { "idPath": { "name": "id", "in": "path", "description": "Object id.", "required": true, "schema": { "type": "string", "format": "uuid" } }, "startingAfter": { "name": "starting_after", "in": "query", "description": "Returns objects starting after a specific cursor. You can find cursors in **startCursor** and **endCursor** in **pageInfo** in response data", "required": false, "schema": { "type": "string" } }, "endingBefore": { "name": "ending_before", "in": "query", "description": "Returns objects ending before a specific cursor. You can find cursors in **startCursor** and **endCursor** in **pageInfo** in response data", "required": false, "schema": { "type": "string" } }, "filter": { "name": "filter", "in": "query", "description": "Format: field[COMPARATOR]:value,field2[COMPARATOR]:value2.\n For like/ilike, use % as a wildcard (e.g. %value% for substring match).\n Refer to the filter section at the top of the page for more details.", "required": false, "schema": { "type": "string" }, "examples": { "simple": { "value": "createdAt[gte]:\"2023-01-01\"", "description": "A simple filter param" }, "simpleNested": { "value": "emails.primaryEmail[eq]:foo99@example.com", "description": "A simple composite type filter param" }, "complex": { "value": "or(createdAt[gte]:\"2024-01-01\",createdAt[lte]:\"2023-01-01\",not(id[is]:NULL))", "description": "A more complex filter param" }, "like": { "value": "name[like]:\"%value%\"", "description": "Pattern matching" } } }, "depth": { "name": "depth", "in": "query", "description": "Determines the level of nested related objects to include in the response.\n - 0: Primary object only\n - 1: Primary object + direct relations", "required": false, "schema": { "type": "integer", "enum": [ 0, 1 ], "default": 1 } }, "upsert": { "name": "upsert", "in": "query", "description": "If true, creates the object or updates it if it already exists.", "required": false, "schema": { "type": "boolean", "default": false } }, "softDelete": { "name": "soft_delete", "in": "query", "description": "If true, soft deletes the objects. If false, objects are permanently deleted.", "required": false, "schema": { "type": "boolean", "default": false } }, "orderBy": { "name": "order_by", "in": "query", "description": "Format: **field_name_1,field_name_2[DIRECTION_2]\n Refer to the filter section at the top of the page for more details.", "required": false, "schema": { "type": "string" }, "examples": { "simple": { "value": "createdAt", "summary": "A simple order_by param" }, "complex": { "value": "id[AscNullsFirst],createdAt[DescNullsLast]", "summary": "A more complex order_by param" } } }, "limit": { "name": "limit", "in": "query", "description": "Limits the number of objects returned.", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 200, "default": 60 } }, "groupBy": { "name": "group_by", "in": "query", "description": "Array of fields to group by. Each element can specify a field and optionally a subfield or granularity for date fields.", "required": true, "schema": { "type": "string" }, "examples": { "simple": { "value": "[{\"updatedAt\": true}]", "summary": "Group by a single field" }, "subfield": { "value": "[{\"assignee\": {\"name\": true}}]", "summary": "Group by a relation field subfield" }, "dateGranularity": { "value": "[{\"createdAt\": {\"granularity\": \"MONTH\"}}]", "summary": "Group by date with granularity (DAY, WEEK, MONTH, YEAR)" } } }, "viewId": { "name": "view_id", "in": "query", "description": "View ID to apply filters from.", "required": false, "schema": { "type": "string", "format": "uuid" } }, "aggregate": { "name": "aggregate", "in": "query", "description": "Array of aggregate operations to compute for each group.", "required": false, "schema": { "type": "string" }, "examples": { "count": { "value": "[\"countNotEmptyId\"]", "summary": "Count non-empty IDs in each group" }, "multiple": { "value": "[\"countNotEmptyId\", \"sumAmount\"]", "summary": "Multiple aggregate operations" } } }, "includeRecordsSample": { "name": "include_records_sample", "in": "query", "description": "If true, includes a sample of records for each group in the response.", "required": false, "schema": { "type": "boolean", "default": false } }, "orderByForRecords": { "name": "order_by_for_records", "in": "query", "description": "Order by clause for records within each group. Only applicable when include_records_sample is true.", "required": false, "schema": { "type": "string" }, "examples": { "simple": { "value": "createdAt", "summary": "Order records by createdAt" } } } }, "responses": { "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number" }, "messages": { "type": "array", "items": { "type": "string" } }, "error": { "type": "string" } }, "example": { "statusCode": 400, "message": "error message", "error": "Bad Request" } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "number" }, "message": { "type": "string" }, "error": { "type": "string" } }, "example": { "statusCode": 401, "message": "Token invalid.", "error": "Unauthorized" } } } } } } }, "security": [ { "bearerAuth": [] } ], "externalDocs": { "description": "Find out more about **Twenty**", "url": "https://twenty.com" }, "paths": { "/open-api/core": { "get": { "tags": [ "General" ], "summary": "Get Open Api Schema", "operationId": "GetOpenApiSchema", "servers": [ { "url": "https://twenty.mardu.systems" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "openapi": { "type": "string" }, "info": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "termsOfService": { "type": "string" }, "contact": { "type": "object", "properties": { "email": { "type": "string" } } }, "license": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } } } } }, "servers": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "description": { "type": "string" } } } }, "components": { "type": "object", "properties": { "schemas": { "type": "object" }, "parameters": { "type": "object" }, "responses": { "type": "object" } } }, "paths": { "type": "object" }, "tags": { "type": "object" } } } } } } } } }, "/attachments": { "get": { "tags": [ "attachments" ], "summary": "Find Many attachments", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **attachments**", "operationId": "findManyAttachments", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "attachments" ], "summary": "Create One attachment", "operationId": "createOneAttachment", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attachment" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createAttachment": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "attachments" ], "summary": "Delete Many attachments", "operationId": "deleteManyAttachments", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteAttachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "attachments" ], "summary": "Update Many attachments", "operationId": "updateManyAttachments", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/attachments": { "post": { "tags": [ "attachments" ], "summary": "Create Many attachments", "operationId": "createManyAttachments", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/attachments/{id}": { "get": { "tags": [ "attachments" ], "summary": "Find One attachment", "description": "**depth** can be provided to request your **attachment**", "operationId": "findOneAttachment", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attachment": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "attachments" ], "summary": "Delete One attachment", "operationId": "deleteOneAttachment", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteAttachment": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "attachments" ], "summary": "Update One attachment", "operationId": "UpdateOneAttachment", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateAttachment": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/attachments/duplicates": { "post": { "tags": [ "attachments" ], "summary": "Find attachment Duplicates", "description": "**depth** can be provided to request your **attachment**", "operationId": "findAttachmentDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Attachment" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "cc6de50f-e4b7-4536-b148-55baaa5983bc" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "attachmentDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/attachments/{id}": { "patch": { "tags": [ "attachments" ], "summary": "Restore One attachment", "operationId": "restoreOneAttachment", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreAttachment": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/attachments": { "patch": { "tags": [ "attachments" ], "summary": "Restore Many attachments", "operationId": "restoreManyAttachments", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreAttachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/attachments/merge": { "patch": { "tags": [ "attachments" ], "summary": "Merge Many attachments", "operationId": "mergeManyAttachments", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "f85264a0-bc42-46cb-bfd2-bafbb05f7e57" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeAttachments": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/attachments/groupBy": { "get": { "tags": [ "attachments" ], "summary": "Group By attachments", "description": "Groups **attachments** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByAttachments", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "attachmentsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/AttachmentForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/blocklists": { "get": { "tags": [ "blocklists" ], "summary": "Find Many blocklists", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **blocklists**", "operationId": "findManyBlocklists", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "blocklists": { "type": "array", "items": { "$ref": "#/components/schemas/BlocklistForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "blocklists" ], "summary": "Create One blocklist", "operationId": "createOneBlocklist", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Blocklist" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createBlocklist": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "blocklists" ], "summary": "Delete Many blocklists", "operationId": "deleteManyBlocklists", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteBlocklists": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "blocklists" ], "summary": "Update Many blocklists", "operationId": "updateManyBlocklists", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlocklistForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateBlocklists": { "type": "array", "items": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/blocklists": { "post": { "tags": [ "blocklists" ], "summary": "Create Many blocklists", "operationId": "createManyBlocklists", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Blocklist" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createBlocklists": { "type": "array", "items": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/blocklists/{id}": { "get": { "tags": [ "blocklists" ], "summary": "Find One blocklist", "description": "**depth** can be provided to request your **blocklist**", "operationId": "findOneBlocklist", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "blocklist": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "blocklists" ], "summary": "Delete One blocklist", "operationId": "deleteOneBlocklist", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteBlocklist": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "blocklists" ], "summary": "Update One blocklist", "operationId": "UpdateOneBlocklist", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlocklistForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateBlocklist": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/blocklists/duplicates": { "post": { "tags": [ "blocklists" ], "summary": "Find blocklist Duplicates", "description": "**depth** can be provided to request your **blocklist**", "operationId": "findBlocklistDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Blocklist" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "7d1a268f-bbef-442c-ade7-91f541ecf64c" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "blocklistDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/blocklists/{id}": { "patch": { "tags": [ "blocklists" ], "summary": "Restore One blocklist", "operationId": "restoreOneBlocklist", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreBlocklist": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/blocklists": { "patch": { "tags": [ "blocklists" ], "summary": "Restore Many blocklists", "operationId": "restoreManyBlocklists", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreBlocklists": { "type": "array", "items": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/blocklists/merge": { "patch": { "tags": [ "blocklists" ], "summary": "Merge Many blocklists", "operationId": "mergeManyBlocklists", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "2a489ed7-3f48-49d1-9378-69da9728fefa" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeBlocklists": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/blocklists/groupBy": { "get": { "tags": [ "blocklists" ], "summary": "Group By blocklists", "description": "Groups **blocklists** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByBlocklists", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "blocklistsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/BlocklistForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/calendarChannelEventAssociations": { "get": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Find Many calendarChannelEventAssociations", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **calendarChannelEventAssociations**", "operationId": "findManyCalendarChannelEventAssociations", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarChannelEventAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Create One calendarChannelEventAssociation", "operationId": "createOneCalendarChannelEventAssociation", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarChannelEventAssociation" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createCalendarChannelEventAssociation": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Delete Many calendarChannelEventAssociations", "operationId": "deleteManyCalendarChannelEventAssociations", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteCalendarChannelEventAssociations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Update Many calendarChannelEventAssociations", "operationId": "updateManyCalendarChannelEventAssociations", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateCalendarChannelEventAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/calendarChannelEventAssociations": { "post": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Create Many calendarChannelEventAssociations", "operationId": "createManyCalendarChannelEventAssociations", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelEventAssociation" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createCalendarChannelEventAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarChannelEventAssociations/{id}": { "get": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Find One calendarChannelEventAssociation", "description": "**depth** can be provided to request your **calendarChannelEventAssociation**", "operationId": "findOneCalendarChannelEventAssociation", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarChannelEventAssociation": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Delete One calendarChannelEventAssociation", "operationId": "deleteOneCalendarChannelEventAssociation", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteCalendarChannelEventAssociation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Update One calendarChannelEventAssociation", "operationId": "UpdateOneCalendarChannelEventAssociation", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateCalendarChannelEventAssociation": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarChannelEventAssociations/duplicates": { "post": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Find calendarChannelEventAssociation Duplicates", "description": "**depth** can be provided to request your **calendarChannelEventAssociation**", "operationId": "findCalendarChannelEventAssociationDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelEventAssociation" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "1a69f5ee-fc1a-4b1d-b58f-37595453eca7" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "calendarChannelEventAssociationDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/calendarChannelEventAssociations/{id}": { "patch": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Restore One calendarChannelEventAssociation", "operationId": "restoreOneCalendarChannelEventAssociation", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreCalendarChannelEventAssociation": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/calendarChannelEventAssociations": { "patch": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Restore Many calendarChannelEventAssociations", "operationId": "restoreManyCalendarChannelEventAssociations", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreCalendarChannelEventAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarChannelEventAssociations/merge": { "patch": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Merge Many calendarChannelEventAssociations", "operationId": "mergeManyCalendarChannelEventAssociations", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "c61c2954-1844-407a-a0de-104d7851f19c" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeCalendarChannelEventAssociations": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarChannelEventAssociations/groupBy": { "get": { "tags": [ "calendarChannelEventAssociations" ], "summary": "Group By calendarChannelEventAssociations", "description": "Groups **calendarChannelEventAssociations** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByCalendarChannelEventAssociations", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarChannelEventAssociationsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/calendarChannels": { "get": { "tags": [ "calendarChannels" ], "summary": "Find Many calendarChannels", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **calendarChannels**", "operationId": "findManyCalendarChannels", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarChannels": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "calendarChannels" ], "summary": "Create One calendarChannel", "operationId": "createOneCalendarChannel", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarChannel" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createCalendarChannel": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "calendarChannels" ], "summary": "Delete Many calendarChannels", "operationId": "deleteManyCalendarChannels", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteCalendarChannels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "calendarChannels" ], "summary": "Update Many calendarChannels", "operationId": "updateManyCalendarChannels", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarChannelForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateCalendarChannels": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/calendarChannels": { "post": { "tags": [ "calendarChannels" ], "summary": "Create Many calendarChannels", "operationId": "createManyCalendarChannels", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannel" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createCalendarChannels": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarChannels/{id}": { "get": { "tags": [ "calendarChannels" ], "summary": "Find One calendarChannel", "description": "**depth** can be provided to request your **calendarChannel**", "operationId": "findOneCalendarChannel", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarChannel": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "calendarChannels" ], "summary": "Delete One calendarChannel", "operationId": "deleteOneCalendarChannel", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteCalendarChannel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "calendarChannels" ], "summary": "Update One calendarChannel", "operationId": "UpdateOneCalendarChannel", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarChannelForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateCalendarChannel": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarChannels/duplicates": { "post": { "tags": [ "calendarChannels" ], "summary": "Find calendarChannel Duplicates", "description": "**depth** can be provided to request your **calendarChannel**", "operationId": "findCalendarChannelDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannel" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "0be47682-780c-4b7a-ad85-a739621796de" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "calendarChannelDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/calendarChannels/{id}": { "patch": { "tags": [ "calendarChannels" ], "summary": "Restore One calendarChannel", "operationId": "restoreOneCalendarChannel", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreCalendarChannel": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/calendarChannels": { "patch": { "tags": [ "calendarChannels" ], "summary": "Restore Many calendarChannels", "operationId": "restoreManyCalendarChannels", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreCalendarChannels": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarChannels/merge": { "patch": { "tags": [ "calendarChannels" ], "summary": "Merge Many calendarChannels", "operationId": "mergeManyCalendarChannels", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "747626ca-0a39-4298-912d-4d36fb988062" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeCalendarChannels": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarChannels/groupBy": { "get": { "tags": [ "calendarChannels" ], "summary": "Group By calendarChannels", "description": "Groups **calendarChannels** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByCalendarChannels", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarChannelsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/calendarEventParticipants": { "get": { "tags": [ "calendarEventParticipants" ], "summary": "Find Many calendarEventParticipants", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **calendarEventParticipants**", "operationId": "findManyCalendarEventParticipants", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarEventParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "calendarEventParticipants" ], "summary": "Create One calendarEventParticipant", "operationId": "createOneCalendarEventParticipant", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarEventParticipant" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createCalendarEventParticipant": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "calendarEventParticipants" ], "summary": "Delete Many calendarEventParticipants", "operationId": "deleteManyCalendarEventParticipants", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteCalendarEventParticipants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "calendarEventParticipants" ], "summary": "Update Many calendarEventParticipants", "operationId": "updateManyCalendarEventParticipants", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarEventParticipantForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateCalendarEventParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/calendarEventParticipants": { "post": { "tags": [ "calendarEventParticipants" ], "summary": "Create Many calendarEventParticipants", "operationId": "createManyCalendarEventParticipants", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventParticipant" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createCalendarEventParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarEventParticipants/{id}": { "get": { "tags": [ "calendarEventParticipants" ], "summary": "Find One calendarEventParticipant", "description": "**depth** can be provided to request your **calendarEventParticipant**", "operationId": "findOneCalendarEventParticipant", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarEventParticipant": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "calendarEventParticipants" ], "summary": "Delete One calendarEventParticipant", "operationId": "deleteOneCalendarEventParticipant", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteCalendarEventParticipant": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "calendarEventParticipants" ], "summary": "Update One calendarEventParticipant", "operationId": "UpdateOneCalendarEventParticipant", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarEventParticipantForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateCalendarEventParticipant": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarEventParticipants/duplicates": { "post": { "tags": [ "calendarEventParticipants" ], "summary": "Find calendarEventParticipant Duplicates", "description": "**depth** can be provided to request your **calendarEventParticipant**", "operationId": "findCalendarEventParticipantDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventParticipant" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "9a210c70-065b-436f-a514-5d209ce0f0e7" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "calendarEventParticipantDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/calendarEventParticipants/{id}": { "patch": { "tags": [ "calendarEventParticipants" ], "summary": "Restore One calendarEventParticipant", "operationId": "restoreOneCalendarEventParticipant", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreCalendarEventParticipant": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/calendarEventParticipants": { "patch": { "tags": [ "calendarEventParticipants" ], "summary": "Restore Many calendarEventParticipants", "operationId": "restoreManyCalendarEventParticipants", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreCalendarEventParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarEventParticipants/merge": { "patch": { "tags": [ "calendarEventParticipants" ], "summary": "Merge Many calendarEventParticipants", "operationId": "mergeManyCalendarEventParticipants", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "f5e346e0-7e44-4e5f-856d-f6183789f8c8" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeCalendarEventParticipants": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarEventParticipants/groupBy": { "get": { "tags": [ "calendarEventParticipants" ], "summary": "Group By calendarEventParticipants", "description": "Groups **calendarEventParticipants** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByCalendarEventParticipants", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarEventParticipantsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/calendarEvents": { "get": { "tags": [ "calendarEvents" ], "summary": "Find Many calendarEvents", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **calendarEvents**", "operationId": "findManyCalendarEvents", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarEvents": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "calendarEvents" ], "summary": "Create One calendarEvent", "operationId": "createOneCalendarEvent", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarEvent" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createCalendarEvent": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "calendarEvents" ], "summary": "Delete Many calendarEvents", "operationId": "deleteManyCalendarEvents", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteCalendarEvents": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "calendarEvents" ], "summary": "Update Many calendarEvents", "operationId": "updateManyCalendarEvents", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarEventForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateCalendarEvents": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/calendarEvents": { "post": { "tags": [ "calendarEvents" ], "summary": "Create Many calendarEvents", "operationId": "createManyCalendarEvents", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEvent" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createCalendarEvents": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarEvents/{id}": { "get": { "tags": [ "calendarEvents" ], "summary": "Find One calendarEvent", "description": "**depth** can be provided to request your **calendarEvent**", "operationId": "findOneCalendarEvent", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarEvent": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "calendarEvents" ], "summary": "Delete One calendarEvent", "operationId": "deleteOneCalendarEvent", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteCalendarEvent": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "calendarEvents" ], "summary": "Update One calendarEvent", "operationId": "UpdateOneCalendarEvent", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CalendarEventForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateCalendarEvent": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarEvents/duplicates": { "post": { "tags": [ "calendarEvents" ], "summary": "Find calendarEvent Duplicates", "description": "**depth** can be provided to request your **calendarEvent**", "operationId": "findCalendarEventDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEvent" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "b6adf7e4-cdf6-4411-8035-c82dd09eae65" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "calendarEventDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/calendarEvents/{id}": { "patch": { "tags": [ "calendarEvents" ], "summary": "Restore One calendarEvent", "operationId": "restoreOneCalendarEvent", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreCalendarEvent": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/calendarEvents": { "patch": { "tags": [ "calendarEvents" ], "summary": "Restore Many calendarEvents", "operationId": "restoreManyCalendarEvents", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreCalendarEvents": { "type": "array", "items": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarEvents/merge": { "patch": { "tags": [ "calendarEvents" ], "summary": "Merge Many calendarEvents", "operationId": "mergeManyCalendarEvents", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "cd57b065-47f6-4d15-ba50-37115fbf0841" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeCalendarEvents": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/calendarEvents/groupBy": { "get": { "tags": [ "calendarEvents" ], "summary": "Group By calendarEvents", "description": "Groups **calendarEvents** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByCalendarEvents", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "calendarEventsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/CalendarEventForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/companies": { "get": { "tags": [ "companies" ], "summary": "Find Many companies", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **companies**", "operationId": "findManyCompanies", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "companies": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "companies" ], "summary": "Create One company", "operationId": "createOneCompany", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createCompany": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "companies" ], "summary": "Delete Many companies", "operationId": "deleteManyCompanies", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteCompanies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "companies" ], "summary": "Update Many companies", "operationId": "updateManyCompanies", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/companies": { "post": { "tags": [ "companies" ], "summary": "Create Many companies", "operationId": "createManyCompanies", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/companies/{id}": { "get": { "tags": [ "companies" ], "summary": "Find One company", "description": "**depth** can be provided to request your **company**", "operationId": "findOneCompany", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "company": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "companies" ], "summary": "Delete One company", "operationId": "deleteOneCompany", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteCompany": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "companies" ], "summary": "Update One company", "operationId": "UpdateOneCompany", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateCompany": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/companies/duplicates": { "post": { "tags": [ "companies" ], "summary": "Find company Duplicates", "description": "**depth** can be provided to request your **company**", "operationId": "findCompanyDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "4ee8e8ea-69c6-4097-954e-d70d9cae5f76" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "companyDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/companies/{id}": { "patch": { "tags": [ "companies" ], "summary": "Restore One company", "operationId": "restoreOneCompany", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreCompany": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/companies": { "patch": { "tags": [ "companies" ], "summary": "Restore Many companies", "operationId": "restoreManyCompanies", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreCompanies": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/companies/merge": { "patch": { "tags": [ "companies" ], "summary": "Merge Many companies", "operationId": "mergeManyCompanies", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "66f77aec-d7a9-4540-ad60-674a529648f4" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeCompanies": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/companies/groupBy": { "get": { "tags": [ "companies" ], "summary": "Group By companies", "description": "Groups **companies** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByCompanies", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "companiesGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/CompanyForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/connectedAccounts": { "get": { "tags": [ "connectedAccounts" ], "summary": "Find Many connectedAccounts", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **connectedAccounts**", "operationId": "findManyConnectedAccounts", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connectedAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "connectedAccounts" ], "summary": "Create One connectedAccount", "operationId": "createOneConnectedAccount", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedAccount" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createConnectedAccount": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "connectedAccounts" ], "summary": "Delete Many connectedAccounts", "operationId": "deleteManyConnectedAccounts", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteConnectedAccounts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "connectedAccounts" ], "summary": "Update Many connectedAccounts", "operationId": "updateManyConnectedAccounts", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedAccountForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateConnectedAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/connectedAccounts": { "post": { "tags": [ "connectedAccounts" ], "summary": "Create Many connectedAccounts", "operationId": "createManyConnectedAccounts", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedAccount" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createConnectedAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/connectedAccounts/{id}": { "get": { "tags": [ "connectedAccounts" ], "summary": "Find One connectedAccount", "description": "**depth** can be provided to request your **connectedAccount**", "operationId": "findOneConnectedAccount", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connectedAccount": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "connectedAccounts" ], "summary": "Delete One connectedAccount", "operationId": "deleteOneConnectedAccount", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteConnectedAccount": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "connectedAccounts" ], "summary": "Update One connectedAccount", "operationId": "UpdateOneConnectedAccount", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectedAccountForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateConnectedAccount": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/connectedAccounts/duplicates": { "post": { "tags": [ "connectedAccounts" ], "summary": "Find connectedAccount Duplicates", "description": "**depth** can be provided to request your **connectedAccount**", "operationId": "findConnectedAccountDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedAccount" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "0344d748-dd1e-4135-87bd-668f5ee8b09b" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "connectedAccountDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/connectedAccounts/{id}": { "patch": { "tags": [ "connectedAccounts" ], "summary": "Restore One connectedAccount", "operationId": "restoreOneConnectedAccount", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreConnectedAccount": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/connectedAccounts": { "patch": { "tags": [ "connectedAccounts" ], "summary": "Restore Many connectedAccounts", "operationId": "restoreManyConnectedAccounts", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreConnectedAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/connectedAccounts/merge": { "patch": { "tags": [ "connectedAccounts" ], "summary": "Merge Many connectedAccounts", "operationId": "mergeManyConnectedAccounts", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "e65ce976-d677-41d0-994b-0dbcbb341f72" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeConnectedAccounts": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/connectedAccounts/groupBy": { "get": { "tags": [ "connectedAccounts" ], "summary": "Group By connectedAccounts", "description": "Groups **connectedAccounts** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByConnectedAccounts", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "connectedAccountsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/dashboards": { "get": { "tags": [ "dashboards" ], "summary": "Find Many dashboards", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **dashboards**", "operationId": "findManyDashboards", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "dashboards": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "dashboards" ], "summary": "Create One dashboard", "operationId": "createOneDashboard", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Dashboard" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createDashboard": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "dashboards" ], "summary": "Delete Many dashboards", "operationId": "deleteManyDashboards", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteDashboards": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "dashboards" ], "summary": "Update Many dashboards", "operationId": "updateManyDashboards", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateDashboards": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/dashboards": { "post": { "tags": [ "dashboards" ], "summary": "Create Many dashboards", "operationId": "createManyDashboards", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Dashboard" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createDashboards": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dashboards/{id}": { "get": { "tags": [ "dashboards" ], "summary": "Find One dashboard", "description": "**depth** can be provided to request your **dashboard**", "operationId": "findOneDashboard", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "dashboard": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "dashboards" ], "summary": "Delete One dashboard", "operationId": "deleteOneDashboard", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteDashboard": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "dashboards" ], "summary": "Update One dashboard", "operationId": "UpdateOneDashboard", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateDashboard": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dashboards/duplicates": { "post": { "tags": [ "dashboards" ], "summary": "Find dashboard Duplicates", "description": "**depth** can be provided to request your **dashboard**", "operationId": "findDashboardDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Dashboard" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "0f941004-716c-4e2b-967f-c9ca48e97529" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "dashboardDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/dashboards/{id}": { "patch": { "tags": [ "dashboards" ], "summary": "Restore One dashboard", "operationId": "restoreOneDashboard", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreDashboard": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/dashboards": { "patch": { "tags": [ "dashboards" ], "summary": "Restore Many dashboards", "operationId": "restoreManyDashboards", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreDashboards": { "type": "array", "items": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dashboards/merge": { "patch": { "tags": [ "dashboards" ], "summary": "Merge Many dashboards", "operationId": "mergeManyDashboards", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "ea76cdce-0f45-4d6f-883d-3427514f111f" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeDashboards": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/dashboards/groupBy": { "get": { "tags": [ "dashboards" ], "summary": "Group By dashboards", "description": "Groups **dashboards** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByDashboards", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "dashboardsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/DashboardForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/favoriteFolders": { "get": { "tags": [ "favoriteFolders" ], "summary": "Find Many favoriteFolders", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **favoriteFolders**", "operationId": "findManyFavoriteFolders", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "favoriteFolders": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "favoriteFolders" ], "summary": "Create One favoriteFolder", "operationId": "createOneFavoriteFolder", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FavoriteFolder" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createFavoriteFolder": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "favoriteFolders" ], "summary": "Delete Many favoriteFolders", "operationId": "deleteManyFavoriteFolders", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteFavoriteFolders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "favoriteFolders" ], "summary": "Update Many favoriteFolders", "operationId": "updateManyFavoriteFolders", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FavoriteFolderForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateFavoriteFolders": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/favoriteFolders": { "post": { "tags": [ "favoriteFolders" ], "summary": "Create Many favoriteFolders", "operationId": "createManyFavoriteFolders", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteFolder" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createFavoriteFolders": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/favoriteFolders/{id}": { "get": { "tags": [ "favoriteFolders" ], "summary": "Find One favoriteFolder", "description": "**depth** can be provided to request your **favoriteFolder**", "operationId": "findOneFavoriteFolder", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "favoriteFolder": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "favoriteFolders" ], "summary": "Delete One favoriteFolder", "operationId": "deleteOneFavoriteFolder", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteFavoriteFolder": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "favoriteFolders" ], "summary": "Update One favoriteFolder", "operationId": "UpdateOneFavoriteFolder", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FavoriteFolderForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateFavoriteFolder": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/favoriteFolders/duplicates": { "post": { "tags": [ "favoriteFolders" ], "summary": "Find favoriteFolder Duplicates", "description": "**depth** can be provided to request your **favoriteFolder**", "operationId": "findFavoriteFolderDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteFolder" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "2bf07127-2041-438e-83c6-fe94f898f06d" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "favoriteFolderDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/favoriteFolders/{id}": { "patch": { "tags": [ "favoriteFolders" ], "summary": "Restore One favoriteFolder", "operationId": "restoreOneFavoriteFolder", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreFavoriteFolder": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/favoriteFolders": { "patch": { "tags": [ "favoriteFolders" ], "summary": "Restore Many favoriteFolders", "operationId": "restoreManyFavoriteFolders", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreFavoriteFolders": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/favoriteFolders/merge": { "patch": { "tags": [ "favoriteFolders" ], "summary": "Merge Many favoriteFolders", "operationId": "mergeManyFavoriteFolders", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "388d5525-4199-4b39-b04f-a67def39a953" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeFavoriteFolders": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/favoriteFolders/groupBy": { "get": { "tags": [ "favoriteFolders" ], "summary": "Group By favoriteFolders", "description": "Groups **favoriteFolders** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByFavoriteFolders", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "favoriteFoldersGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/favorites": { "get": { "tags": [ "favorites" ], "summary": "Find Many favorites", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **favorites**", "operationId": "findManyFavorites", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "favorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "favorites" ], "summary": "Create One favorite", "operationId": "createOneFavorite", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Favorite" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createFavorite": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "favorites" ], "summary": "Delete Many favorites", "operationId": "deleteManyFavorites", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteFavorites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "favorites" ], "summary": "Update Many favorites", "operationId": "updateManyFavorites", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FavoriteForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateFavorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/favorites": { "post": { "tags": [ "favorites" ], "summary": "Create Many favorites", "operationId": "createManyFavorites", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Favorite" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createFavorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/favorites/{id}": { "get": { "tags": [ "favorites" ], "summary": "Find One favorite", "description": "**depth** can be provided to request your **favorite**", "operationId": "findOneFavorite", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "favorite": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "favorites" ], "summary": "Delete One favorite", "operationId": "deleteOneFavorite", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteFavorite": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "favorites" ], "summary": "Update One favorite", "operationId": "UpdateOneFavorite", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FavoriteForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateFavorite": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/favorites/duplicates": { "post": { "tags": [ "favorites" ], "summary": "Find favorite Duplicates", "description": "**depth** can be provided to request your **favorite**", "operationId": "findFavoriteDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Favorite" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "73516ef3-f1fe-4410-86ee-28b800530774" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "favoriteDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/favorites/{id}": { "patch": { "tags": [ "favorites" ], "summary": "Restore One favorite", "operationId": "restoreOneFavorite", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreFavorite": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/favorites": { "patch": { "tags": [ "favorites" ], "summary": "Restore Many favorites", "operationId": "restoreManyFavorites", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreFavorites": { "type": "array", "items": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/favorites/merge": { "patch": { "tags": [ "favorites" ], "summary": "Merge Many favorites", "operationId": "mergeManyFavorites", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "02a5850d-458e-4a39-9787-85c42002a79e" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeFavorites": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/favorites/groupBy": { "get": { "tags": [ "favorites" ], "summary": "Group By favorites", "description": "Groups **favorites** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByFavorites", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "favoritesGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/FavoriteForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/messageChannelMessageAssociations": { "get": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Find Many messageChannelMessageAssociations", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **messageChannelMessageAssociations**", "operationId": "findManyMessageChannelMessageAssociations", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageChannelMessageAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Create One messageChannelMessageAssociation", "operationId": "createOneMessageChannelMessageAssociation", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageChannelMessageAssociation" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessageChannelMessageAssociation": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Delete Many messageChannelMessageAssociations", "operationId": "deleteManyMessageChannelMessageAssociations", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessageChannelMessageAssociations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Update Many messageChannelMessageAssociations", "operationId": "updateManyMessageChannelMessageAssociations", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessageChannelMessageAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/messageChannelMessageAssociations": { "post": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Create Many messageChannelMessageAssociations", "operationId": "createManyMessageChannelMessageAssociations", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociation" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessageChannelMessageAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageChannelMessageAssociations/{id}": { "get": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Find One messageChannelMessageAssociation", "description": "**depth** can be provided to request your **messageChannelMessageAssociation**", "operationId": "findOneMessageChannelMessageAssociation", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageChannelMessageAssociation": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Delete One messageChannelMessageAssociation", "operationId": "deleteOneMessageChannelMessageAssociation", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessageChannelMessageAssociation": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Update One messageChannelMessageAssociation", "operationId": "UpdateOneMessageChannelMessageAssociation", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessageChannelMessageAssociation": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageChannelMessageAssociations/duplicates": { "post": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Find messageChannelMessageAssociation Duplicates", "description": "**depth** can be provided to request your **messageChannelMessageAssociation**", "operationId": "findMessageChannelMessageAssociationDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociation" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "0be08d72-0ff9-4da1-8dc7-0b7a7e71946f" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "messageChannelMessageAssociationDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messageChannelMessageAssociations/{id}": { "patch": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Restore One messageChannelMessageAssociation", "operationId": "restoreOneMessageChannelMessageAssociation", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessageChannelMessageAssociation": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messageChannelMessageAssociations": { "patch": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Restore Many messageChannelMessageAssociations", "operationId": "restoreManyMessageChannelMessageAssociations", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessageChannelMessageAssociations": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageChannelMessageAssociations/merge": { "patch": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Merge Many messageChannelMessageAssociations", "operationId": "mergeManyMessageChannelMessageAssociations", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "53164178-1873-4f09-9d21-db69ddda8851" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeMessageChannelMessageAssociations": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageChannelMessageAssociations/groupBy": { "get": { "tags": [ "messageChannelMessageAssociations" ], "summary": "Group By messageChannelMessageAssociations", "description": "Groups **messageChannelMessageAssociations** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByMessageChannelMessageAssociations", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageChannelMessageAssociationsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/messageChannels": { "get": { "tags": [ "messageChannels" ], "summary": "Find Many messageChannels", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **messageChannels**", "operationId": "findManyMessageChannels", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "messageChannels" ], "summary": "Create One messageChannel", "operationId": "createOneMessageChannel", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageChannel" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessageChannel": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messageChannels" ], "summary": "Delete Many messageChannels", "operationId": "deleteManyMessageChannels", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessageChannels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messageChannels" ], "summary": "Update Many messageChannels", "operationId": "updateManyMessageChannels", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageChannelForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessageChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/messageChannels": { "post": { "tags": [ "messageChannels" ], "summary": "Create Many messageChannels", "operationId": "createManyMessageChannels", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannel" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessageChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageChannels/{id}": { "get": { "tags": [ "messageChannels" ], "summary": "Find One messageChannel", "description": "**depth** can be provided to request your **messageChannel**", "operationId": "findOneMessageChannel", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageChannel": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messageChannels" ], "summary": "Delete One messageChannel", "operationId": "deleteOneMessageChannel", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessageChannel": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messageChannels" ], "summary": "Update One messageChannel", "operationId": "UpdateOneMessageChannel", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageChannelForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessageChannel": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageChannels/duplicates": { "post": { "tags": [ "messageChannels" ], "summary": "Find messageChannel Duplicates", "description": "**depth** can be provided to request your **messageChannel**", "operationId": "findMessageChannelDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannel" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "d302c299-683f-4751-9a0a-72d5ccfedfdd" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "messageChannelDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messageChannels/{id}": { "patch": { "tags": [ "messageChannels" ], "summary": "Restore One messageChannel", "operationId": "restoreOneMessageChannel", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessageChannel": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messageChannels": { "patch": { "tags": [ "messageChannels" ], "summary": "Restore Many messageChannels", "operationId": "restoreManyMessageChannels", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessageChannels": { "type": "array", "items": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageChannels/merge": { "patch": { "tags": [ "messageChannels" ], "summary": "Merge Many messageChannels", "operationId": "mergeManyMessageChannels", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "3f4d7b97-ed1a-41d9-bf1b-4c0242261237" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeMessageChannels": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageChannels/groupBy": { "get": { "tags": [ "messageChannels" ], "summary": "Group By messageChannels", "description": "Groups **messageChannels** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByMessageChannels", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageChannelsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/MessageChannelForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/messageFolders": { "get": { "tags": [ "messageFolders" ], "summary": "Find Many messageFolders", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **messageFolders**", "operationId": "findManyMessageFolders", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageFolders": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "messageFolders" ], "summary": "Create One messageFolder", "operationId": "createOneMessageFolder", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageFolder" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessageFolder": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messageFolders" ], "summary": "Delete Many messageFolders", "operationId": "deleteManyMessageFolders", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessageFolders": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messageFolders" ], "summary": "Update Many messageFolders", "operationId": "updateManyMessageFolders", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageFolderForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessageFolders": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/messageFolders": { "post": { "tags": [ "messageFolders" ], "summary": "Create Many messageFolders", "operationId": "createManyMessageFolders", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFolder" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessageFolders": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageFolders/{id}": { "get": { "tags": [ "messageFolders" ], "summary": "Find One messageFolder", "description": "**depth** can be provided to request your **messageFolder**", "operationId": "findOneMessageFolder", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageFolder": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messageFolders" ], "summary": "Delete One messageFolder", "operationId": "deleteOneMessageFolder", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessageFolder": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messageFolders" ], "summary": "Update One messageFolder", "operationId": "UpdateOneMessageFolder", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageFolderForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessageFolder": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageFolders/duplicates": { "post": { "tags": [ "messageFolders" ], "summary": "Find messageFolder Duplicates", "description": "**depth** can be provided to request your **messageFolder**", "operationId": "findMessageFolderDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFolder" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "37b3b24a-5fe8-4305-8c36-83dfdb67938b" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "messageFolderDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messageFolders/{id}": { "patch": { "tags": [ "messageFolders" ], "summary": "Restore One messageFolder", "operationId": "restoreOneMessageFolder", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessageFolder": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messageFolders": { "patch": { "tags": [ "messageFolders" ], "summary": "Restore Many messageFolders", "operationId": "restoreManyMessageFolders", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessageFolders": { "type": "array", "items": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageFolders/merge": { "patch": { "tags": [ "messageFolders" ], "summary": "Merge Many messageFolders", "operationId": "mergeManyMessageFolders", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "0690e899-8902-40de-81e7-19e5563c625b" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeMessageFolders": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageFolders/groupBy": { "get": { "tags": [ "messageFolders" ], "summary": "Group By messageFolders", "description": "Groups **messageFolders** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByMessageFolders", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageFoldersGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/MessageFolderForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/messageParticipants": { "get": { "tags": [ "messageParticipants" ], "summary": "Find Many messageParticipants", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **messageParticipants**", "operationId": "findManyMessageParticipants", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "messageParticipants" ], "summary": "Create One messageParticipant", "operationId": "createOneMessageParticipant", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageParticipant" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessageParticipant": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messageParticipants" ], "summary": "Delete Many messageParticipants", "operationId": "deleteManyMessageParticipants", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessageParticipants": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messageParticipants" ], "summary": "Update Many messageParticipants", "operationId": "updateManyMessageParticipants", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageParticipantForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessageParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/messageParticipants": { "post": { "tags": [ "messageParticipants" ], "summary": "Create Many messageParticipants", "operationId": "createManyMessageParticipants", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParticipant" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessageParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageParticipants/{id}": { "get": { "tags": [ "messageParticipants" ], "summary": "Find One messageParticipant", "description": "**depth** can be provided to request your **messageParticipant**", "operationId": "findOneMessageParticipant", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageParticipant": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messageParticipants" ], "summary": "Delete One messageParticipant", "operationId": "deleteOneMessageParticipant", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessageParticipant": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messageParticipants" ], "summary": "Update One messageParticipant", "operationId": "UpdateOneMessageParticipant", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageParticipantForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessageParticipant": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageParticipants/duplicates": { "post": { "tags": [ "messageParticipants" ], "summary": "Find messageParticipant Duplicates", "description": "**depth** can be provided to request your **messageParticipant**", "operationId": "findMessageParticipantDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParticipant" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "b4538985-c6ec-4b03-8990-5040ca9784ee" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "messageParticipantDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messageParticipants/{id}": { "patch": { "tags": [ "messageParticipants" ], "summary": "Restore One messageParticipant", "operationId": "restoreOneMessageParticipant", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessageParticipant": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messageParticipants": { "patch": { "tags": [ "messageParticipants" ], "summary": "Restore Many messageParticipants", "operationId": "restoreManyMessageParticipants", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessageParticipants": { "type": "array", "items": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageParticipants/merge": { "patch": { "tags": [ "messageParticipants" ], "summary": "Merge Many messageParticipants", "operationId": "mergeManyMessageParticipants", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "9ae9621c-fca7-41ae-90ae-013596ca7403" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeMessageParticipants": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageParticipants/groupBy": { "get": { "tags": [ "messageParticipants" ], "summary": "Group By messageParticipants", "description": "Groups **messageParticipants** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByMessageParticipants", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageParticipantsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/messages": { "get": { "tags": [ "messages" ], "summary": "Find Many messages", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **messages**", "operationId": "findManyMessages", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messages": { "type": "array", "items": { "$ref": "#/components/schemas/MessageForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "messages" ], "summary": "Create One message", "operationId": "createOneMessage", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessage": { "$ref": "#/components/schemas/MessageForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messages" ], "summary": "Delete Many messages", "operationId": "deleteManyMessages", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessages": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messages" ], "summary": "Update Many messages", "operationId": "updateManyMessages", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessages": { "type": "array", "items": { "$ref": "#/components/schemas/MessageForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/messages": { "post": { "tags": [ "messages" ], "summary": "Create Many messages", "operationId": "createManyMessages", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessages": { "type": "array", "items": { "$ref": "#/components/schemas/MessageForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messages/{id}": { "get": { "tags": [ "messages" ], "summary": "Find One message", "description": "**depth** can be provided to request your **message**", "operationId": "findOneMessage", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "message": { "$ref": "#/components/schemas/MessageForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messages" ], "summary": "Delete One message", "operationId": "deleteOneMessage", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessage": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messages" ], "summary": "Update One message", "operationId": "UpdateOneMessage", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessage": { "$ref": "#/components/schemas/MessageForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messages/duplicates": { "post": { "tags": [ "messages" ], "summary": "Find message Duplicates", "description": "**depth** can be provided to request your **message**", "operationId": "findMessageDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "ebb84c2a-179c-4dc6-a33e-fcdc4f7e5568" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "messageDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/MessageForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messages/{id}": { "patch": { "tags": [ "messages" ], "summary": "Restore One message", "operationId": "restoreOneMessage", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessage": { "$ref": "#/components/schemas/MessageForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messages": { "patch": { "tags": [ "messages" ], "summary": "Restore Many messages", "operationId": "restoreManyMessages", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessages": { "type": "array", "items": { "$ref": "#/components/schemas/MessageForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messages/merge": { "patch": { "tags": [ "messages" ], "summary": "Merge Many messages", "operationId": "mergeManyMessages", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "28d1c33f-bb73-4416-912f-a915abc53419" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeMessages": { "$ref": "#/components/schemas/MessageForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messages/groupBy": { "get": { "tags": [ "messages" ], "summary": "Group By messages", "description": "Groups **messages** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByMessages", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messagesGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/MessageForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/messageThreads": { "get": { "tags": [ "messageThreads" ], "summary": "Find Many messageThreads", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **messageThreads**", "operationId": "findManyMessageThreads", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageThreads": { "type": "array", "items": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "messageThreads" ], "summary": "Create One messageThread", "operationId": "createOneMessageThread", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageThread" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessageThread": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messageThreads" ], "summary": "Delete Many messageThreads", "operationId": "deleteManyMessageThreads", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessageThreads": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messageThreads" ], "summary": "Update Many messageThreads", "operationId": "updateManyMessageThreads", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageThreadForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessageThreads": { "type": "array", "items": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/messageThreads": { "post": { "tags": [ "messageThreads" ], "summary": "Create Many messageThreads", "operationId": "createManyMessageThreads", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MessageThread" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createMessageThreads": { "type": "array", "items": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageThreads/{id}": { "get": { "tags": [ "messageThreads" ], "summary": "Find One messageThread", "description": "**depth** can be provided to request your **messageThread**", "operationId": "findOneMessageThread", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageThread": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "messageThreads" ], "summary": "Delete One messageThread", "operationId": "deleteOneMessageThread", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteMessageThread": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "messageThreads" ], "summary": "Update One messageThread", "operationId": "UpdateOneMessageThread", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MessageThreadForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateMessageThread": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageThreads/duplicates": { "post": { "tags": [ "messageThreads" ], "summary": "Find messageThread Duplicates", "description": "**depth** can be provided to request your **messageThread**", "operationId": "findMessageThreadDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/MessageThread" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "78f40905-2041-449f-93b8-a187a38c5f50" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "messageThreadDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messageThreads/{id}": { "patch": { "tags": [ "messageThreads" ], "summary": "Restore One messageThread", "operationId": "restoreOneMessageThread", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessageThread": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/messageThreads": { "patch": { "tags": [ "messageThreads" ], "summary": "Restore Many messageThreads", "operationId": "restoreManyMessageThreads", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreMessageThreads": { "type": "array", "items": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageThreads/merge": { "patch": { "tags": [ "messageThreads" ], "summary": "Merge Many messageThreads", "operationId": "mergeManyMessageThreads", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "1bad9222-769e-4daf-a4e2-0ee9a1287810" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeMessageThreads": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/messageThreads/groupBy": { "get": { "tags": [ "messageThreads" ], "summary": "Group By messageThreads", "description": "Groups **messageThreads** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByMessageThreads", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "messageThreadsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/MessageThreadForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/notes": { "get": { "tags": [ "notes" ], "summary": "Find Many notes", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **notes**", "operationId": "findManyNotes", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "notes": { "type": "array", "items": { "$ref": "#/components/schemas/NoteForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "notes" ], "summary": "Create One note", "operationId": "createOneNote", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Note" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createNote": { "$ref": "#/components/schemas/NoteForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "notes" ], "summary": "Delete Many notes", "operationId": "deleteManyNotes", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteNotes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "notes" ], "summary": "Update Many notes", "operationId": "updateManyNotes", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateNotes": { "type": "array", "items": { "$ref": "#/components/schemas/NoteForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/notes": { "post": { "tags": [ "notes" ], "summary": "Create Many notes", "operationId": "createManyNotes", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createNotes": { "type": "array", "items": { "$ref": "#/components/schemas/NoteForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/notes/{id}": { "get": { "tags": [ "notes" ], "summary": "Find One note", "description": "**depth** can be provided to request your **note**", "operationId": "findOneNote", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "note": { "$ref": "#/components/schemas/NoteForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "notes" ], "summary": "Delete One note", "operationId": "deleteOneNote", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteNote": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "notes" ], "summary": "Update One note", "operationId": "UpdateOneNote", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateNote": { "$ref": "#/components/schemas/NoteForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/notes/duplicates": { "post": { "tags": [ "notes" ], "summary": "Find note Duplicates", "description": "**depth** can be provided to request your **note**", "operationId": "findNoteDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Note" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "979f8efe-ac7a-441f-a88e-93c26a2c6b80" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "noteDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/NoteForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/notes/{id}": { "patch": { "tags": [ "notes" ], "summary": "Restore One note", "operationId": "restoreOneNote", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreNote": { "$ref": "#/components/schemas/NoteForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/notes": { "patch": { "tags": [ "notes" ], "summary": "Restore Many notes", "operationId": "restoreManyNotes", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreNotes": { "type": "array", "items": { "$ref": "#/components/schemas/NoteForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/notes/merge": { "patch": { "tags": [ "notes" ], "summary": "Merge Many notes", "operationId": "mergeManyNotes", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "e0763d82-d82f-4fbb-90ea-c23fa265a907" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeNotes": { "$ref": "#/components/schemas/NoteForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/notes/groupBy": { "get": { "tags": [ "notes" ], "summary": "Group By notes", "description": "Groups **notes** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByNotes", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "notesGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/NoteForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/noteTargets": { "get": { "tags": [ "noteTargets" ], "summary": "Find Many noteTargets", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **noteTargets**", "operationId": "findManyNoteTargets", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "noteTargets": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "noteTargets" ], "summary": "Create One noteTarget", "operationId": "createOneNoteTarget", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteTarget" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createNoteTarget": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "noteTargets" ], "summary": "Delete Many noteTargets", "operationId": "deleteManyNoteTargets", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteNoteTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "noteTargets" ], "summary": "Update Many noteTargets", "operationId": "updateManyNoteTargets", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteTargetForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateNoteTargets": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/noteTargets": { "post": { "tags": [ "noteTargets" ], "summary": "Create Many noteTargets", "operationId": "createManyNoteTargets", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTarget" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createNoteTargets": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/noteTargets/{id}": { "get": { "tags": [ "noteTargets" ], "summary": "Find One noteTarget", "description": "**depth** can be provided to request your **noteTarget**", "operationId": "findOneNoteTarget", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "noteTarget": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "noteTargets" ], "summary": "Delete One noteTarget", "operationId": "deleteOneNoteTarget", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteNoteTarget": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "noteTargets" ], "summary": "Update One noteTarget", "operationId": "UpdateOneNoteTarget", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteTargetForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateNoteTarget": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/noteTargets/duplicates": { "post": { "tags": [ "noteTargets" ], "summary": "Find noteTarget Duplicates", "description": "**depth** can be provided to request your **noteTarget**", "operationId": "findNoteTargetDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTarget" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "a956b884-da0b-4d83-a445-fd1f8d95215a" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "noteTargetDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/noteTargets/{id}": { "patch": { "tags": [ "noteTargets" ], "summary": "Restore One noteTarget", "operationId": "restoreOneNoteTarget", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreNoteTarget": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/noteTargets": { "patch": { "tags": [ "noteTargets" ], "summary": "Restore Many noteTargets", "operationId": "restoreManyNoteTargets", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreNoteTargets": { "type": "array", "items": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/noteTargets/merge": { "patch": { "tags": [ "noteTargets" ], "summary": "Merge Many noteTargets", "operationId": "mergeManyNoteTargets", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "b3342ece-c41b-42ce-a488-3afb24eeb482" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeNoteTargets": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/noteTargets/groupBy": { "get": { "tags": [ "noteTargets" ], "summary": "Group By noteTargets", "description": "Groups **noteTargets** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByNoteTargets", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "noteTargetsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/NoteTargetForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/opportunities": { "get": { "tags": [ "opportunities" ], "summary": "Find Many opportunities", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **opportunities**", "operationId": "findManyOpportunities", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "opportunities": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "opportunities" ], "summary": "Create One opportunity", "operationId": "createOneOpportunity", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Opportunity" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createOpportunity": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "opportunities" ], "summary": "Delete Many opportunities", "operationId": "deleteManyOpportunities", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteOpportunities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "opportunities" ], "summary": "Update Many opportunities", "operationId": "updateManyOpportunities", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateOpportunities": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/opportunities": { "post": { "tags": [ "opportunities" ], "summary": "Create Many opportunities", "operationId": "createManyOpportunities", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Opportunity" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createOpportunities": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/opportunities/{id}": { "get": { "tags": [ "opportunities" ], "summary": "Find One opportunity", "description": "**depth** can be provided to request your **opportunity**", "operationId": "findOneOpportunity", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "opportunity": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "opportunities" ], "summary": "Delete One opportunity", "operationId": "deleteOneOpportunity", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteOpportunity": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "opportunities" ], "summary": "Update One opportunity", "operationId": "UpdateOneOpportunity", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateOpportunity": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/opportunities/duplicates": { "post": { "tags": [ "opportunities" ], "summary": "Find opportunity Duplicates", "description": "**depth** can be provided to request your **opportunity**", "operationId": "findOpportunityDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Opportunity" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "664645fb-6bce-4438-be04-1a492cd0a926" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "opportunityDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/opportunities/{id}": { "patch": { "tags": [ "opportunities" ], "summary": "Restore One opportunity", "operationId": "restoreOneOpportunity", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreOpportunity": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/opportunities": { "patch": { "tags": [ "opportunities" ], "summary": "Restore Many opportunities", "operationId": "restoreManyOpportunities", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreOpportunities": { "type": "array", "items": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/opportunities/merge": { "patch": { "tags": [ "opportunities" ], "summary": "Merge Many opportunities", "operationId": "mergeManyOpportunities", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "e735af7b-a4a5-4533-a0b0-e52f7e79f4ab" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeOpportunities": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/opportunities/groupBy": { "get": { "tags": [ "opportunities" ], "summary": "Group By opportunities", "description": "Groups **opportunities** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByOpportunities", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "opportunitiesGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/OpportunityForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/people": { "get": { "tags": [ "people" ], "summary": "Find Many people", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **people**", "operationId": "findManyPeople", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "people": { "type": "array", "items": { "$ref": "#/components/schemas/PersonForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "people" ], "summary": "Create One person", "operationId": "createOnePerson", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Person" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createPerson": { "$ref": "#/components/schemas/PersonForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "people" ], "summary": "Delete Many people", "operationId": "deleteManyPeople", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deletePeople": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "people" ], "summary": "Update Many people", "operationId": "updateManyPeople", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updatePeople": { "type": "array", "items": { "$ref": "#/components/schemas/PersonForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/people": { "post": { "tags": [ "people" ], "summary": "Create Many people", "operationId": "createManyPeople", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Person" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createPeople": { "type": "array", "items": { "$ref": "#/components/schemas/PersonForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/people/{id}": { "get": { "tags": [ "people" ], "summary": "Find One person", "description": "**depth** can be provided to request your **person**", "operationId": "findOnePerson", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "person": { "$ref": "#/components/schemas/PersonForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "people" ], "summary": "Delete One person", "operationId": "deleteOnePerson", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deletePerson": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "people" ], "summary": "Update One person", "operationId": "UpdateOnePerson", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PersonForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updatePerson": { "$ref": "#/components/schemas/PersonForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/people/duplicates": { "post": { "tags": [ "people" ], "summary": "Find person Duplicates", "description": "**depth** can be provided to request your **person**", "operationId": "findPersonDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Person" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "cbfe9864-f6f5-4ed9-99c4-bb7bc8a7e876" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "personDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/PersonForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/people/{id}": { "patch": { "tags": [ "people" ], "summary": "Restore One person", "operationId": "restoreOnePerson", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restorePerson": { "$ref": "#/components/schemas/PersonForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/people": { "patch": { "tags": [ "people" ], "summary": "Restore Many people", "operationId": "restoreManyPeople", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restorePeople": { "type": "array", "items": { "$ref": "#/components/schemas/PersonForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/people/merge": { "patch": { "tags": [ "people" ], "summary": "Merge Many people", "operationId": "mergeManyPeople", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "9bf0bcdb-eceb-41ec-b259-340c8e8d72e3" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergePeople": { "$ref": "#/components/schemas/PersonForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/people/groupBy": { "get": { "tags": [ "people" ], "summary": "Group By people", "description": "Groups **people** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByPeople", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "peopleGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/PersonForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/tasks": { "get": { "tags": [ "tasks" ], "summary": "Find Many tasks", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **tasks**", "operationId": "findManyTasks", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/TaskForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "tasks" ], "summary": "Create One task", "operationId": "createOneTask", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createTask": { "$ref": "#/components/schemas/TaskForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "tasks" ], "summary": "Delete Many tasks", "operationId": "deleteManyTasks", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteTasks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "tasks" ], "summary": "Update Many tasks", "operationId": "updateManyTasks", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateTasks": { "type": "array", "items": { "$ref": "#/components/schemas/TaskForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/tasks": { "post": { "tags": [ "tasks" ], "summary": "Create Many tasks", "operationId": "createManyTasks", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createTasks": { "type": "array", "items": { "$ref": "#/components/schemas/TaskForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tasks/{id}": { "get": { "tags": [ "tasks" ], "summary": "Find One task", "description": "**depth** can be provided to request your **task**", "operationId": "findOneTask", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "task": { "$ref": "#/components/schemas/TaskForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "tasks" ], "summary": "Delete One task", "operationId": "deleteOneTask", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteTask": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "tasks" ], "summary": "Update One task", "operationId": "UpdateOneTask", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateTask": { "$ref": "#/components/schemas/TaskForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tasks/duplicates": { "post": { "tags": [ "tasks" ], "summary": "Find task Duplicates", "description": "**depth** can be provided to request your **task**", "operationId": "findTaskDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "913a7e6c-8c55-4ae8-b74c-4f082e08d708" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "taskDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/TaskForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/tasks/{id}": { "patch": { "tags": [ "tasks" ], "summary": "Restore One task", "operationId": "restoreOneTask", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreTask": { "$ref": "#/components/schemas/TaskForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/tasks": { "patch": { "tags": [ "tasks" ], "summary": "Restore Many tasks", "operationId": "restoreManyTasks", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreTasks": { "type": "array", "items": { "$ref": "#/components/schemas/TaskForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tasks/merge": { "patch": { "tags": [ "tasks" ], "summary": "Merge Many tasks", "operationId": "mergeManyTasks", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "fe20a543-c721-40e8-b0ea-cf24ff9ede61" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeTasks": { "$ref": "#/components/schemas/TaskForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/tasks/groupBy": { "get": { "tags": [ "tasks" ], "summary": "Group By tasks", "description": "Groups **tasks** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByTasks", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "tasksGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/TaskForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/taskTargets": { "get": { "tags": [ "taskTargets" ], "summary": "Find Many taskTargets", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **taskTargets**", "operationId": "findManyTaskTargets", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "taskTargets": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "taskTargets" ], "summary": "Create One taskTarget", "operationId": "createOneTaskTarget", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskTarget" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createTaskTarget": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "taskTargets" ], "summary": "Delete Many taskTargets", "operationId": "deleteManyTaskTargets", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteTaskTargets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "taskTargets" ], "summary": "Update Many taskTargets", "operationId": "updateManyTaskTargets", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskTargetForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateTaskTargets": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/taskTargets": { "post": { "tags": [ "taskTargets" ], "summary": "Create Many taskTargets", "operationId": "createManyTaskTargets", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTarget" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createTaskTargets": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/taskTargets/{id}": { "get": { "tags": [ "taskTargets" ], "summary": "Find One taskTarget", "description": "**depth** can be provided to request your **taskTarget**", "operationId": "findOneTaskTarget", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "taskTarget": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "taskTargets" ], "summary": "Delete One taskTarget", "operationId": "deleteOneTaskTarget", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteTaskTarget": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "taskTargets" ], "summary": "Update One taskTarget", "operationId": "UpdateOneTaskTarget", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskTargetForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateTaskTarget": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/taskTargets/duplicates": { "post": { "tags": [ "taskTargets" ], "summary": "Find taskTarget Duplicates", "description": "**depth** can be provided to request your **taskTarget**", "operationId": "findTaskTargetDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTarget" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "ee04b027-1f6f-4007-a1ea-f73cd9c08cd3" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "taskTargetDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/taskTargets/{id}": { "patch": { "tags": [ "taskTargets" ], "summary": "Restore One taskTarget", "operationId": "restoreOneTaskTarget", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreTaskTarget": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/taskTargets": { "patch": { "tags": [ "taskTargets" ], "summary": "Restore Many taskTargets", "operationId": "restoreManyTaskTargets", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreTaskTargets": { "type": "array", "items": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/taskTargets/merge": { "patch": { "tags": [ "taskTargets" ], "summary": "Merge Many taskTargets", "operationId": "mergeManyTaskTargets", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "dc83bcc3-04b1-4eef-a562-0ad935f5ecfc" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeTaskTargets": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/taskTargets/groupBy": { "get": { "tags": [ "taskTargets" ], "summary": "Group By taskTargets", "description": "Groups **taskTargets** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByTaskTargets", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "taskTargetsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/TaskTargetForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/timelineActivities": { "get": { "tags": [ "timelineActivities" ], "summary": "Find Many timelineActivities", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **timelineActivities**", "operationId": "findManyTimelineActivities", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "timelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "timelineActivities" ], "summary": "Create One timelineActivity", "operationId": "createOneTimelineActivity", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineActivity" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createTimelineActivity": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "timelineActivities" ], "summary": "Delete Many timelineActivities", "operationId": "deleteManyTimelineActivities", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteTimelineActivities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "timelineActivities" ], "summary": "Update Many timelineActivities", "operationId": "updateManyTimelineActivities", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineActivityForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateTimelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/timelineActivities": { "post": { "tags": [ "timelineActivities" ], "summary": "Create Many timelineActivities", "operationId": "createManyTimelineActivities", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivity" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createTimelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/timelineActivities/{id}": { "get": { "tags": [ "timelineActivities" ], "summary": "Find One timelineActivity", "description": "**depth** can be provided to request your **timelineActivity**", "operationId": "findOneTimelineActivity", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "timelineActivity": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "timelineActivities" ], "summary": "Delete One timelineActivity", "operationId": "deleteOneTimelineActivity", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteTimelineActivity": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "timelineActivities" ], "summary": "Update One timelineActivity", "operationId": "UpdateOneTimelineActivity", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimelineActivityForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateTimelineActivity": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/timelineActivities/duplicates": { "post": { "tags": [ "timelineActivities" ], "summary": "Find timelineActivity Duplicates", "description": "**depth** can be provided to request your **timelineActivity**", "operationId": "findTimelineActivityDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivity" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "7dc38ec7-7307-491c-8a13-e04ccd679f60" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "timelineActivityDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/timelineActivities/{id}": { "patch": { "tags": [ "timelineActivities" ], "summary": "Restore One timelineActivity", "operationId": "restoreOneTimelineActivity", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreTimelineActivity": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/timelineActivities": { "patch": { "tags": [ "timelineActivities" ], "summary": "Restore Many timelineActivities", "operationId": "restoreManyTimelineActivities", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreTimelineActivities": { "type": "array", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/timelineActivities/merge": { "patch": { "tags": [ "timelineActivities" ], "summary": "Merge Many timelineActivities", "operationId": "mergeManyTimelineActivities", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "a3774091-9788-421e-a06b-4847d343886e" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeTimelineActivities": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/timelineActivities/groupBy": { "get": { "tags": [ "timelineActivities" ], "summary": "Group By timelineActivities", "description": "Groups **timelineActivities** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByTimelineActivities", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "timelineActivitiesGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/workflowAutomatedTriggers": { "get": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Find Many workflowAutomatedTriggers", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **workflowAutomatedTriggers**", "operationId": "findManyWorkflowAutomatedTriggers", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflowAutomatedTriggers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Create One workflowAutomatedTrigger", "operationId": "createOneWorkflowAutomatedTrigger", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAutomatedTrigger" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createWorkflowAutomatedTrigger": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Delete Many workflowAutomatedTriggers", "operationId": "deleteManyWorkflowAutomatedTriggers", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteWorkflowAutomatedTriggers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Update Many workflowAutomatedTriggers", "operationId": "updateManyWorkflowAutomatedTriggers", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateWorkflowAutomatedTriggers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/workflowAutomatedTriggers": { "post": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Create Many workflowAutomatedTriggers", "operationId": "createManyWorkflowAutomatedTriggers", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAutomatedTrigger" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createWorkflowAutomatedTriggers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowAutomatedTriggers/{id}": { "get": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Find One workflowAutomatedTrigger", "description": "**depth** can be provided to request your **workflowAutomatedTrigger**", "operationId": "findOneWorkflowAutomatedTrigger", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflowAutomatedTrigger": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Delete One workflowAutomatedTrigger", "operationId": "deleteOneWorkflowAutomatedTrigger", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteWorkflowAutomatedTrigger": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Update One workflowAutomatedTrigger", "operationId": "UpdateOneWorkflowAutomatedTrigger", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateWorkflowAutomatedTrigger": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowAutomatedTriggers/duplicates": { "post": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Find workflowAutomatedTrigger Duplicates", "description": "**depth** can be provided to request your **workflowAutomatedTrigger**", "operationId": "findWorkflowAutomatedTriggerDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAutomatedTrigger" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "4fe91c7f-6cf5-4716-a403-ed62c091a377" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "workflowAutomatedTriggerDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/workflowAutomatedTriggers/{id}": { "patch": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Restore One workflowAutomatedTrigger", "operationId": "restoreOneWorkflowAutomatedTrigger", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreWorkflowAutomatedTrigger": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/workflowAutomatedTriggers": { "patch": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Restore Many workflowAutomatedTriggers", "operationId": "restoreManyWorkflowAutomatedTriggers", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreWorkflowAutomatedTriggers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowAutomatedTriggers/merge": { "patch": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Merge Many workflowAutomatedTriggers", "operationId": "mergeManyWorkflowAutomatedTriggers", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "a9e53ceb-2e20-4c7d-93f1-1d2803ff4f32" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeWorkflowAutomatedTriggers": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowAutomatedTriggers/groupBy": { "get": { "tags": [ "workflowAutomatedTriggers" ], "summary": "Group By workflowAutomatedTriggers", "description": "Groups **workflowAutomatedTriggers** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByWorkflowAutomatedTriggers", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflowAutomatedTriggersGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/workflowRuns": { "get": { "tags": [ "workflowRuns" ], "summary": "Find Many workflowRuns", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **workflowRuns**", "operationId": "findManyWorkflowRuns", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflowRuns": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "workflowRuns" ], "summary": "Create One workflowRun", "operationId": "createOneWorkflowRun", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRun" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createWorkflowRun": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "workflowRuns" ], "summary": "Delete Many workflowRuns", "operationId": "deleteManyWorkflowRuns", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteWorkflowRuns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "workflowRuns" ], "summary": "Update Many workflowRuns", "operationId": "updateManyWorkflowRuns", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateWorkflowRuns": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/workflowRuns": { "post": { "tags": [ "workflowRuns" ], "summary": "Create Many workflowRuns", "operationId": "createManyWorkflowRuns", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRun" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createWorkflowRuns": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowRuns/{id}": { "get": { "tags": [ "workflowRuns" ], "summary": "Find One workflowRun", "description": "**depth** can be provided to request your **workflowRun**", "operationId": "findOneWorkflowRun", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflowRun": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "workflowRuns" ], "summary": "Delete One workflowRun", "operationId": "deleteOneWorkflowRun", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteWorkflowRun": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "workflowRuns" ], "summary": "Update One workflowRun", "operationId": "UpdateOneWorkflowRun", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowRunForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateWorkflowRun": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowRuns/duplicates": { "post": { "tags": [ "workflowRuns" ], "summary": "Find workflowRun Duplicates", "description": "**depth** can be provided to request your **workflowRun**", "operationId": "findWorkflowRunDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRun" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "53bc7cb2-f832-47c2-9a4f-3f5b4ebb3d64" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "workflowRunDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/workflowRuns/{id}": { "patch": { "tags": [ "workflowRuns" ], "summary": "Restore One workflowRun", "operationId": "restoreOneWorkflowRun", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreWorkflowRun": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/workflowRuns": { "patch": { "tags": [ "workflowRuns" ], "summary": "Restore Many workflowRuns", "operationId": "restoreManyWorkflowRuns", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreWorkflowRuns": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowRuns/merge": { "patch": { "tags": [ "workflowRuns" ], "summary": "Merge Many workflowRuns", "operationId": "mergeManyWorkflowRuns", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "12ebd9c0-0f5f-46da-8293-63e6d4db6240" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeWorkflowRuns": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowRuns/groupBy": { "get": { "tags": [ "workflowRuns" ], "summary": "Group By workflowRuns", "description": "Groups **workflowRuns** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByWorkflowRuns", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflowRunsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/workflows": { "get": { "tags": [ "workflows" ], "summary": "Find Many workflows", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **workflows**", "operationId": "findManyWorkflows", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflows": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "workflows" ], "summary": "Create One workflow", "operationId": "createOneWorkflow", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createWorkflow": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "workflows" ], "summary": "Delete Many workflows", "operationId": "deleteManyWorkflows", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteWorkflows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "workflows" ], "summary": "Update Many workflows", "operationId": "updateManyWorkflows", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateWorkflows": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/workflows": { "post": { "tags": [ "workflows" ], "summary": "Create Many workflows", "operationId": "createManyWorkflows", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createWorkflows": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflows/{id}": { "get": { "tags": [ "workflows" ], "summary": "Find One workflow", "description": "**depth** can be provided to request your **workflow**", "operationId": "findOneWorkflow", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflow": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "workflows" ], "summary": "Delete One workflow", "operationId": "deleteOneWorkflow", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteWorkflow": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "workflows" ], "summary": "Update One workflow", "operationId": "UpdateOneWorkflow", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateWorkflow": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflows/duplicates": { "post": { "tags": [ "workflows" ], "summary": "Find workflow Duplicates", "description": "**depth** can be provided to request your **workflow**", "operationId": "findWorkflowDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "a71289cc-e76a-4daf-86cf-19ce336341a2" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "workflowDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/workflows/{id}": { "patch": { "tags": [ "workflows" ], "summary": "Restore One workflow", "operationId": "restoreOneWorkflow", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreWorkflow": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/workflows": { "patch": { "tags": [ "workflows" ], "summary": "Restore Many workflows", "operationId": "restoreManyWorkflows", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreWorkflows": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflows/merge": { "patch": { "tags": [ "workflows" ], "summary": "Merge Many workflows", "operationId": "mergeManyWorkflows", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "6da608d8-6a4d-4fff-9fa5-d5d9a89e3bdc" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeWorkflows": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflows/groupBy": { "get": { "tags": [ "workflows" ], "summary": "Group By workflows", "description": "Groups **workflows** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByWorkflows", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflowsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/WorkflowForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/workflowVersions": { "get": { "tags": [ "workflowVersions" ], "summary": "Find Many workflowVersions", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **workflowVersions**", "operationId": "findManyWorkflowVersions", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflowVersions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "workflowVersions" ], "summary": "Create One workflowVersion", "operationId": "createOneWorkflowVersion", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowVersion" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createWorkflowVersion": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "workflowVersions" ], "summary": "Delete Many workflowVersions", "operationId": "deleteManyWorkflowVersions", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteWorkflowVersions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "workflowVersions" ], "summary": "Update Many workflowVersions", "operationId": "updateManyWorkflowVersions", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowVersionForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateWorkflowVersions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/workflowVersions": { "post": { "tags": [ "workflowVersions" ], "summary": "Create Many workflowVersions", "operationId": "createManyWorkflowVersions", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVersion" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createWorkflowVersions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowVersions/{id}": { "get": { "tags": [ "workflowVersions" ], "summary": "Find One workflowVersion", "description": "**depth** can be provided to request your **workflowVersion**", "operationId": "findOneWorkflowVersion", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflowVersion": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "workflowVersions" ], "summary": "Delete One workflowVersion", "operationId": "deleteOneWorkflowVersion", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteWorkflowVersion": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "workflowVersions" ], "summary": "Update One workflowVersion", "operationId": "UpdateOneWorkflowVersion", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowVersionForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateWorkflowVersion": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowVersions/duplicates": { "post": { "tags": [ "workflowVersions" ], "summary": "Find workflowVersion Duplicates", "description": "**depth** can be provided to request your **workflowVersion**", "operationId": "findWorkflowVersionDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVersion" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "6fd087a7-71d2-45ce-9ae8-df8ab357d615" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "workflowVersionDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/workflowVersions/{id}": { "patch": { "tags": [ "workflowVersions" ], "summary": "Restore One workflowVersion", "operationId": "restoreOneWorkflowVersion", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreWorkflowVersion": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/workflowVersions": { "patch": { "tags": [ "workflowVersions" ], "summary": "Restore Many workflowVersions", "operationId": "restoreManyWorkflowVersions", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreWorkflowVersions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowVersions/merge": { "patch": { "tags": [ "workflowVersions" ], "summary": "Merge Many workflowVersions", "operationId": "mergeManyWorkflowVersions", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "53080c11-b2c0-4d7d-8b22-e763ce11c482" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeWorkflowVersions": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workflowVersions/groupBy": { "get": { "tags": [ "workflowVersions" ], "summary": "Group By workflowVersions", "description": "Groups **workflowVersions** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByWorkflowVersions", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workflowVersionsGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/workspaceMembers": { "get": { "tags": [ "workspaceMembers" ], "summary": "Find Many workspaceMembers", "description": "**order_by**, **filter**, **limit**, **depth**, **starting_after** or **ending_before** can be provided to request your **workspaceMembers**", "operationId": "findManyWorkspaceMembers", "parameters": [ { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/startingAfter" }, { "$ref": "#/components/parameters/endingBefore" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workspaceMembers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "totalCount": { "type": "integer" } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "post": { "tags": [ "workspaceMembers" ], "summary": "Create One workspaceMember", "operationId": "createOneWorkspaceMember", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMember" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createWorkspaceMember": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "workspaceMembers" ], "summary": "Delete Many workspaceMembers", "operationId": "deleteManyWorkspaceMembers", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteWorkspaceMembers": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "workspaceMembers" ], "summary": "Update Many workspaceMembers", "operationId": "updateManyWorkspaceMembers", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/filter" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateWorkspaceMembers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/batch/workspaceMembers": { "post": { "tags": [ "workspaceMembers" ], "summary": "Create Many workspaceMembers", "operationId": "createManyWorkspaceMembers", "parameters": [ { "$ref": "#/components/parameters/depth" }, { "$ref": "#/components/parameters/upsert" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceMember" } } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "createWorkspaceMembers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workspaceMembers/{id}": { "get": { "tags": [ "workspaceMembers" ], "summary": "Find One workspaceMember", "description": "**depth** can be provided to request your **workspaceMember**", "operationId": "findOneWorkspaceMember", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workspaceMember": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "delete": { "tags": [ "workspaceMembers" ], "summary": "Delete One workspaceMember", "operationId": "deleteOneWorkspaceMember", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/softDelete" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "deleteWorkspaceMember": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } }, "patch": { "tags": [ "workspaceMembers" ], "summary": "Update One workspaceMember", "operationId": "UpdateOneWorkspaceMember", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkspaceMemberForUpdate" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "updateWorkspaceMember": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workspaceMembers/duplicates": { "post": { "tags": [ "workspaceMembers" ], "summary": "Find workspaceMember Duplicates", "description": "**depth** can be provided to request your **workspaceMember**", "operationId": "findWorkspaceMemberDuplicates", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceMember" } }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "example": { "ids": [ "ae73f421-0d2f-4838-9b6f-b81f0ce24e00" ] } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "totalCount": { "type": "number" }, "pageInfo": { "type": "object", "properties": { "hasNextPage": { "type": "boolean" }, "startCursor": { "type": "string", "format": "uuid" }, "endCursor": { "type": "string", "format": "uuid" } } }, "workspaceMemberDuplicates": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/workspaceMembers/{id}": { "patch": { "tags": [ "workspaceMembers" ], "summary": "Restore One workspaceMember", "operationId": "restoreOneWorkspaceMember", "parameters": [ { "$ref": "#/components/parameters/idPath" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreWorkspaceMember": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/restore/workspaceMembers": { "patch": { "tags": [ "workspaceMembers" ], "summary": "Restore Many workspaceMembers", "operationId": "restoreManyWorkspaceMembers", "parameters": [ { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/depth" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "restoreWorkspaceMembers": { "type": "array", "items": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workspaceMembers/merge": { "patch": { "tags": [ "workspaceMembers" ], "summary": "Merge Many workspaceMembers", "operationId": "mergeManyWorkspaceMembers", "parameters": [ { "$ref": "#/components/parameters/depth" } ], "requestBody": { "description": "body", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "description": "The IDs of the records to merge", "items": { "type": "string", "format": "uuid" } }, "conflictPriorityIndex": { "type": "number", "description": "The index of the record to use when conflicts occur" }, "dryRun": { "description": "If true, the merge will not be performed and a preview of the merge will be returned.", "type": "boolean", "default": false } }, "example": { "ids": [ "c535c2fc-16da-4199-a386-3404e1fc0599" ], "conflictPriorityIndex": 0, "dryRun": false }, "required": [ "ids", "conflictPriorityIndex" ] } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "mergeWorkspaceMembers": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } }, "/workspaceMembers/groupBy": { "get": { "tags": [ "workspaceMembers" ], "summary": "Group By workspaceMembers", "description": "Groups **workspaceMembers** by specified fields and optionally computes aggregate values for each group.", "operationId": "groupByWorkspaceMembers", "parameters": [ { "$ref": "#/components/parameters/groupBy" }, { "$ref": "#/components/parameters/filter" }, { "$ref": "#/components/parameters/orderBy" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/viewId" }, { "$ref": "#/components/parameters/aggregate" }, { "$ref": "#/components/parameters/includeRecordsSample" }, { "$ref": "#/components/parameters/orderByForRecords" } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "workspaceMembersGroupBy": { "type": "array", "items": { "type": "object", "properties": { "groupByDimensionValues": { "type": "array", "description": "Array of values representing each dimension in the group", "items": { "type": "string" } }, "records": { "type": "array", "description": "Sample of records for this group (only present when include_records_sample is true)", "items": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } }, "additionalProperties": { "type": "number", "description": "Aggregate values (e.g., countNotEmptyId)" } } } } } } } } } } } } }, "/dashboards/{id}/duplicate": { "post": { "tags": [ "dashboards" ], "summary": "Duplicate a dashboard", "description": "Creates a duplicate of an existing dashboard", "operationId": "duplicateDashboard", "parameters": [ { "$ref": "#/components/parameters/idPath" } ], "responses": { "201": { "description": "Dashboard duplicated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DashboardForResponse" } } } }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" } } } } }, "webhooks": { "Attachment Created": { "post": { "tags": [ "attachment" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "attachment.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "attachment" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Attachment Updated": { "post": { "tags": [ "attachment" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "attachment.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "attachment" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/AttachmentForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Attachment Deleted": { "post": { "tags": [ "attachment" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "attachment.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "attachment" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/AttachmentForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Blocklist Created": { "post": { "tags": [ "blocklist" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "blocklist.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "blocklist" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Blocklist Updated": { "post": { "tags": [ "blocklist" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "blocklist.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "blocklist" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/BlocklistForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Blocklist Deleted": { "post": { "tags": [ "blocklist" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "blocklist.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "blocklist" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/BlocklistForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarChannelEventAssociation Created": { "post": { "tags": [ "calendarChannelEventAssociation" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarChannelEventAssociation.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarChannelEventAssociation" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarChannelEventAssociation Updated": { "post": { "tags": [ "calendarChannelEventAssociation" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarChannelEventAssociation.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarChannelEventAssociation" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarChannelEventAssociation Deleted": { "post": { "tags": [ "calendarChannelEventAssociation" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarChannelEventAssociation.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarChannelEventAssociation" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarChannelEventAssociationForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarChannel Created": { "post": { "tags": [ "calendarChannel" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarChannel.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarChannel" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarChannel Updated": { "post": { "tags": [ "calendarChannel" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarChannel.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarChannel" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarChannelForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarChannel Deleted": { "post": { "tags": [ "calendarChannel" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarChannel.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarChannel" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarChannelForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarEventParticipant Created": { "post": { "tags": [ "calendarEventParticipant" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarEventParticipant.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarEventParticipant" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarEventParticipant Updated": { "post": { "tags": [ "calendarEventParticipant" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarEventParticipant.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarEventParticipant" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarEventParticipant Deleted": { "post": { "tags": [ "calendarEventParticipant" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarEventParticipant.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarEventParticipant" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarEventParticipantForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarEvent Created": { "post": { "tags": [ "calendarEvent" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarEvent.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarEvent" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarEvent Updated": { "post": { "tags": [ "calendarEvent" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarEvent.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarEvent" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarEventForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "CalendarEvent Deleted": { "post": { "tags": [ "calendarEvent" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "calendarEvent.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "calendarEvent" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CalendarEventForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Company Created": { "post": { "tags": [ "company" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "company.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "company" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Company Updated": { "post": { "tags": [ "company" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "company.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "company" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CompanyForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Company Deleted": { "post": { "tags": [ "company" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "company.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "company" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/CompanyForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "ConnectedAccount Created": { "post": { "tags": [ "connectedAccount" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "connectedAccount.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "connectedAccount" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "ConnectedAccount Updated": { "post": { "tags": [ "connectedAccount" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "connectedAccount.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "connectedAccount" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/ConnectedAccountForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "ConnectedAccount Deleted": { "post": { "tags": [ "connectedAccount" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "connectedAccount.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "connectedAccount" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/ConnectedAccountForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Dashboard Created": { "post": { "tags": [ "dashboard" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "dashboard.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "dashboard" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Dashboard Updated": { "post": { "tags": [ "dashboard" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "dashboard.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "dashboard" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/DashboardForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Dashboard Deleted": { "post": { "tags": [ "dashboard" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "dashboard.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "dashboard" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/DashboardForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "FavoriteFolder Created": { "post": { "tags": [ "favoriteFolder" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "favoriteFolder.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "favoriteFolder" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "FavoriteFolder Updated": { "post": { "tags": [ "favoriteFolder" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "favoriteFolder.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "favoriteFolder" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/FavoriteFolderForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "FavoriteFolder Deleted": { "post": { "tags": [ "favoriteFolder" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "favoriteFolder.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "favoriteFolder" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/FavoriteFolderForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Favorite Created": { "post": { "tags": [ "favorite" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "favorite.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "favorite" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Favorite Updated": { "post": { "tags": [ "favorite" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "favorite.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "favorite" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/FavoriteForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Favorite Deleted": { "post": { "tags": [ "favorite" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "favorite.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "favorite" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/FavoriteForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageChannelMessageAssociation Created": { "post": { "tags": [ "messageChannelMessageAssociation" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageChannelMessageAssociation.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageChannelMessageAssociation" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageChannelMessageAssociation Updated": { "post": { "tags": [ "messageChannelMessageAssociation" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageChannelMessageAssociation.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageChannelMessageAssociation" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageChannelMessageAssociation Deleted": { "post": { "tags": [ "messageChannelMessageAssociation" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageChannelMessageAssociation.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageChannelMessageAssociation" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageChannelMessageAssociationForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageChannel Created": { "post": { "tags": [ "messageChannel" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageChannel.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageChannel" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageChannel Updated": { "post": { "tags": [ "messageChannel" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageChannel.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageChannel" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageChannelForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageChannel Deleted": { "post": { "tags": [ "messageChannel" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageChannel.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageChannel" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageChannelForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageFolder Created": { "post": { "tags": [ "messageFolder" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageFolder.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageFolder" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageFolder Updated": { "post": { "tags": [ "messageFolder" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageFolder.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageFolder" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageFolderForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageFolder Deleted": { "post": { "tags": [ "messageFolder" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageFolder.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageFolder" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageFolderForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageParticipant Created": { "post": { "tags": [ "messageParticipant" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageParticipant.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageParticipant" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageParticipant Updated": { "post": { "tags": [ "messageParticipant" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageParticipant.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageParticipant" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageParticipantForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageParticipant Deleted": { "post": { "tags": [ "messageParticipant" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageParticipant.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageParticipant" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageParticipantForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Message Created": { "post": { "tags": [ "message" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "message.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "message" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Message Updated": { "post": { "tags": [ "message" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "message.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "message" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Message Deleted": { "post": { "tags": [ "message" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "message.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "message" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageThread Created": { "post": { "tags": [ "messageThread" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageThread.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageThread" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageThread Updated": { "post": { "tags": [ "messageThread" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageThread.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageThread" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageThreadForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "MessageThread Deleted": { "post": { "tags": [ "messageThread" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "messageThread.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "messageThread" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/MessageThreadForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Note Created": { "post": { "tags": [ "note" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "note.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "note" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/NoteForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Note Updated": { "post": { "tags": [ "note" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "note.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "note" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/NoteForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Note Deleted": { "post": { "tags": [ "note" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "note.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "note" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/NoteForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "NoteTarget Created": { "post": { "tags": [ "noteTarget" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "noteTarget.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "noteTarget" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "NoteTarget Updated": { "post": { "tags": [ "noteTarget" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "noteTarget.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "noteTarget" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/NoteTargetForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "NoteTarget Deleted": { "post": { "tags": [ "noteTarget" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "noteTarget.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "noteTarget" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/NoteTargetForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Opportunity Created": { "post": { "tags": [ "opportunity" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "opportunity.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "opportunity" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Opportunity Updated": { "post": { "tags": [ "opportunity" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "opportunity.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "opportunity" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/OpportunityForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Opportunity Deleted": { "post": { "tags": [ "opportunity" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "opportunity.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "opportunity" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/OpportunityForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Person Created": { "post": { "tags": [ "person" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "person.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "person" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/PersonForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Person Updated": { "post": { "tags": [ "person" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "person.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "person" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/PersonForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Person Deleted": { "post": { "tags": [ "person" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "person.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "person" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/PersonForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Task Created": { "post": { "tags": [ "task" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "task.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "task" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/TaskForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Task Updated": { "post": { "tags": [ "task" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "task.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "task" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/TaskForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Task Deleted": { "post": { "tags": [ "task" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "task.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "task" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/TaskForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "TaskTarget Created": { "post": { "tags": [ "taskTarget" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "taskTarget.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "taskTarget" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "TaskTarget Updated": { "post": { "tags": [ "taskTarget" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "taskTarget.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "taskTarget" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/TaskTargetForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "TaskTarget Deleted": { "post": { "tags": [ "taskTarget" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "taskTarget.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "taskTarget" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/TaskTargetForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "TimelineActivity Created": { "post": { "tags": [ "timelineActivity" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "timelineActivity.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "timelineActivity" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "TimelineActivity Updated": { "post": { "tags": [ "timelineActivity" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "timelineActivity.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "timelineActivity" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/TimelineActivityForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "TimelineActivity Deleted": { "post": { "tags": [ "timelineActivity" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "timelineActivity.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "timelineActivity" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/TimelineActivityForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkflowAutomatedTrigger Created": { "post": { "tags": [ "workflowAutomatedTrigger" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflowAutomatedTrigger.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflowAutomatedTrigger" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkflowAutomatedTrigger Updated": { "post": { "tags": [ "workflowAutomatedTrigger" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflowAutomatedTrigger.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflowAutomatedTrigger" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkflowAutomatedTrigger Deleted": { "post": { "tags": [ "workflowAutomatedTrigger" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflowAutomatedTrigger.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflowAutomatedTrigger" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowAutomatedTriggerForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkflowRun Created": { "post": { "tags": [ "workflowRun" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflowRun.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflowRun" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkflowRun Updated": { "post": { "tags": [ "workflowRun" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflowRun.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflowRun" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowRunForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkflowRun Deleted": { "post": { "tags": [ "workflowRun" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflowRun.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflowRun" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowRunForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Workflow Created": { "post": { "tags": [ "workflow" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflow.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflow" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Workflow Updated": { "post": { "tags": [ "workflow" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflow.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflow" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "Workflow Deleted": { "post": { "tags": [ "workflow" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflow.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflow" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkflowVersion Created": { "post": { "tags": [ "workflowVersion" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflowVersion.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflowVersion" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkflowVersion Updated": { "post": { "tags": [ "workflowVersion" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflowVersion.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflowVersion" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowVersionForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkflowVersion Deleted": { "post": { "tags": [ "workflowVersion" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workflowVersion.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workflowVersion" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkflowVersionForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkspaceMember Created": { "post": { "tags": [ "workspaceMember" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workspaceMember.created" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workspaceMember" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkspaceMember Updated": { "post": { "tags": [ "workspaceMember" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workspaceMember.updated" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workspaceMember" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" }, "updatedFields": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } }, "WorkspaceMember Deleted": { "post": { "tags": [ "workspaceMember" ], "security": [], "parameters": [ { "in": "header", "name": "X-Twenty-Webhook-Signature", "schema": { "type": "string" }, "description": "HMAC SHA256 signature of the request payload using the webhook secret. To compute the signature:\n1. Concatenate `X-Twenty-Webhook-Timestamp`, a colon (:), and the JSON string of the request payload.\n2. Compute the HMAC SHA256 hash using the shared secret as the key.\n3. Send the resulting hex digest as this header value.\nExample (Node.js):\n```javascript\nconst crypto = require(\"crypto\");\nconst timestamp = \"1735066639761\";\nconst payload = JSON.stringify({...});\nconst secret = \"your-secret\";\nconst stringToSign = `${timestamp}:${JSON.stringify(payload)}`;\nconst signature = crypto.createHmac(\"sha256\", secret)\n .update(stringToSign)\n .digest(\"hex\");\n```", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Timestamp", "schema": { "type": "string" }, "description": "Unix timestamp of when the webhook was sent. This timestamp is included in the HMAC signature generation to prevent replay attacks.", "required": false }, { "in": "header", "name": "X-Twenty-Webhook-Nonce", "schema": { "type": "string" }, "description": "Unique identifier for this webhook request to prevent replay attacks. Consumers should ensure this nonce is not reused.", "required": false } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetUrl": { "type": "string", "example": "https://example.com/incomingWebhook" }, "eventName": { "type": "string", "example": "workspaceMember.deleted" }, "objectMetadata": { "type": "object", "properties": { "id": { "type": "string", "example": "370985db-22d8-4463-8e5f-2271d30913bd" }, "nameSingular": { "type": "string", "enum": [ "workspaceMember" ] } } }, "workspaceId": { "type": "string", "example": "872cfcf1-c79f-42bc-877d-5829f06eb3f9" }, "userId": { "type": "string", "example": "170ba418-85a2-4f91-8565-9cd714c6703a" }, "workspaceMemberId": { "type": "string", "example": "9062a1e3-e066-49ba-8c4a-d869b6a0ca12" }, "webhookId": { "type": "string", "example": "90056586-1228-4e03-a507-70140aa85c05" }, "eventDate": { "type": "string", "example": "2024-02-14T11:27:01.779Z" }, "record": { "$ref": "#/components/schemas/WorkspaceMemberForResponse" } } } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } } } } }, "tags": [ { "name": "General", "description": "General requests" }, { "name": "attachments", "description": "Object `Attachments`" }, { "name": "blocklists", "description": "Object `Blocklists`" }, { "name": "calendarChannelEventAssociations", "description": "Object `CalendarChannelEventAssociations`" }, { "name": "calendarChannels", "description": "Object `CalendarChannels`" }, { "name": "calendarEventParticipants", "description": "Object `CalendarEventParticipants`" }, { "name": "calendarEvents", "description": "Object `CalendarEvents`" }, { "name": "companies", "description": "Object `Companies`" }, { "name": "connectedAccounts", "description": "Object `ConnectedAccounts`" }, { "name": "dashboards", "description": "Object `Dashboards`" }, { "name": "favoriteFolders", "description": "Object `FavoriteFolders`" }, { "name": "favorites", "description": "Object `Favorites`" }, { "name": "messageChannelMessageAssociations", "description": "Object `MessageChannelMessageAssociations`" }, { "name": "messageChannels", "description": "Object `MessageChannels`" }, { "name": "messageFolders", "description": "Object `MessageFolders`" }, { "name": "messageParticipants", "description": "Object `MessageParticipants`" }, { "name": "messages", "description": "Object `Messages`" }, { "name": "messageThreads", "description": "Object `MessageThreads`" }, { "name": "notes", "description": "Object `Notes`" }, { "name": "noteTargets", "description": "Object `NoteTargets`" }, { "name": "opportunities", "description": "Object `Opportunities`" }, { "name": "people", "description": "Object `People`" }, { "name": "tasks", "description": "Object `Tasks`" }, { "name": "taskTargets", "description": "Object `TaskTargets`" }, { "name": "timelineActivities", "description": "Object `TimelineActivities`" }, { "name": "workflowAutomatedTriggers", "description": "Object `WorkflowAutomatedTriggers`" }, { "name": "workflowRuns", "description": "Object `WorkflowRuns`" }, { "name": "workflows", "description": "Object `Workflows`" }, { "name": "workflowVersions", "description": "Object `WorkflowVersions`" }, { "name": "workspaceMembers", "description": "Object `WorkspaceMembers`" } ] }