Generated reference · API

Yemaya API

# Yemaya Creative Production Platform API

719endpoints720schemas1.0.0version

On this page

API Keys (3)#

GET/v1/auth/api-keysList API keys
POST/v1/auth/api-keysCreate API key
DELETE/v1/auth/api-keys/{id}Delete API key

API Versioning (12)#

GET/v1/versionsGet API version information
GET/v1/versions/:version/deprecationGet deprecation information for a version
GET/v1/versions/:version/status-countsGet feature status counts
GET/v1/versions/compatibilityGet API version compatibility matrix
GET/v1/versions/compatibility/categoriesGet feature categories
GET/v1/versions/compatibility/checkCheck feature compatibility
GET/v1/versions/compatibility/compareCompare feature compatibility between versions
GET/v1/versions/migrationGet migration guide between versions
GET/v1/versions/migration/breaking-changesGet breaking changes between versions
GET/v1/versions/migration/pathGet full migration path between versions
GET/v1/versions/migration/summaryGet migration summary
GET/v1/versions/upgradesGet available version upgrades

Activity (1)#

GET/v1/users/me/activityGet activity log

Activity Feed (2)#

GET/v1/collaboration/activitiesList activities
GET/v1/collaboration/activities/{activityId}Get activity details

Admin Announcements (5)#

GET/v1/admin/announcementsList announcements
POST/v1/admin/announcementsCreate announcement
GET/v1/admin/announcements/{announcementId}Get announcement
PATCH/v1/admin/announcements/{announcementId}Update announcement
DELETE/v1/admin/announcements/{announcementId}Delete announcement

Admin Audit (1)#

GET/v1/admin/audit-logsGet audit logs

Admin Cache (3)#

POST/v1/admin/cache/flushFlush entire cache
POST/v1/admin/cache/invalidateInvalidate cache
GET/v1/admin/cache/statsGet cache statistics

Admin Config (3)#

GET/v1/admin/configList system configurations
GET/v1/admin/config/{key}Get configuration
PUT/v1/admin/config/{key}Update configuration

Admin Database (2)#

GET/v1/admin/database/migrationsGet migration status
GET/v1/admin/database/statsGet database statistics

Admin Feature Flags (5)#

GET/v1/admin/feature-flagsList feature flags
POST/v1/admin/feature-flagsCreate feature flag
GET/v1/admin/feature-flags/{flagId}Get feature flag
PATCH/v1/admin/feature-flags/{flagId}Update feature flag
DELETE/v1/admin/feature-flags/{flagId}Delete feature flag

Admin Jobs (7)#

GET/v1/admin/jobsList background jobs
GET/v1/admin/jobs/queues/statsGet queue statistics
POST/v1/admin/jobs/queues/{queueName}/pausePause queue
POST/v1/admin/jobs/queues/{queueName}/resumeResume queue
GET/v1/admin/jobs/{jobId}Get job
POST/v1/admin/jobs/{jobId}/cancelCancel job
POST/v1/admin/jobs/{jobId}/retryRetry failed job

Admin Maintenance (2)#

GET/v1/admin/maintenanceGet maintenance status
PUT/v1/admin/maintenanceUpdate maintenance mode

Admin Moderation (4)#

GET/v1/admin/moderation/logsGet moderation logs
GET/v1/admin/moderation/reportsList content reports
GET/v1/admin/moderation/reports/{reportId}Get content report
POST/v1/admin/moderation/reports/{reportId}/resolveResolve content report

Admin Organizations (3)#

GET/v1/admin/organizationsList organizations
GET/v1/admin/organizations/{orgId}Get organization
PATCH/v1/admin/organizations/{orgId}Update organization

Admin System (2)#

GET/v1/admin/system/metricsGet system metrics
GET/v1/admin/system/statusGet system status

Admin Users (7)#

GET/v1/admin/usersList users
POST/v1/admin/usersCreate user
POST/v1/admin/users/bulkBulk user action
GET/v1/admin/users/{userId}Get user
PATCH/v1/admin/users/{userId}Update user
DELETE/v1/admin/users/{userId}Delete user
POST/v1/admin/users/{userId}/impersonateImpersonate user

Agent Commands (6)#

POST/v1/agents/agents/{agentId}/commandSend command to agent
GET/v1/agents/agents/{agentId}/healthCheck agent health
POST/v1/agents/agents/{agentId}/pausePause an agent
POST/v1/agents/agents/{agentId}/resumeResume a paused agent
POST/v1/agents/agents/{agentId}/startStart an agent
POST/v1/agents/agents/{agentId}/stopStop an agent

Agent Management (5)#

GET/v1/agents/agentsList registered agents
POST/v1/agents/agentsRegister a new agent
GET/v1/agents/agents/{agentId}Get agent details
PATCH/v1/agents/agents/{agentId}Update agent configuration
DELETE/v1/agents/agents/{agentId}Unregister an agent

Agent Messaging (3)#

GET/v1/agents/agents/{agentId}/messagesGet agent messages
POST/v1/agents/agents/{agentId}/messagesSend message to agent
POST/v1/agents/broadcastBroadcast message to agents

Agent Metrics (3)#

GET/v1/agents/agents/{agentId}/metricsGet agent metrics
GET/v1/agents/metricsGet system-wide agent metrics
GET/v1/agents/pools/{poolId}/metricsGet pool metrics

Agent Pools (7)#

GET/v1/agents/poolsList agent pools
POST/v1/agents/poolsCreate an agent pool
GET/v1/agents/pools/{poolId}Get pool details
PATCH/v1/agents/pools/{poolId}Update agent pool
DELETE/v1/agents/pools/{poolId}Delete agent pool
POST/v1/agents/pools/{poolId}/agents/{agentId}Add agent to pool
DELETE/v1/agents/pools/{poolId}/agents/{agentId}Remove agent from pool

Agent Tasks (6)#

GET/v1/agents/tasksList tasks
POST/v1/agents/tasksCreate a task
GET/v1/agents/tasks/{taskId}Get task details
POST/v1/agents/tasks/{taskId}/cancelCancel a task
GET/v1/agents/tasks/{taskId}/resultGet task result
POST/v1/agents/tasks/{taskId}/retryRetry a failed task

Analytics Cohorts (5)#

GET/v1/analytics/cohortsList cohorts
POST/v1/analytics/cohortsCreate cohort
GET/v1/analytics/cohorts/{cohortId}Get cohort
DELETE/v1/analytics/cohorts/{cohortId}Delete cohort
POST/v1/analytics/cohorts/{cohortId}/analyzeAnalyze cohort

Analytics Dashboards (6)#

GET/v1/analytics/dashboardsList dashboards
POST/v1/analytics/dashboardsCreate dashboard
GET/v1/analytics/dashboards/{dashboardId}Get dashboard
PATCH/v1/analytics/dashboards/{dashboardId}Update dashboard
DELETE/v1/analytics/dashboards/{dashboardId}Delete dashboard
POST/v1/analytics/dashboards/{dashboardId}/duplicateDuplicate dashboard

Analytics Events (3)#

GET/v1/analytics/eventsList events
POST/v1/analytics/eventsTrack an event
POST/v1/analytics/events/batchTrack multiple events

Analytics Export (4)#

GET/v1/analytics/exportList export jobs
POST/v1/analytics/exportCreate export job
GET/v1/analytics/export/{jobId}Get export job
POST/v1/analytics/export/{jobId}/cancelCancel export job

Analytics Funnels (5)#

GET/v1/analytics/funnelsList funnels
POST/v1/analytics/funnelsCreate funnel
GET/v1/analytics/funnels/{funnelId}Get funnel
DELETE/v1/analytics/funnels/{funnelId}Delete funnel
POST/v1/analytics/funnels/{funnelId}/analyzeAnalyze funnel

Analytics Metrics (2)#

GET/v1/analytics/metrics/availableGet available metrics
POST/v1/analytics/metrics/queryQuery metrics

Analytics Realtime (1)#

GET/v1/analytics/realtimeGet realtime metrics

Analytics Reports (5)#

GET/v1/analytics/reportsList reports
POST/v1/analytics/reportsCreate report
GET/v1/analytics/reports/{reportId}Get report
DELETE/v1/analytics/reports/{reportId}Delete report
POST/v1/analytics/reports/{reportId}/generateGenerate report

Analytics Scheduled Reports (5)#

GET/v1/analytics/reports/scheduledList scheduled reports
POST/v1/analytics/reports/scheduledSchedule a report
GET/v1/analytics/reports/scheduled/{scheduleId}Get scheduled report
PATCH/v1/analytics/reports/scheduled/{scheduleId}Update scheduled report
DELETE/v1/analytics/reports/scheduled/{scheduleId}Delete scheduled report

Asset Folders (6)#

GET/v1/projects/{projectId}/assets/foldersList folders
POST/v1/projects/{projectId}/assets/foldersCreate folder
GET/v1/projects/{projectId}/assets/folders/{id}Get folder details
PATCH/v1/projects/{projectId}/assets/folders/{id}Update folder
DELETE/v1/projects/{projectId}/assets/folders/{id}Delete folder
POST/v1/projects/{projectId}/assets/folders/{id}/moveMove folder

Asset Versions (4)#

GET/v1/projects/{projectId}/assets/{id}/versionsList asset versions
POST/v1/projects/{projectId}/assets/{id}/versionsUpload new version
GET/v1/projects/{projectId}/assets/{id}/versions/{version}Get version details
POST/v1/projects/{projectId}/assets/{id}/versions/{version}/restoreRestore version

Assets (12)#

GET/v1/projects/{projectId}/assetsList project assets
POST/v1/projects/{projectId}/assetsCreate asset and get upload URL
POST/v1/projects/{projectId}/assets/bulkBulk asset operation
GET/v1/projects/{projectId}/assets/searchSearch assets
GET/v1/projects/{projectId}/assets/{id}Get asset details
PATCH/v1/projects/{projectId}/assets/{id}Update asset metadata
DELETE/v1/projects/{projectId}/assets/{id}Delete asset
POST/v1/projects/{projectId}/assets/{id}/completeMark upload as complete
GET/v1/projects/{projectId}/assets/{id}/downloadGet download URL
POST/v1/projects/{projectId}/assets/{id}/lockLock asset for editing
POST/v1/projects/{projectId}/assets/{id}/moveMove asset
POST/v1/projects/{projectId}/assets/{id}/unlockUnlock asset

Audit Logs (2)#

GET/v1/organizations/{id}/audit-logsList audit logs
GET/v1/organizations/{id}/audit-logs/exportExport audit logs

Authentication (14)#

POST/v1/auth/email/resendResend verification email
POST/v1/auth/email/verifyVerify email address
POST/v1/auth/loginLogin with email and password
POST/v1/auth/logoutLogout current session
GET/v1/auth/oauth/{provider}Initiate OAuth login
GET/v1/auth/oauth/{provider}/callbackOAuth callback
POST/v1/auth/oauth/{provider}/callbackOAuth callback (form POST)
POST/v1/auth/password/resetRequest password reset
POST/v1/auth/password/reset/confirmConfirm password reset
POST/v1/auth/password/reset/verifyVerify password reset token
POST/v1/auth/password/strengthCheck password strength
POST/v1/auth/refreshRefresh access token
POST/v1/auth/registerRegister a new user
GET/v1/auth/username/checkCheck username availability

Budget Categories (3)#

POST/v1/budgets/{budgetId}/categoriesCreate category
PATCH/v1/budgets/{budgetId}/categories/{categoryId}Update category
DELETE/v1/budgets/{budgetId}/categories/{categoryId}Delete category

Budget Line Items (31)#

GET/v1/budgets/{budgetId}/categories/{categoryId}/itemsList line items
POST/v1/budgets/{budgetId}/categories/{categoryId}/itemsCreate line item
PATCH/v1/budgets/{budgetId}/categories/{categoryId}/items/{itemId}Update line item
DELETE/v1/budgets/{budgetId}/categories/{categoryId}/items/{itemId}Delete line item
POST/v1/budgets/{budgetId}/categories/{categoryId}/line-itemsCreate line item
POST/v1/budgets/{budgetId}/categories/{categoryId}/line-items/bulkBulk create line items
POST/v1/budgets/{budgetId}/categories/{categoryId}/line-items/importImport line items
GET/v1/budgets/{budgetId}/categories/{categoryId}/summaryGet category summary
GET/v1/budgets/{budgetId}/line-itemsList line items
PATCH/v1/budgets/{budgetId}/line-items/bulkBulk update line items
DELETE/v1/budgets/{budgetId}/line-items/bulkBulk delete line items
POST/v1/budgets/{budgetId}/line-items/bulk/statusBulk status change
POST/v1/budgets/{budgetId}/line-items/copyCopy line items
POST/v1/budgets/{budgetId}/line-items/exportExport line items
POST/v1/budgets/{budgetId}/line-items/reorderReorder line items
GET/v1/budgets/{budgetId}/line-items/reportGet line items report
GET/v1/budgets/{budgetId}/line-items/{itemId}Get line item
PATCH/v1/budgets/{budgetId}/line-items/{itemId}Update line item
DELETE/v1/budgets/{budgetId}/line-items/{itemId}Delete line item
POST/v1/budgets/{budgetId}/line-items/{itemId}/actualsRecord actual expense
POST/v1/budgets/{budgetId}/line-items/{itemId}/commitmentsRecord commitment
POST/v1/budgets/{budgetId}/line-items/{itemId}/convert-commitmentConvert commitment to actual
GET/v1/budgets/{budgetId}/line-items/{itemId}/eacCalculate EAC
GET/v1/budgets/{budgetId}/line-items/{itemId}/forecastsGet forecasts
POST/v1/budgets/{budgetId}/line-items/{itemId}/forecastsCreate forecast
GET/v1/budgets/{budgetId}/line-items/{itemId}/historyGet history
POST/v1/budgets/{budgetId}/line-items/{itemId}/restoreRestore deleted item
GET/v1/budgets/{budgetId}/line-items/{itemId}/varianceGet variance summary
POST/v1/budgets/{budgetId}/line-items/{itemId}/variance/notesAdd variance note
GET/v1/budgets/{budgetId}/line-items/{itemId}/versions/{version}Get version
GET/v1/budgets/{budgetId}/variance-reportGet variance report

Budget Templates (13)#

GET/v1/budget-templatesList budget templates
POST/v1/budget-templatesCreate budget template
POST/v1/budget-templates/importImport budget template
GET/v1/budget-templates/statsGet template statistics
GET/v1/budget-templates/suggestionsGet template suggestions
GET/v1/budget-templates/{templateId}Get budget template
PATCH/v1/budget-templates/{templateId}Update budget template
DELETE/v1/budget-templates/{templateId}Delete budget template
GET/v1/budget-templates/{templateId}/allocationsGet template categories with allocations
POST/v1/budget-templates/{templateId}/applyApply template to budget
POST/v1/budget-templates/{templateId}/cloneClone budget template
GET/v1/budget-templates/{templateId}/exportExport budget template
POST/v1/budget-templates/{templateId}/rateRate budget template

Budgets (6)#

GET/v1/budgetsList budgets
POST/v1/budgetsCreate budget
GET/v1/budgets/{budgetId}Get budget
PATCH/v1/budgets/{budgetId}Update budget
DELETE/v1/budgets/{budgetId}Delete budget
GET/v1/budgets/{budgetId}/reportGet budget report

Calendar (5)#

GET/v1/schedules/calendarList calendar events
POST/v1/schedules/calendarCreate calendar event
GET/v1/schedules/calendar/{eventId}Get calendar event
PATCH/v1/schedules/calendar/{eventId}Update calendar event
DELETE/v1/schedules/calendar/{eventId}Delete calendar event

Call Sheet Distribution (2)#

POST/v1/call-sheets/{callSheetId}/sendSend call sheet
GET/v1/call-sheets/{callSheetId}/send-historyGet send history

Call Sheet Entries (5)#

GET/v1/call-sheets/{callSheetId}/entriesList crew entries
POST/v1/call-sheets/{callSheetId}/entriesAdd crew entry
PATCH/v1/call-sheets/{callSheetId}/entries/bulkBulk update entries
PATCH/v1/call-sheets/{callSheetId}/entries/{entryId}Update crew entry
DELETE/v1/call-sheets/{callSheetId}/entries/{entryId}Remove crew entry

Call Sheet Export (2)#

GET/v1/call-sheets/{callSheetId}/exportExport to JSON
GET/v1/call-sheets/{callSheetId}/pdfExport to PDF

Call Sheet Statistics (1)#

GET/v1/call-sheets/stats/{scheduleId}Get call sheet statistics

Call Sheets (8)#

GET/v1/call-sheetsList call sheets
POST/v1/call-sheetsGenerate call sheet
GET/v1/call-sheets/{callSheetId}Get call sheet
PATCH/v1/call-sheets/{callSheetId}Update call sheet
DELETE/v1/call-sheets/{callSheetId}Delete call sheet
GET/v1/call-sheets/{callSheetId}/fullGet call sheet with entries
POST/v1/call-sheets/{callSheetId}/publishPublish call sheet
POST/v1/call-sheets/{callSheetId}/reviseRevise call sheet

Capabilities - Bellona (5)#

GET/v1/capabilities/bellona/{path}Proxy GET to Bellona (Engine) API
POST/v1/capabilities/bellona/{path}Proxy POST to Bellona (Engine) API
PUT/v1/capabilities/bellona/{path}Proxy PUT to Bellona (Engine) API
PATCH/v1/capabilities/bellona/{path}Proxy PATCH to Bellona (Engine) API
DELETE/v1/capabilities/bellona/{path}Proxy DELETE to Bellona (Engine) API

Capabilities - Hathor (5)#

GET/v1/capabilities/hathor/{path}Proxy GET to Hathor (Worldbuilding) API
POST/v1/capabilities/hathor/{path}Proxy POST to Hathor (Worldbuilding) API
PUT/v1/capabilities/hathor/{path}Proxy PUT to Hathor (Worldbuilding) API
PATCH/v1/capabilities/hathor/{path}Proxy PATCH to Hathor (Worldbuilding) API
DELETE/v1/capabilities/hathor/{path}Proxy DELETE to Hathor (Worldbuilding) API

Capabilities - Health (5)#

GET/v1/capabilities/circuitsGet circuit breaker stats for all capability domains
POST/v1/capabilities/circuits/{domain}/resetReset a capability domain circuit breaker
GET/v1/capabilities/healthHealth check all capability domains
GET/v1/capabilities/health/{domain}Health check a specific capability domain
GET/v1/capabilities/logsGet recent proxy request logs

Capabilities - Isis (5)#

GET/v1/capabilities/isis/{path}Proxy GET to Isis (Generation) API
POST/v1/capabilities/isis/{path}Proxy POST to Isis (Generation) API
PUT/v1/capabilities/isis/{path}Proxy PUT to Isis (Generation) API
PATCH/v1/capabilities/isis/{path}Proxy PATCH to Isis (Generation) API
DELETE/v1/capabilities/isis/{path}Proxy DELETE to Isis (Generation) API

Capabilities - Sophia (5)#

GET/v1/capabilities/sophia/{path}Proxy GET to Sophia (Research) API
POST/v1/capabilities/sophia/{path}Proxy POST to Sophia (Research) API
PUT/v1/capabilities/sophia/{path}Proxy PUT to Sophia (Research) API
PATCH/v1/capabilities/sophia/{path}Proxy PATCH to Sophia (Research) API
DELETE/v1/capabilities/sophia/{path}Proxy DELETE to Sophia (Research) API

Collaboration Sessions (4)#

POST/v1/collaboration/sessions/joinJoin a collaboration session
GET/v1/collaboration/sessions/{sessionId}Get session details
POST/v1/collaboration/sessions/{sessionId}/leaveLeave a collaboration session
PATCH/v1/collaboration/sessions/{sessionId}/presenceUpdate presence in session

Comment Threads (6)#

GET/v1/collaboration/threadsList comment threads
POST/v1/collaboration/threadsCreate a comment thread
GET/v1/collaboration/threads/{threadId}Get thread details
DELETE/v1/collaboration/threads/{threadId}Delete a thread
POST/v1/collaboration/threads/{threadId}/resolveResolve a thread
POST/v1/collaboration/threads/{threadId}/unresolveUnresolve a thread

Comments (9)#

GET/v1/collaboration/threads/{threadId}/commentsList comments in a thread
POST/v1/collaboration/threads/{threadId}/commentsAdd a comment to a thread
PATCH/v1/collaboration/threads/{threadId}/comments/{commentId}Update a comment
DELETE/v1/collaboration/threads/{threadId}/comments/{commentId}Delete a comment
GET/v1/projects/{id}/commentsList project comments
POST/v1/projects/{id}/commentsCreate comment
PATCH/v1/projects/{id}/comments/{commentId}Update comment
DELETE/v1/projects/{id}/comments/{commentId}Delete comment
POST/v1/projects/{id}/comments/{commentId}/resolveResolve comment

Cost Predictions (12)#

GET/v1/budgets/:budgetId/benchmarksGet benchmark comparison
POST/v1/budgets/:budgetId/benchmarks/generateGenerate benchmark report
GET/v1/budgets/:budgetId/predictionsGet budget predictions
GET/v1/budgets/:budgetId/predictions/categories/:categoryIdGet category prediction
POST/v1/budgets/:budgetId/predictions/generateGenerate predictions
GET/v1/budgets/:budgetId/predictions/line-itemsGet line item predictions
GET/v1/budgets/:budgetId/predictions/line-items/:lineItemIdGet line item prediction
GET/v1/budgets/:budgetId/predictions/risksGet risk analysis
GET/v1/budgets/:budgetId/predictions/summaryGet prediction summary
GET/v1/budgets/:budgetId/predictions/timelineGet timeline forecast
POST/v1/budgets/:budgetId/scenariosRun scenario analysis
POST/v1/budgets/:budgetId/scenarios/compareCompare scenarios

Crew (5)#

GET/v1/crewList crew members
POST/v1/crewCreate crew member
GET/v1/crew/{crewMemberId}Get crew member
PATCH/v1/crew/{crewMemberId}Update crew member
DELETE/v1/crew/{crewMemberId}Delete crew member

Crew Assignments (4)#

GET/v1/crew/assignmentsList assignments
POST/v1/crew/assignmentsCreate assignment
PATCH/v1/crew/assignments/{assignmentId}Update assignment
DELETE/v1/crew/assignments/{assignmentId}Delete assignment

Crew Availability (5)#

POST/v1/crew/check-availabilityCheck availability
GET/v1/crew/{crewMemberId}/availabilityList availability
POST/v1/crew/{crewMemberId}/availabilityAdd availability
PATCH/v1/crew/{crewMemberId}/availability/{availabilityId}Update availability
DELETE/v1/crew/{crewMemberId}/availability/{availabilityId}Delete availability

Crew Bulk Operations (2)#

POST/v1/crew/assignments/bulkBulk assign crew
POST/v1/crew/bulkBulk create crew members

Crew Matching (1)#

POST/v1/crew/find-by-skillsFind crew by skills

Crew Skills (4)#

GET/v1/crew/{crewMemberId}/skillsList crew member skills
POST/v1/crew/{crewMemberId}/skillsAdd skill
PATCH/v1/crew/{crewMemberId}/skills/{skillId}Update skill
DELETE/v1/crew/{crewMemberId}/skills/{skillId}Delete skill

Crew Statistics (1)#

GET/v1/crew/stats/{projectId}Get crew statistics

Expenses (6)#

GET/v1/budgets/{budgetId}/expensesList expenses
POST/v1/budgets/{budgetId}/expensesCreate expense
GET/v1/budgets/{budgetId}/expenses/{expenseId}Get expense
PATCH/v1/budgets/{budgetId}/expenses/{expenseId}Update expense
DELETE/v1/budgets/{budgetId}/expenses/{expenseId}Delete expense
POST/v1/budgets/{budgetId}/expenses/{expenseId}/reviewApprove/reject expense

Invitations (6)#

POST/v1/organizations/invitations/{token}/acceptAccept invitation
GET/v1/organizations/{id}/invitationsList invitations
POST/v1/organizations/{id}/invitationsInvite member
POST/v1/organizations/{id}/invitations/bulkBulk invite members
DELETE/v1/organizations/{id}/invitations/{inviteId}Cancel invitation
POST/v1/organizations/{id}/invitations/{inviteId}/resendResend invitation

Invoices (7)#

GET/v1/budgets/{budgetId}/invoicesList invoices
POST/v1/budgets/{budgetId}/invoicesCreate invoice
GET/v1/budgets/{budgetId}/invoices/{invoiceId}Get invoice
PATCH/v1/budgets/{budgetId}/invoices/{invoiceId}Update invoice
DELETE/v1/budgets/{budgetId}/invoices/{invoiceId}Delete invoice
POST/v1/budgets/{budgetId}/invoices/{invoiceId}/approveApprove invoice
POST/v1/budgets/{budgetId}/invoices/{invoiceId}/paymentRecord invoice payment

Location Availability (3)#

POST/v1/locations/check-availabilityCheck availability
POST/v1/locations/{locationId}/availabilityAdd availability window
DELETE/v1/locations/{locationId}/availability/{availabilityId}Delete availability window

Location Checklists (8)#

GET/v1/locations/checklists/templatesGet checklist templates
GET/v1/locations/{locationId}/checklistsList checklists
POST/v1/locations/{locationId}/checklistsCreate checklist
GET/v1/locations/{locationId}/checklists/{checklistId}Get checklist
DELETE/v1/locations/{locationId}/checklists/{checklistId}Delete checklist
POST/v1/locations/{locationId}/checklists/{checklistId}/itemsAdd checklist item
PATCH/v1/locations/{locationId}/checklists/{checklistId}/items/{itemId}Update checklist item
DELETE/v1/locations/{locationId}/checklists/{checklistId}/items/{itemId}Delete checklist item

Location Contacts (3)#

POST/v1/locations/{locationId}/contactsAdd contact
PATCH/v1/locations/{locationId}/contacts/{contactId}Update contact
DELETE/v1/locations/{locationId}/contacts/{contactId}Delete contact

Location Map (3)#

POST/v1/locations/geocodeGeocode address
GET/v1/locations/mapGet map markers
POST/v1/locations/reverse-geocodeReverse geocode

Location Media (5)#

GET/v1/locations/{locationId}/mediaList media
POST/v1/locations/{locationId}/mediaAdd media
PATCH/v1/locations/{locationId}/media/{mediaId}Update media
DELETE/v1/locations/{locationId}/media/{mediaId}Delete media
POST/v1/locations/{locationId}/media/{mediaId}/set-primarySet primary photo

Location Permits (5)#

GET/v1/locations/permits/expiringGet expiring permits
GET/v1/locations/{locationId}/permitsList permits
POST/v1/locations/{locationId}/permitsCreate permit
PATCH/v1/locations/{locationId}/permits/{permitId}Update permit
DELETE/v1/locations/{locationId}/permits/{permitId}Delete permit

Location Statistics (1)#

GET/v1/locations/stats/{projectId}Get location statistics

Location Weather (2)#

GET/v1/locations/{locationId}/sun-positionGet sun position
GET/v1/locations/{locationId}/weatherGet weather forecast

Locations (7)#

GET/v1/locationsList locations
POST/v1/locationsCreate location
GET/v1/locations/nearbyFind nearby locations
GET/v1/locations/{locationId}Get location
PATCH/v1/locations/{locationId}Update location
DELETE/v1/locations/{locationId}Delete location
POST/v1/locations/{locationId}/restoreRestore location

Milestones (5)#

GET/v1/schedules/{scheduleId}/milestonesList milestones
POST/v1/schedules/{scheduleId}/milestonesCreate milestone
GET/v1/schedules/{scheduleId}/milestones/{milestoneId}Get milestone
PATCH/v1/schedules/{scheduleId}/milestones/{milestoneId}Update milestone
DELETE/v1/schedules/{scheduleId}/milestones/{milestoneId}Delete milestone

Multi-Currency (18)#

GET/v1/currency/config/{entityType}/{entityId}Get currency configuration
PUT/v1/currency/config/{entityType}/{entityId}Upsert currency configuration
POST/v1/currency/convertConvert currency
POST/v1/currency/convert/bulkBulk convert currencies
GET/v1/currency/currenciesGet supported currencies
GET/v1/currency/currencies/{code}Get currency metadata
POST/v1/currency/formatFormat amount for display
GET/v1/currency/ratesGet current exchange rates
POST/v1/currency/ratesCreate custom exchange rate
POST/v1/currency/rates/bulkImport bulk exchange rates
GET/v1/currency/rates/historyGet exchange rate history
GET/v1/currency/rates/pairGet exchange rate for a currency pair
POST/v1/currency/{budgetId}/fx-impactAnalyze FX impact
GET/v1/currency/{budgetId}/hedgesList currency hedges
POST/v1/currency/{budgetId}/hedgesCreate currency hedge
DELETE/v1/currency/{budgetId}/hedges/{hedgeId}Cancel currency hedge
POST/v1/currency/{budgetId}/hedges/{hedgeId}/utilizeUtilize hedge amount
GET/v1/currency/{budgetId}/summaryGet multi-currency budget summary

Notifications (8)#

GET/v1/collaboration/notificationsList my notifications
POST/v1/collaboration/notifications/read-allMark all notifications as read
GET/v1/collaboration/notifications/{notificationId}Get notification details
DELETE/v1/collaboration/notifications/{notificationId}Delete a notification
POST/v1/collaboration/notifications/{notificationId}/readMark notification as read
GET/v1/users/me/notificationsGet notifications
POST/v1/users/me/notifications/read-allMark all notifications as read
PATCH/v1/users/me/notifications/{id}/readMark notification as read

Organization Members (6)#

POST/v1/organizations/{id}/leaveLeave organization
GET/v1/organizations/{id}/membersList organization members
GET/v1/organizations/{id}/members/{memberId}Get member details
PATCH/v1/organizations/{id}/members/{memberId}Update member role
DELETE/v1/organizations/{id}/members/{memberId}Remove member
POST/v1/organizations/{id}/transfer-ownershipTransfer ownership

Organizations (8)#

GET/v1/organizationsList organizations
POST/v1/organizationsCreate organization
GET/v1/organizations/slug/{slug}Get organization by slug
GET/v1/organizations/{id}Get organization
PATCH/v1/organizations/{id}Update organization
DELETE/v1/organizations/{id}Delete organization
POST/v1/organizations/{id}/logoUpload organization logo
GET/v1/organizations/{id}/usageGet usage statistics

Panels (8)#

GET/v1/storyboards/{storyboardId}/panelsList panels
POST/v1/storyboards/{storyboardId}/panelsCreate panel
POST/v1/storyboards/{storyboardId}/panels/reorderReorder panels
GET/v1/storyboards/{storyboardId}/panels/{panelId}Get panel
PATCH/v1/storyboards/{storyboardId}/panels/{panelId}Update panel
DELETE/v1/storyboards/{storyboardId}/panels/{panelId}Delete panel
POST/v1/storyboards/{storyboardId}/panels/{panelId}/duplicateDuplicate panel
POST/v1/storyboards/{storyboardId}/panels/{panelId}/generate-imageGenerate panel image

Plugin Hooks (4)#

GET/v1/plugins/hooksList registered hooks
GET/v1/plugins/hooks/executionsList recent hook executions
PATCH/v1/plugins/hooks/{hookId}Enable/disable a hook
GET/v1/plugins/{pluginId}/hooksGet hooks for a plugin

Plugin Marketplace (6)#

GET/v1/plugins/marketplaceBrowse plugin marketplace
GET/v1/plugins/marketplace/categoriesList plugin categories
POST/v1/plugins/marketplace/reviews/{reviewId}/helpfulMark review as helpful
GET/v1/plugins/marketplace/{manifestId}Get marketplace plugin details
GET/v1/plugins/marketplace/{manifestId}/reviewsGet plugin reviews
POST/v1/plugins/marketplace/{manifestId}/reviewsSubmit a plugin review

Plugins (10)#

GET/v1/pluginsList installed plugins
POST/v1/pluginsInstall a plugin
GET/v1/plugins/updatesCheck for plugin updates
POST/v1/plugins/updates/applyApply all available updates
GET/v1/plugins/{pluginId}Get installed plugin details
DELETE/v1/plugins/{pluginId}Uninstall a plugin
POST/v1/plugins/{pluginId}/disableDisable a plugin
POST/v1/plugins/{pluginId}/enableEnable a plugin
PATCH/v1/plugins/{pluginId}/settingsUpdate plugin settings
POST/v1/plugins/{pluginId}/updateUpdate plugin to new version

Portfolio (8)#

GET/v1/users/me/portfolioGet portfolio items
POST/v1/users/me/portfolioAdd portfolio item
GET/v1/users/me/portfolio/featuredGet featured portfolio items
POST/v1/users/me/portfolio/reorderReorder portfolio items
GET/v1/users/me/portfolio/typesGet portfolio item types
GET/v1/users/me/portfolio/{id}Get portfolio item
PUT/v1/users/me/portfolio/{id}Update portfolio item
DELETE/v1/users/me/portfolio/{id}Remove portfolio item

Preferences (2)#

GET/v1/users/me/preferencesGet user preferences
PATCH/v1/users/me/preferencesUpdate user preferences

Profile (11)#

GET/v1/users/meGet current user
PATCH/v1/users/meUpdate current user
DELETE/v1/users/meRequest account deletion (GDPR)
POST/v1/users/me/avatarUpload avatar
DELETE/v1/users/me/avatarRemove avatar
POST/v1/users/me/cancel-deletionCancel pending account deletion
GET/v1/users/me/deletion-statusGet account deletion status
POST/v1/users/me/passwordChange password
POST/v1/users/me/request-deletionRequest account deletion
GET/v1/users/me/statsGet user statistics
GET/v1/users/me/verification-statusGet email verification status

Profile Completion (1)#

GET/v1/users/me/profile-completionGet profile completion status

Profile Export (2)#

GET/v1/users/me/exportExport user data (GDPR)
POST/v1/users/me/exportRequest async user data export

Project Members (5)#

POST/v1/projects/{id}/leaveLeave project
GET/v1/projects/{id}/membersList project members
POST/v1/projects/{id}/membersAdd project member
PATCH/v1/projects/{id}/members/{userId}Update member role
DELETE/v1/projects/{id}/members/{userId}Remove member

Projects (10)#

GET/v1/projectsList projects
POST/v1/projectsCreate project
GET/v1/projects/{id}Get project
PATCH/v1/projects/{id}Update project
DELETE/v1/projects/{id}Delete project
GET/v1/projects/{id}/activityGet project activity
POST/v1/projects/{id}/archiveArchive project
POST/v1/projects/{id}/duplicateDuplicate project
POST/v1/projects/{id}/restoreRestore project
POST/v1/projects/{id}/thumbnailUpload project thumbnail

Purchase Orders (6)#

GET/v1/budgets/{budgetId}/purchase-ordersList purchase orders
POST/v1/budgets/{budgetId}/purchase-ordersCreate purchase order
GET/v1/budgets/{budgetId}/purchase-orders/{poId}Get purchase order
PATCH/v1/budgets/{budgetId}/purchase-orders/{poId}Update purchase order
DELETE/v1/budgets/{budgetId}/purchase-orders/{poId}Delete purchase order
POST/v1/budgets/{budgetId}/purchase-orders/{poId}/approveApprove purchase order

Resource Locks (5)#

GET/v1/collaboration/locksList active locks
POST/v1/collaboration/locksAcquire a lock
GET/v1/collaboration/locks/{lockId}Get lock details
DELETE/v1/collaboration/locks/{lockId}Release a lock
POST/v1/collaboration/locks/{lockId}/refreshRefresh lock expiration

Resources (6)#

GET/v1/schedules/resourcesList resources
POST/v1/schedules/resourcesCreate resource
POST/v1/schedules/resources/check-availabilityCheck resource availability
GET/v1/schedules/resources/{resourceId}Get resource
PATCH/v1/schedules/resources/{resourceId}Update resource
DELETE/v1/schedules/resources/{resourceId}Delete resource

Reviews (5)#

GET/v1/collaboration/reviewsList reviews
POST/v1/collaboration/reviewsRequest a review
GET/v1/collaboration/reviews/{reviewId}Get review details
POST/v1/collaboration/reviews/{reviewId}/cancelCancel a review request
POST/v1/collaboration/reviews/{reviewId}/decisionSubmit review decision

Role Definitions (4)#

GET/v1/crew/rolesList role definitions
POST/v1/crew/rolesCreate role definition
PATCH/v1/crew/roles/{roleId}Update role definition
DELETE/v1/crew/roles/{roleId}Delete role definition

Saved Searches (6)#

GET/v1/search/savedList saved searches
POST/v1/search/savedSave a search
GET/v1/search/saved/{searchId}Get saved search
PATCH/v1/search/saved/{searchId}Update saved search
DELETE/v1/search/saved/{searchId}Delete saved search
GET/v1/search/saved/{searchId}/executeExecute a saved search

Scenes (6)#

GET/v1/scripts/{id}/scenesList scenes
POST/v1/scripts/{id}/scenesCreate scene
POST/v1/scripts/{id}/scenes/reorderReorder scenes
GET/v1/scripts/{id}/scenes/{sceneId}Get scene
PATCH/v1/scripts/{id}/scenes/{sceneId}Update scene
DELETE/v1/scripts/{id}/scenes/{sceneId}Delete scene

Schedule Conflicts (3)#

GET/v1/schedules/{scheduleId}/conflictsList conflicts
POST/v1/schedules/{scheduleId}/conflicts/detectDetect conflicts
POST/v1/schedules/{scheduleId}/conflicts/{conflictId}/resolveResolve conflict

Schedule Items (6)#

GET/v1/schedules/{scheduleId}/itemsList schedule items
POST/v1/schedules/{scheduleId}/itemsCreate schedule item
PATCH/v1/schedules/{scheduleId}/items/bulkBulk update items
GET/v1/schedules/{scheduleId}/items/{itemId}Get schedule item
PATCH/v1/schedules/{scheduleId}/items/{itemId}Update schedule item
DELETE/v1/schedules/{scheduleId}/items/{itemId}Delete schedule item

Schedule Optimization (9)#

GET/v1/schedules/{scheduleId}/critical-pathGet critical path analysis
POST/v1/schedules/{scheduleId}/optimizeRun schedule optimization
POST/v1/schedules/{scheduleId}/optimize/applyApply optimization results
GET/v1/schedules/{scheduleId}/optimize/historyGet optimization history
GET/v1/schedules/{scheduleId}/optimize/{optimizationId}Get optimization result
POST/v1/schedules/{scheduleId}/resources/suggest-reassignmentsSuggest resource reassignments
GET/v1/schedules/{scheduleId}/resources/utilizationGet resource utilization analysis
POST/v1/schedules/{scheduleId}/suggestGet quick AI suggestions
POST/v1/schedules/{scheduleId}/what-ifRun what-if analysis

Schedule Sharing (18)#

GET/v1/schedules/public/{token}Access shared schedule
POST/v1/schedules/{scheduleId}/exportExport schedule
GET/v1/schedules/{scheduleId}/export/jobsList export jobs
GET/v1/schedules/{scheduleId}/export/jobs/{jobId}Get export job
GET/v1/schedules/{scheduleId}/export/{format}Quick export
GET/v1/schedules/{scheduleId}/share/linksList share links
POST/v1/schedules/{scheduleId}/share/linksCreate share link
GET/v1/schedules/{scheduleId}/share/links/{linkId}Get share link
DELETE/v1/schedules/{scheduleId}/share/links/{linkId}Delete share link
POST/v1/schedules/{scheduleId}/share/links/{linkId}/deactivateDeactivate share link
GET/v1/schedules/{scheduleId}/share/logsGet access logs
GET/v1/schedules/{scheduleId}/share/recipientsList recipients
POST/v1/schedules/{scheduleId}/share/recipientsInvite recipient
PATCH/v1/schedules/{scheduleId}/share/recipients/{recipientId}Update recipient
DELETE/v1/schedules/{scheduleId}/share/recipients/{recipientId}Remove recipient
GET/v1/schedules/{scheduleId}/share/settingsGet share settings
PATCH/v1/schedules/{scheduleId}/share/settingsUpdate share settings
GET/v1/schedules/{scheduleId}/share/statsGet share statistics

Schedules (7)#

GET/v1/schedulesList schedules
POST/v1/schedulesCreate schedule
GET/v1/schedules/{scheduleId}Get schedule
PATCH/v1/schedules/{scheduleId}Update schedule
DELETE/v1/schedules/{scheduleId}Delete schedule
POST/v1/schedules/{scheduleId}/duplicateDuplicate schedule
GET/v1/schedules/{scheduleId}/statsGet schedule statistics

Script Characters (6)#

GET/v1/scripts/{id}/charactersList script characters
POST/v1/scripts/{id}/charactersCreate script character
POST/v1/scripts/{id}/characters/analyzeAnalyze characters
GET/v1/scripts/{id}/characters/{characterId}Get script character
PATCH/v1/scripts/{id}/characters/{characterId}Update script character
DELETE/v1/scripts/{id}/characters/{characterId}Delete script character

Script Comments (7)#

GET/v1/scripts/{id}/commentsList script comments
POST/v1/scripts/{id}/commentsCreate script comment
GET/v1/scripts/{id}/comments/{commentId}Get script comment
PATCH/v1/scripts/{id}/comments/{commentId}Update script comment
DELETE/v1/scripts/{id}/comments/{commentId}Delete script comment
POST/v1/scripts/{id}/comments/{commentId}/resolveResolve script comment
POST/v1/scripts/{id}/comments/{commentId}/unresolveUnresolve script comment

Script Elements (6)#

GET/v1/scripts/{id}/scenes/{sceneId}/elementsList elements
POST/v1/scripts/{id}/scenes/{sceneId}/elementsCreate element
POST/v1/scripts/{id}/scenes/{sceneId}/elements/reorderReorder elements
GET/v1/scripts/{id}/scenes/{sceneId}/elements/{elementId}Get element
PATCH/v1/scripts/{id}/scenes/{sceneId}/elements/{elementId}Update element
DELETE/v1/scripts/{id}/scenes/{sceneId}/elements/{elementId}Delete element

Script Versions (5)#

GET/v1/scripts/{id}/versionsList script versions
POST/v1/scripts/{id}/versionsCreate script version
GET/v1/scripts/{id}/versions/{versionId}Get script version
DELETE/v1/scripts/{id}/versions/{versionId}Delete script version
POST/v1/scripts/{id}/versions/{versionId}/restoreRestore script version

Scripts (10)#

GET/v1/scriptsList scripts
POST/v1/scriptsCreate script
GET/v1/scripts/{id}Get script
PATCH/v1/scripts/{id}Update script
DELETE/v1/scripts/{id}Delete script
POST/v1/scripts/{id}/duplicateDuplicate script
POST/v1/scripts/{id}/exportExport script
POST/v1/scripts/{id}/lockLock script
GET/v1/scripts/{id}/statsGet script statistics
POST/v1/scripts/{id}/unlockUnlock script
GET/v1/searchSearch across all entities
POST/v1/searchSearch with complex filters
GET/v1/search/assetsSearch assets
GET/v1/search/autocompleteGet search suggestions
GET/v1/search/charactersSearch characters
GET/v1/search/projectsSearch projects
GET/v1/search/scriptsSearch scripts
GET/v1/search/usersSearch users

Search History (2)#

GET/v1/search/historyGet search history
DELETE/v1/search/historyClear search history

Search Index (2)#

POST/v1/search/index/reindexTrigger reindexing
GET/v1/search/index/statusGet search index status

Sessions (3)#

GET/v1/auth/sessionsList active sessions
DELETE/v1/auth/sessionsRevoke all sessions
DELETE/v1/auth/sessions/{id}Revoke a session

Sharing (7)#

GET/v1/collaboration/sharesList shares
POST/v1/collaboration/sharesShare with user
POST/v1/collaboration/shares/linkCreate share link
GET/v1/collaboration/shares/link/{token}Access shared content via link
GET/v1/collaboration/shares/{shareId}Get share details
PATCH/v1/collaboration/shares/{shareId}Update share permissions
DELETE/v1/collaboration/shares/{shareId}Revoke a share

Skills (6)#

GET/v1/users/me/skillsGet skills
POST/v1/users/me/skillsAdd skill
GET/v1/users/me/skills/categoriesGet skill categories
GET/v1/users/me/skills/primaryGet primary skills
PUT/v1/users/me/skills/{id}Update skill
DELETE/v1/users/me/skills/{id}Remove skill
GET/v1/users/me/social-linksGet social links
POST/v1/users/me/social-linksAdd social link
POST/v1/users/me/social-links/reorderReorder social links
PUT/v1/users/me/social-links/{platform}Update social link
DELETE/v1/users/me/social-links/{platform}Remove social link

Story Beats (6)#

GET/v1/scripts/{id}/beatsList story beats
POST/v1/scripts/{id}/beatsCreate story beat
POST/v1/scripts/{id}/beats/generateGenerate story beats
GET/v1/scripts/{id}/beats/{beatId}Get story beat
PATCH/v1/scripts/{id}/beats/{beatId}Update story beat
DELETE/v1/scripts/{id}/beats/{beatId}Delete story beat

Storyboard Annotations (6)#

GET/v1/storyboards/{storyboardId}/panels/{panelId}/annotationsList annotations
POST/v1/storyboards/{storyboardId}/panels/{panelId}/annotationsCreate annotation
PATCH/v1/storyboards/{storyboardId}/panels/{panelId}/annotations/{annotationId}Update annotation
DELETE/v1/storyboards/{storyboardId}/panels/{panelId}/annotations/{annotationId}Delete annotation
POST/v1/storyboards/{storyboardId}/panels/{panelId}/annotations/{annotationId}/resolveResolve annotation
POST/v1/storyboards/{storyboardId}/panels/{panelId}/annotations/{annotationId}/unresolveUnresolve annotation

Storyboard Layers (2)#

POST/v1/storyboards/{storyboardId}/panels/{panelId}/layersAdd layer
DELETE/v1/storyboards/{storyboardId}/panels/{panelId}/layers/{layerId}Delete layer

Storyboard Versions (4)#

GET/v1/storyboards/{storyboardId}/versionsList versions
POST/v1/storyboards/{storyboardId}/versionsCreate version
GET/v1/storyboards/{storyboardId}/versions/{versionId}Get version
POST/v1/storyboards/{storyboardId}/versions/{versionId}/restoreRestore version

Storyboards (9)#

GET/v1/storyboardsList storyboards
POST/v1/storyboardsCreate storyboard
POST/v1/storyboards/generate-from-sceneGenerate storyboard from scene
GET/v1/storyboards/{storyboardId}Get storyboard
PATCH/v1/storyboards/{storyboardId}Update storyboard
DELETE/v1/storyboards/{storyboardId}Delete storyboard
POST/v1/storyboards/{storyboardId}/duplicateDuplicate storyboard
POST/v1/storyboards/{storyboardId}/exportExport storyboard
GET/v1/storyboards/{storyboardId}/statsGet storyboard statistics

Tags (4)#

GET/v1/users/me/tagsGet tags
POST/v1/users/me/tagsAdd tags
GET/v1/users/me/tags/suggestionsGet suggested tags
DELETE/v1/users/me/tags/{name}Remove tag

Teams (9)#

GET/v1/organizations/{id}/teamsList teams
POST/v1/organizations/{id}/teamsCreate team
GET/v1/organizations/{id}/teams/{teamId}Get team details
PATCH/v1/organizations/{id}/teams/{teamId}Update team
DELETE/v1/organizations/{id}/teams/{teamId}Delete team
GET/v1/organizations/{id}/teams/{teamId}/membersList team members
POST/v1/organizations/{id}/teams/{teamId}/membersAdd team member
PATCH/v1/organizations/{id}/teams/{teamId}/members/{memberId}Update team member role
DELETE/v1/organizations/{id}/teams/{teamId}/members/{memberId}Remove team member

User Presence (3)#

GET/v1/collaboration/presenceList online users
GET/v1/collaboration/presence/meGet my presence status
PATCH/v1/collaboration/presence/meUpdate my presence status

Users (1)#

GET/v1/users/{id}Get user profile

Variance Tracking (19)#

GET/v1/budgets/{budgetId}/alertsList variance alerts
POST/v1/budgets/{budgetId}/alerts/{alertId}/acknowledgeAcknowledge variance alert
POST/v1/budgets/{budgetId}/alerts/{alertId}/resolveResolve variance alert
GET/v1/budgets/{budgetId}/approvalsList approval requests
POST/v1/budgets/{budgetId}/approvalsCreate approval request
POST/v1/budgets/{budgetId}/approvals/{requestId}/reviewReview approval request
GET/v1/budgets/{budgetId}/categoriesGet category variance breakdown
POST/v1/budgets/{budgetId}/compareCompare variance between periods
GET/v1/budgets/{budgetId}/dashboardGet variance dashboard summary
GET/v1/budgets/{budgetId}/evmCalculate EVM metrics
GET/v1/budgets/{budgetId}/kpisGet variance KPIs
POST/v1/budgets/{budgetId}/reportsGenerate variance report
GET/v1/budgets/{budgetId}/root-cause/{entityId}Get root cause analysis
GET/v1/budgets/{budgetId}/thresholdsList variance thresholds
POST/v1/budgets/{budgetId}/thresholdsCreate variance threshold
POST/v1/budgets/{budgetId}/thresholds/checkCheck variance thresholds
PUT/v1/budgets/{budgetId}/thresholds/{thresholdId}Update variance threshold
DELETE/v1/budgets/{budgetId}/thresholds/{thresholdId}Delete variance threshold
GET/v1/budgets/{budgetId}/trendsGet variance trend analysis

WebSocket (3)#

GET/ws/infoGet WebSocket connection information
GET/ws/presence/{channel}/{resourceId}Get user presence for a resource
GET/ws/statsGet WebSocket server statistics

Webhook Deliveries (4)#

GET/v1/webhooks/deliveriesList webhook deliveries
GET/v1/webhooks/deliveries/{deliveryId}Get delivery details
POST/v1/webhooks/deliveries/{deliveryId}/retryRetry a failed delivery
GET/v1/webhooks/{webhookId}/deliveriesGet deliveries for a webhook

Webhook Events (2)#

GET/v1/webhooks/eventsList recent events
GET/v1/webhooks/events/typesList available event types

Webhook Statistics (2)#

GET/v1/webhooks/statsGet global webhook statistics
GET/v1/webhooks/{webhookId}/statsGet webhook statistics

Webhooks (9)#

GET/v1/webhooksList webhooks
POST/v1/webhooksCreate a webhook
GET/v1/webhooks/{webhookId}Get webhook details
PATCH/v1/webhooks/{webhookId}Update a webhook
DELETE/v1/webhooks/{webhookId}Delete a webhook
POST/v1/webhooks/{webhookId}/pausePause a webhook
POST/v1/webhooks/{webhookId}/resumeResume a webhook
POST/v1/webhooks/{webhookId}/rotate-secretRotate webhook secret
POST/v1/webhooks/{webhookId}/testTest a webhook

Schemas (720)#

AcceptedInvitationResponseobjectAcknowledgeAlertRequestobjectAcquireLockobjectActivityobjectActivityResponseResponseobjectAddPortfolioItemobjectAddProjectMemberobjectAddSkillobjectAddSocialLinkobjectAddTagsobjectAddTeamMemberobjectAddVarianceNoteobjectAdminCreateUserobjectAdminOrganizationobjectAdminOrganizationResponseResponseobjectAdminUpdateOrganizationobjectAdminUpdateUserobjectAdminUserobjectAdminUserResponseResponseobjectAgentConfigobjectAgentErrorobjectAgentHealthobjectAgentInfoobjectAgentInfoResponseResponseobjectAgentMessageobjectAgentMessageResponseResponseobjectAgentMetricsobjectAgentMetricsResponseResponseobjectAgentPoolobjectAgentPoolResponseResponseobjectAgentTaskobjectAgentTaskResponseResponseobjectAlertPrioritystringAllDomainsHealthResponseobjectAnalysisPeriodstringAnalyticsEventobjectAnalyticsEventResponseResponseobjectAnalyticsTimeRangeobjectAnnouncementobjectAnnouncementResponseResponseobjectApiKeyobjectApiKeysResponseobjectApplyOptimizationobjectAssetobjectAssetBaseobjectAssetFolderobjectAssetFolderResponseobjectAssetMetadataobjectAssetResponseobjectAssetThumbnailobjectAssetVersionobjectAssetVersionDetailResponseobjectAuditLogobjectAuditLogEntryobjectAuthResponseobjectAutocompleteResultsobjectAutocompleteResultsResponseResponseobjectAvailabilityScheduleobjectAvailabilityWindowobjectAvatarUploadDataobjectAvatarUploadResponseobjectBackgroundJobobjectBackgroundJobResponseResponseobjectBatchTrackEventsobjectBenchmarkRequestobjectBroadcastMessageobjectBulkAssetOperationobjectBulkConversionRequestobjectBulkConversionResponseobjectBulkCreateLineItemsobjectBulkDeleteLineItemsobjectBulkExchangeRateImportobjectBulkInviteobjectBulkInviteResultResponseobjectBulkOperationResultResponseobjectBulkStatusChangeobjectBulkUpdateLineItemsobjectBulkUserActionobjectCSVExportOptionsobjectCacheInvalidationobjectCacheStatsobjectCacheStatsResponseResponseobjectCallSheetobjectCallSheetCrewEntryobjectCallSheetCrewEntryResponseobjectCallSheetResponseobjectCallSheetStatsobjectCallSheetStatsResponseobjectCallSheetWithEntriesobjectCallSheetWithEntriesResponseobjectCategoryTemplateobjectCategoryVarianceBreakdownobjectChangePasswordobjectCharacterAnalysisResponseobjectCheckAvailabilityobjectCheckCrewAvailabilityobjectCheckLocationAvailabilityobjectChecklistItemobjectChecklistItemResponseobjectChecklistTemplateobjectChecklistTemplatesResponseobjectCircuitStatsResponseobjectCloneTemplateobjectCohortDefinitionobjectCohortDefinitionResponseResponseobjectCohortPeriodobjectCohortResultobjectCohortResultResponseResponseobjectCohortRowobjectCommentobjectCommentResponseobjectCommentResponseResponseobjectCompatibilityMatrixobjectConfirmDeletionobjectConnectionPresenceobjectContentReportobjectContentReportResponseResponseobjectConversionRequestobjectConversionResponseobjectConversionResultobjectConversionTimingstringCoordinatesobjectCopyLineItemsobjectCreateAgentConfigobjectCreateAgentPoolobjectCreateAnnotationobjectCreateAnnouncementobjectCreateApiKeyRequestobjectCreateApiKeyResponseobjectCreateApprovalRequestobjectCreateAssetRequestobjectCreateBudgetobjectCreateBudgetTemplateobjectCreateCalendarEventobjectCreateCallSheetCrewEntryobjectCreateCategoryobjectCreateChecklistItemobjectCreateCohortobjectCreateCommentobjectCreateCrewAssignmentobjectCreateCrewAvailabilityobjectCreateCrewMemberobjectCreateCrewSkillobjectCreateDashboardobjectCreateExchangeRateRequestobjectCreateExpenseobjectCreateFeatureFlagobjectCreateFolderobjectCreateForecastobjectCreateFunnelobjectCreateHedgeRequestobjectCreateInvitationobjectCreateInvoiceobjectCreateLayerobjectCreateLineItemobjectCreateLocationobjectCreateLocationChecklistobjectCreateLocationContactobjectCreateLocationMediaobjectCreateLocationPermitobjectCreateMilestoneobjectCreateOrganizationobjectCreatePOobjectCreatePanelobjectCreatePluginReviewobjectCreateProjectobjectCreateProjectCommentobjectCreateReportobjectCreateResourceobjectCreateReviewobjectCreateRoleDefinitionobjectCreateSavedSearchobjectCreateSceneobjectCreateScheduleobjectCreateScheduleItemobjectCreateScheduledReportobjectCreateScriptobjectCreateScriptCharacterobjectCreateScriptCommentobjectCreateScriptElementobjectCreateScriptVersionobjectCreateShareobjectCreateShareLinkobjectCreateShareLinkRequestobjectCreateShotobjectCreateStoryBeatobjectCreateStoryboardobjectCreateStoryboardVersionobjectCreateTaskobjectCreateTeamobjectCreateThreadobjectCreateThresholdRequestobjectCreateWebhookobjectCrewAssignmentobjectCrewAssignmentResponseobjectCrewAvailabilityobjectCrewAvailabilityResponseobjectCrewAvailabilitySummariesResponseobjectCrewAvailabilitySummaryobjectCrewMemberobjectCrewMemberBaseobjectCrewMemberResponseobjectCrewSkillobjectCrewSkillResponseobjectCrewStatsobjectCrewStatsResponseobjectCurrencyCodestringCurrencyConfigResponseobjectCurrencyConfigurationobjectCurrencyHedgeobjectCurrencyMetadataobjectCurrencyRateHistoryobjectCursorPositionobjectDashboardobjectDashboardResponseobjectDashboardResponseResponseobjectDashboardWidgetobjectDashboardWidgetConfigobjectDataResponseobjectDatabaseStatsobjectDatabaseStatsResponseResponseobjectDateRangeFilterobjectDeletionResultobjectDeletionResultResponseobjectDeletionStatusResponseobjectDomainHealthobjectDownloadUrlResponseobjectEVMMetricsobjectEVMResponseobjectEVMStatusstringEmailVerificationobjectEmailVerificationResponseobjectEmailVerificationResultResponseobjectEmailVerificationStatusobjectEmailVerificationStatusResponseobjectErrorResponseobjectExchangeRateobjectExchangeRateProviderstringExchangeRatesResponseobjectExportFieldSelectionobjectExportInfoobjectExportJobobjectExportJobResponseResponseobjectExportLineItemsobjectExportRequestobjectExportResponseobjectExportStatisticsobjectExportStoryboardobjectExportedActivityobjectExportedApiKeyobjectExportedAssetobjectExportedCommentobjectExportedConnectedAccountobjectExportedNotificationobjectExportedOrganizationMembershipobjectExportedOwnedProjectobjectExportedPortfolioItemobjectExportedPreferencesobjectExportedProfileobjectExportedProjectMembershipobjectExportedSessionobjectExportedSkillobjectExportedSocialLinkobjectExportedTagobjectFacetDefinitionobjectFacetResultobjectFacetValueobjectFeatureCompatibilityobjectFeatureFlagobjectFeatureFlagResponseResponseobjectFindCrewBySkillsobjectFunnelDefinitionobjectFunnelDefinitionResponseResponseobjectFunnelResultobjectFunnelResultResponseResponseobjectFunnelStepobjectFunnelStepResultobjectFxImpactobjectFxImpactResponseobjectGenerateCallSheetobjectGeneratePanelImageobjectGeneratePredictionsRequestobjectGenerateStoryboardFromSceneobjectGeneratedReportobjectGeneratedReportResponseResponseobjectGeocodeRequestobjectGeocodeResultobjectGeocodeResultResponseobjectHedgesResponseobjectHookExecutionobjectHookRegistrationobjectHookRegistrationResponseResponseobjectICSExportOptionsobjectImpersonationTokenobjectImpersonationTokenResponseResponseobjectImportLineItemsobjectImportTemplateobjectIndexStatusobjectIndexStatusResponseResponseobjectInstallPluginobjectInvitationobjectInvitationResponseobjectInviteRecipientRequestobjectJoinSessionobjectKPIsResponseobjectLineItemTemplateobjectLocationobjectLocationAvailabilityResultobjectLocationAvailabilityResultsResponseobjectLocationBaseobjectLocationChecklistobjectLocationChecklistResponseobjectLocationContactobjectLocationContactResponseobjectLocationCostobjectLocationMediaobjectLocationMediaResponseobjectLocationPermitobjectLocationPermitResponseobjectLocationResponseobjectLocationStatsobjectLocationStatsResponseobjectLockobjectLockResponseResponseobjectLockScriptobjectLoginRequestobjectLogoUploadResponseobjectMaintenanceConfigobjectMaintenanceConfigResponseResponseobjectMapClusterobjectMapDataResponseobjectMapMarkerobjectMarketplacePluginobjectMarketplacePluginResponseResponseobjectMemberResponseobjectMetricFilterobjectMetricQueryobjectMetricResultobjectMetricsResponseobjectMetricsResponseWrapperResponseobjectMigrationChangeobjectMigrationGuideobjectMigrationPathobjectMigrationSummaryobjectModerationDecisionobjectModerationLogobjectMoveAssetobjectMultiCurrencyBudgetSummaryobjectMultiCurrencyBudgetSummaryResponseobjectNotFoundResponseobjectNotificationobjectNotificationResponseResponseobjectOAuthCallbackobjectOAuthInitResponseobjectOptimizationPreferencesobjectOptimizationRequestobjectOrganizationobjectOrganizationBaseobjectOrganizationMemberobjectOrganizationMemberResponseobjectOrganizationResponseobjectOrganizationSettingsobjectOrganizationUsageobjectOrganizationUsageResponseobjectPDFStylingOptionsobjectPaginatedActivitiesobjectPaginatedAlertsResponseobjectPaginatedApprovalsResponseobjectPaginatedAssetVersionsobjectPaginatedAssetsobjectPaginatedAuditLogsobjectPaginatedCallSheetCrewEntriesobjectPaginatedCallSheetsobjectPaginatedCrewAssignmentsobjectPaginatedCrewAvailabilitiesobjectPaginatedCrewMembersobjectPaginatedCrewSkillsobjectPaginatedFoldersobjectPaginatedInvitationsobjectPaginatedItemsobjectPaginatedLocationPermitsobjectPaginatedLocationsobjectPaginatedNotificationsobjectPaginatedOrganizationMembersobjectPaginatedOrganizationsobjectPaginatedPaginatedActivitiesobjectPaginatedPaginatedAdminOrganizationsobjectPaginatedPaginatedAdminUsersobjectPaginatedPaginatedAgentInfosobjectPaginatedPaginatedAgentMessagesobjectPaginatedPaginatedAgentPoolsobjectPaginatedPaginatedAgentTasksobjectPaginatedPaginatedAnnouncementsobjectPaginatedPaginatedAuditLogsobjectPaginatedPaginatedBackgroundJobsobjectPaginatedPaginatedCohortsobjectPaginatedPaginatedCommentsobjectPaginatedPaginatedContentReportsobjectPaginatedPaginatedDashboardsobjectPaginatedPaginatedDeliveriesobjectPaginatedPaginatedEventsobjectPaginatedPaginatedExportJobsobjectPaginatedPaginatedFeatureFlagsobjectPaginatedPaginatedFunnelsobjectPaginatedPaginatedHookExecutionsobjectPaginatedPaginatedHookRegistrationsobjectPaginatedPaginatedLocksobjectPaginatedPaginatedMarketplacePluginsobjectPaginatedPaginatedModerationLogsobjectPaginatedPaginatedNotificationsobjectPaginatedPaginatedPluginReviewsobjectPaginatedPaginatedPluginsobjectPaginatedPaginatedPresenceobjectPaginatedPaginatedReportsobjectPaginatedPaginatedReviewsobjectPaginatedPaginatedSavedSearchesobjectPaginatedPaginatedScheduledReportsobjectPaginatedPaginatedSharesobjectPaginatedPaginatedThreadsobjectPaginatedPaginatedWebhooksobjectPaginatedProjectActivitiesobjectPaginatedProjectCommentsobjectPaginatedProjectMembersobjectPaginatedProjectsobjectPaginatedRoleDefinitionsobjectPaginatedScenesobjectPaginatedScriptCharactersobjectPaginatedScriptCommentsobjectPaginatedScriptElementsobjectPaginatedScriptVersionsobjectPaginatedScriptsobjectPaginatedStoryBeatsobjectPaginatedTeamMembersobjectPaginatedTeamsobjectPaginationMetaobjectPasswordResetConfirmobjectPasswordResetRequestobjectPasswordResetVerifyobjectPasswordResetVerifyResponseobjectPasswordStrengthCheckRequestobjectPasswordStrengthCheckResponseobjectPasswordStrengthChecksobjectPeriodComparisonResponseobjectPluginobjectPluginHookDefinitionobjectPluginManifestobjectPluginResponseResponseobjectPluginReviewobjectPluginReviewResponseResponseobjectPluginSettingDefinitionobjectPoolMetricsobjectPoolMetricsResponseResponseobjectPortfolioItemobjectPortfolioItemResponseobjectPortfolioItemsResponseobjectPresenceobjectPresenceResponseobjectPresenceResponseResponseobjectProfileCompletionResponseobjectProfileCompletionStatusobjectProfileExportResponseobjectProfileSectionCompletionobjectProfileVisibilitySettingsobjectProjectobjectProjectActivityobjectProjectBaseobjectProjectCommentobjectProjectMemberobjectProjectResponseobjectProjectSettingsobjectProxyErrorResponseobjectQueueStatsobjectQueueStatsResponseResponseobjectQuickSuggestionRequestobjectRateHistoryResponseobjectRateTypestringRealtimeMetricsobjectRealtimeMetricsResponseResponseobjectRecordActualobjectRecordCommitmentobjectRecordPaymentobjectRecurrencePatternobjectRecurrenceRuleobjectRefreshTokenRequestobjectRegisterRequestobjectReorderElementsobjectReorderLineItemsobjectReorderPanelsobjectReorderPortfolioItemsobjectReorderScenesobjectReorderSocialLinksobjectReportobjectReportConfigobjectReportResponseResponseobjectRequestDeletionobjectResendVerificationResponseobjectResolveAlertRequestobjectResolveConflictobjectResourceConstraintobjectRetryConfigobjectRetryPolicyobjectReverseGeocodeRequestobjectReviewobjectReviewApprovalRequestobjectReviewDecisionRecordobjectReviewExpenseobjectReviewResponseResponseobjectRevisionInfoobjectRiskFactorobjectRoleDefinitionobjectRoleDefinitionResponseobjectRootCauseAnalysisobjectRootCauseAnalysisResponseobjectRoundingPolicystringSavedSearchobjectSavedSearchResponseResponseobjectScenarioAnalysisRequestobjectScenarioAnalysisResultobjectScenarioModificationobjectSceneobjectSceneBaseobjectSceneResponseobjectScheduleConstraintobjectScheduleExportRequestobjectScheduleItemDependencyobjectScheduledReportobjectScheduledReportResponseResponseobjectScriptobjectScriptBaseobjectScriptCharacterobjectScriptCharacterResponseobjectScriptCommentobjectScriptCommentResponseobjectScriptElementobjectScriptElementResponseobjectScriptExportResponseobjectScriptResponseobjectScriptStatsobjectScriptStatsResponseobjectScriptVersionobjectScriptVersionResponseobjectSearchFilterobjectSearchHighlightobjectSearchHistoryItemobjectSearchHistoryResponseResponseobjectSearchQueryobjectSearchResultItemobjectSearchResultsobjectSearchResultsResponseResponseobjectSelectionRangeobjectSendCallSheetobjectSendHistoryobjectSendHistoryResponseobjectSendMessageobjectSendResultobjectSendResultsResponseobjectServiceStatusobjectSessionobjectSessionInfoobjectSessionParticipantobjectSessionResponseResponseobjectSessionsResponseobjectShareobjectShareLinkConfigobjectShareRecipientobjectShareResponseResponseobjectSkillobjectSkillMatchResultobjectSkillMatchResultsResponseobjectSkillResponseobjectSkillsResponseobjectSocialLinkobjectSocialLinkResponseobjectSocialLinksobjectSocialLinksResponseobjectStoryBeatobjectStoryBeatResponseobjectStoryboardBaseobjectSubCategoryTemplateobjectSubmitReviewDecisionobjectSubscribeExampleobjectSuccessResponseobjectSuggestionobjectSunPositionobjectSunPositionResponseobjectSupportedCurrenciesResponseobjectSystemConfigobjectSystemConfigResponseResponseobjectSystemMetricsobjectSystemMetricsResponseResponseobjectSystemStatusobjectSystemStatusResponseResponseobjectTagobjectTagsResponseobjectTaskInputobjectTaskOutputobjectTaskResultobjectTaskResultResponseResponseobjectTeamobjectTeamMemberobjectTeamMemberResponseobjectTeamResponseobjectTestWebhookobjectTestWebhookResultobjectTestWebhookResultResponseResponseobjectThreadobjectThreadAnchorobjectThreadResponseResponseobjectThresholdOperatorstringThumbnailUploadResponseobjectTimeSeriesPointobjectTokenPairobjectTokenRefreshResponseobjectTrackEventobjectTrendAnalysisResponseobjectTrendDirectionstringUnsubscribeExampleobjectUpdateAgentConfigobjectUpdateAgentPoolobjectUpdateAnnotationobjectUpdateAnnouncementobjectUpdateAssetobjectUpdateBudgetobjectUpdateBudgetTemplateobjectUpdateCalendarEventobjectUpdateCategoryobjectUpdateChecklistItemobjectUpdateCommentobjectUpdateConfigobjectUpdateCrewAssignmentobjectUpdateCrewAvailabilityobjectUpdateCrewMemberobjectUpdateCrewSkillobjectUpdateDashboardobjectUpdateExpenseobjectUpdateFeatureFlagobjectUpdateInvoiceobjectUpdateLineItemobjectUpdateLocationobjectUpdateLocationContactobjectUpdateLocationMediaobjectUpdateLocationPermitobjectUpdateMaintenanceobjectUpdateMilestoneobjectUpdateMyPresenceobjectUpdateOrganizationobjectUpdateOrganizationMemberobjectUpdatePOobjectUpdatePanelobjectUpdatePluginSettingsobjectUpdatePluginVersionobjectUpdatePortfolioItemobjectUpdatePresenceobjectUpdateProjectobjectUpdateProjectMemberobjectUpdateResourceobjectUpdateRoleDefinitionobjectUpdateSavedSearchobjectUpdateSceneobjectUpdateScheduleobjectUpdateScheduleItemobjectUpdateScheduledReportobjectUpdateScriptobjectUpdateScriptCharacterobjectUpdateScriptElementobjectUpdateShareobjectUpdateSkillobjectUpdateSocialLinkobjectUpdateStoryBeatobjectUpdateStoryboardobjectUpdateTeamobjectUpdateThresholdRequestobjectUpdateUserPreferencesobjectUpdateUserProfileobjectUpdateWebhookobjectUploadUrlResponseobjectUpsertCurrencyConfigRequestobjectUserobjectUserActivityobjectUserBaseobjectUserDataExportobjectUserNotificationobjectUserPreferencesobjectUserPreferencesResponseobjectUserProfileobjectUserProfileResponseobjectUserResponseobjectUserStatsobjectUserStatsResponseobjectUsernameCheckResponseobjectVarianceAlertobjectVarianceApprovalRequestobjectVarianceApprovalStatusstringVarianceDashboardSummaryobjectVarianceKPIsobjectVariancePeriodComparisonobjectVarianceReportobjectVarianceReportConfigobjectVarianceReportResponseobjectVarianceSeveritystringVarianceThresholdobjectVarianceTrendAnalysisobjectVarianceTrendPointobjectVarianceTypestringVersionInfoobjectWeatherForecastobjectWeatherForecastsResponseobjectWebSocketAuthenticationobjectWebSocketChannelobjectWebSocketInfoResponseobjectWebSocketStatsResponseobjectWebhookobjectWebhookAuthobjectWebhookDeliveryobjectWebhookEventobjectWebhookFiltersobjectWebhookResponseResponseobjectWebhookStatsobjectWebhookStatsResponseResponseobjectXLSXExportOptionsobject