Every endpoint
The whole workspace API, grouped by the permission that reaches it. Generated from a running Reelwire, so this is what the server actually serves rather than what somebody remembered to write down. Platform routes, which belong to Reelwire staff, are not listed.
Base URL in development is http://localhost:4000. Every path below is prefixed with that.
note
Contract 96b7f57e61f4, read at 2026-11-01T18:57:07.174Z.
Posts
| Method | Path | Permission |
|---|---|---|
GET | /v1/jobs | posts:read |
POST | /v1/jobs/{id}/archive | posts:write |
POST | /v1/jobs/{id}/cancel | posts:write |
POST | /v1/jobs/{id}/comments | posts:write |
PATCH | /v1/jobs/{id}/comments/{commentId} | posts:write |
POST | /v1/jobs/{id}/comments/{commentId}/delete | posts:write |
POST | /v1/jobs/{id}/delete | posts:write |
GET | /v1/jobs/{id}/download | posts:read |
POST | /v1/jobs/{id}/kit-link | posts:write |
POST | /v1/jobs/{id}/mark-deleted | posts:write |
POST | /v1/jobs/{id}/mark-published | posts:write |
POST | /v1/jobs/{id}/repost | posts:write |
POST | /v1/jobs/{id}/resend-connector | posts:write |
POST | /v1/jobs/{id}/resend-email | posts:write |
POST | /v1/jobs/{id}/resend-participants | posts:write |
POST | /v1/jobs/{id}/resend-webhook | posts:write |
POST | /v1/jobs/{id}/retry | posts:write |
POST | /v1/jobs/{id}/retry-render | posts:write |
GET | /v1/jobs/{id}/reuse | posts:read |
POST | /v1/jobs/{id}/skip | posts:write |
POST | /v1/jobs/{id}/unarchive | posts:write |
POST | /v1/jobs/{id}/update | posts:write |
GET | /v1/overview | posts:read |
GET | /v1/pipeline | posts:read |
GET | /v1/pipeline/{id} | posts:read |
GET | /v1/posts | posts:read |
GET | /v1/posts/{id}/package | posts:read |
POST | /v1/posts/{id}/report | posts:write |
Posts - Approvals
| Method | Path | Permission |
|---|---|---|
GET | /v1/approvals | approvals:read |
POST | /v1/approvals/{id} | approvals:write |
Schedule
| Method | Path | Permission |
|---|---|---|
GET | /v1/calendar | schedule:read |
GET | /v1/calendar/export | schedule:read |
GET | /v1/calendar/export/jobs | schedule:read |
POST | /v1/calendar/export/jobs | schedule:read |
GET | /v1/calendar/export/jobs/{jobId} | schedule:read |
POST | /v1/calendar/export/jobs/{jobId}/cancel | schedule:read |
GET | /v1/calendar/export/jobs/{jobId}/file | schedule:read |
GET | /v1/calendar/export/link | schedule:read |
GET | /v1/calendar/still | schedule:read |
Compliance
| Method | Path | Permission |
|---|---|---|
GET | /v1/compliance | compliance:read |
GET | /v1/compliance/audit | compliance:read |
GET | /v1/compliance/export | compliance:read |
GET | /v1/compliance/export/link | compliance:read |
GET | /v1/compliance/records | compliance:read |
GET | /v1/compliance/records/{id} | compliance:read |
Clip studio
| Method | Path | Permission |
|---|---|---|
GET | /v1/catalogue | templates:read |
GET | /v1/formats/feed/{feedId} | templates:read |
GET | /v1/formats/feed/{source}/{format} | templates:read |
GET | /v1/formats/template/{templateId} | templates:read |
GET | /v1/formats/templates | templates:read |
GET | /v1/templates | templates:read |
GET | /v1/templates/{templateId}/reference | templates:read |
GET | /v1/templates/{templateId}/reference-sheet | templates:read |
GET | /v1/templates/{templateId}/reference/{ratio} | templates:read |
GET | /v1/templates/{templateId}/reference/{ratio}/still | templates:read |
GET | /v1/templates/{templateId}/still/{ratio} | templates:read |
POST | /v1/templates/{templateId}/validate | templates:read |
POST | /v1/templates/custom-design | templates:write |
Clip studio - Create clip
| Method | Path | Permission |
|---|---|---|
POST | /v1/direct-export/batch | renders:write |
POST | /v1/direct-export/keyframes | renders:write |
GET | /v1/direct-export/queue | renders:read |
POST | /v1/direct-export/timing | renders:read |
POST | /v1/direct-export/video | renders:write |
GET | /v1/direct-export/video/{jobId} | renders:read |
POST | /v1/direct-export/video/{jobId}/discard | renders:write |
GET | /v1/direct-export/video/{jobId}/download | renders:read |
POST | /v1/direct-export/video/{jobId}/link | renders:write |
GET | /v1/direct-export/video/{jobId}/reuse | renders:read |
GET | /v1/direct-export/videos | renders:read |
GET | /v1/direct-export/videos/{jobId} | renders:read |
POST | /v1/direct-export/zip | renders:read |
GET | /v1/direct-export/zip/link | renders:read |
GET | /v1/render-jobs | renders:read |
GET | /v1/render-jobs/{id}/package | renders:read |
Media
| Method | Path | Permission |
|---|---|---|
GET | /v1/assets/{id} | media:read |
GET | /v1/assets/{id}/download | media:read |
GET | /v1/media | media:read |
POST | /v1/media | media:write |
POST | /v1/media/{id}/delete | media:write |
POST | /v1/media/{id}/rename | media:write |
GET | /v1/media/{id}/uses | media:read |
GET | /v1/media/feed-pictures | media:read |
POST | /v1/media/import | media:write |
GET | /v1/media/renders | media:read |
POST | /v1/media/renders/{id}/copy | media:write |
POST | /v1/media/renders/{id}/delete | media:write |
GET | /v1/media/renders/{id}/reuse | media:read |
POST | /v1/media/upload-link | media:write |
GET | /v1/sound-library | media:read |
Brands
| Method | Path | Permission |
|---|---|---|
GET | /v1/brands | brands:read |
POST | /v1/brands | brands:write |
GET | /v1/brands/{id} | brands:read |
PATCH | /v1/brands/{id} | brands:write |
POST | /v1/brands/{id}/assets/{slot} | brands:write |
POST | /v1/brands/{id}/assets/{slot}/delete | brands:write |
POST | /v1/brands/{id}/assets/{slot}/link | brands:write |
POST | /v1/brands/{id}/delete | brands:write |
POST | /v1/brands/{id}/duplicate | brands:write |
GET | /v1/brands/{id}/kit | brands:read |
GET | /v1/brands/{id}/kit/jobs | brands:read |
POST | /v1/brands/{id}/kit/jobs | brands:read |
GET | /v1/brands/{id}/kit/jobs/{jobId} | brands:read |
POST | /v1/brands/{id}/kit/jobs/{jobId}/cancel | brands:read |
GET | /v1/brands/{id}/kit/jobs/{jobId}/file | brands:read |
GET | /v1/brands/{id}/kit/jobs/{jobId}/pictures/{index} | brands:read |
GET | /v1/brands/{id}/kit/link | brands:read |
GET | /v1/brands/draft | brands:read |
GET | /v1/brands/kits | brands:read |
POST | /v1/brands/palette | brands:read |
POST | /v1/brands/read-website | brands:read |
GET | /v1/brands/watches | brands:read |
POST | /v1/brands/watches | brands:write |
PATCH | /v1/brands/watches/{watchId} | brands:write |
POST | /v1/brands/watches/{watchId}/delete | brands:write |
GET | /v1/brands/watches/outlook | brands:read |
Channels
| Method | Path | Permission |
|---|---|---|
GET | /v1/channels | channels:read |
POST | /v1/channels | channels:write |
PATCH | /v1/channels/{id} | channels:write |
PUT | /v1/channels/{id}/credentials | channels:write |
POST | /v1/channels/{id}/credentials/delete | channels:write |
POST | /v1/channels/{id}/delete | channels:write |
POST | /v1/channels/{id}/duplicate | channels:write |
POST | /v1/channels/{id}/subscriptions | channels:write |
PATCH | /v1/channels/{id}/subscriptions/{subId} | channels:write |
POST | /v1/channels/{id}/subscriptions/{subId}/delete | channels:write |
POST | /v1/channels/connector/test | channels:write |
POST | /v1/channels/silences | channels:write |
PATCH | /v1/channels/silences/{id} | channels:write |
POST | /v1/channels/silences/{id}/delete | channels:write |
GET | /v1/channels/stop | channels:read |
POST | /v1/channels/stop | channels:write |
POST | /v1/channels/stop/resume | channels:write |
GET | /v1/channels/surfaces | channels:read |
GET | /v1/quick-start | channels:read |
GET | /v1/quick-start/profile | channels:read |
PUT | /v1/quick-start/profile | channels:write |
POST | /v1/quick-start/profile/forget | channels:write |
Syndication
| Method | Path | Permission |
|---|---|---|
GET | /v1/syndication/deliveries | syndication:read |
POST | /v1/syndication/deliveries/{id}/redeliver | syndication:write |
GET | /v1/syndication/groups | syndication:read |
POST | /v1/syndication/groups | syndication:write |
GET | /v1/syndication/groups/{id} | syndication:read |
PATCH | /v1/syndication/groups/{id} | syndication:write |
POST | /v1/syndication/groups/{id}/delete | syndication:write |
POST | /v1/syndication/groups/{id}/partners | syndication:write |
GET | /v1/syndication/partners | syndication:read |
GET | /v1/syndication/partners/{id} | syndication:read |
PATCH | /v1/syndication/partners/{id} | syndication:write |
POST | /v1/syndication/partners/{id}/delete | syndication:write |
POST | /v1/syndication/preview | syndication:read |
POST | /v1/syndication/sender/test | syndication:write |
GET | /v1/syndication/settings | syndication:read |
PUT | /v1/syndication/settings | syndication:write |
Ready-made feeds
| Method | Path | Permission |
|---|---|---|
GET | /v1/feeds | feeds:read |
PUT | /v1/feeds | feeds:write |
GET | /v1/feeds/{feedId}/reference | feeds:read |
GET | /v1/feeds/{feedId}/reference/{ratio} | feeds:read |
GET | /v1/feeds/{feedId}/reference/{ratio}/still | feeds:read |
GET | /v1/feeds/{feedId}/still/{ratio} | feeds:read |
Post composer
| Method | Path | Permission |
|---|---|---|
GET | /v1/queues | postlists:read |
POST | /v1/queues | postlists:write |
PATCH | /v1/queues/{id} | postlists:write |
POST | /v1/queues/{id}/delete | postlists:write |
POST | /v1/queues/{id}/packages | postlists:write |
PATCH | /v1/queues/{id}/packages/{packageId} | postlists:write |
POST | /v1/queues/{id}/packages/{packageId}/delete | postlists:write |
POST | /v1/queues/{id}/packages/batch | postlists:write |
GET | /v1/queues/{id}/plan | postlists:read |
Reelwire Pocket
| Method | Path | Permission |
|---|---|---|
GET | /v1/pocket | pocket:read |
POST | /v1/pocket | pocket:write |
PATCH | /v1/pocket/{id} | pocket:write |
GET | /v1/pocket/{id}/clips | pocket:read |
POST | /v1/pocket/{id}/clips | pocket:write |
GET | /v1/pocket/{id}/clips/{clipId} | pocket:read |
POST | /v1/pocket/{id}/clips/{clipId}/archive | pocket:write |
POST | /v1/pocket/{id}/clips/{clipId}/change | pocket:write |
POST | /v1/pocket/{id}/clips/{clipId}/discard | pocket:write |
POST | /v1/pocket/{id}/clips/{clipId}/post | pocket:write |
POST | /v1/pocket/{id}/clips/{clipId}/preview | pocket:write |
POST | /v1/pocket/{id}/clips/{clipId}/text | pocket:write |
POST | /v1/pocket/{id}/clips/{clipId}/unarchive | pocket:write |
POST | /v1/pocket/{id}/delete | pocket:write |
GET | /v1/pocket/clips | pocket:read |
PUT | /v1/pocket/order | pocket:write |
Custom feeds
| Method | Path | Permission |
|---|---|---|
GET | /v1/streams | streams:read |
POST | /v1/streams | streams:write |
POST | /v1/streams/{id}/delete | streams:write |
POST | /v1/streams/{id}/suggest-map | streams:write |
POST | /v1/streams/{id}/update | streams:write |
Custom feeds - Send raw data
| Method | Path | Permission |
|---|---|---|
POST | /v1/ingest/{source}/{format} | ingest:write |
POST | /v1/ingest/{source}/{format}/validate | ingest:write |
GET | /v1/stream | ingest:write |
POST | /v1/stream | ingest:write |
POST | /v1/stream/validate | ingest:write |
Webhook
| Method | Path | Permission |
|---|---|---|
GET | /v1/webhook | webhooks:read |
PUT | /v1/webhook | webhooks:write |
POST | /v1/webhook/test | webhooks:write |
Activity
| Method | Path | Permission |
|---|---|---|
GET | /v1/ingest-events | received:read |
GET | /v1/ingest-events/{id} | received:read |
Activity - What went out
| Method | Path | Permission |
|---|---|---|
GET | /v1/connections | connections:read |
PUT | /v1/connections/mode | connections:write |
GET | /v1/connector/adapters/{platform} | connections:read |
GET | /v1/connector/env | connections:read |
GET | /v1/connector/script/{language} | connections:read |
GET | /v1/deliveries | connections:read |
GET | /v1/deliveries/{id} | connections:read |
POST | /v1/deliveries/{id}/redeliver | connections:write |
Team
| Method | Path | Permission |
|---|---|---|
GET | /v1/team/users | team:read |
POST | /v1/team/users | team:write |
PATCH | /v1/team/users/{userId} | team:write |
POST | /v1/team/users/{userId}/delete | team:write |
POST | /v1/team/users/{userId}/resend | team:write |
Allowance
| Method | Path | Permission |
|---|---|---|
GET | /v1/renders/quota | allowance:read |
Plan
| Method | Path | Permission |
|---|---|---|
GET | /v1/licence | plan:read |
Not available to API keys
These belong to a signed-in person. A key is refused on all of them, whatever it holds.
| Method | Path | Permission |
|---|---|---|
GET | /v1/_meta | signed-in person |
GET | /v1/_routes | signed-in person |
POST | /v1/auth/account/delete | signed-in person |
GET | /v1/auth/google/callback | signed-in person |
GET | /v1/auth/google/start | signed-in person |
POST | /v1/auth/heartbeat | signed-in person |
POST | /v1/auth/login | signed-in person |
POST | /v1/auth/login/google | signed-in person |
POST | /v1/auth/login/two-factor | signed-in person |
POST | /v1/auth/logout | signed-in person |
POST | /v1/auth/password-reset | signed-in person |
POST | /v1/auth/password-reset/confirm | signed-in person |
POST | /v1/auth/password-reset/request | signed-in person |
PATCH | /v1/auth/profile | signed-in person |
GET | /v1/auth/session | signed-in person |
GET | /v1/auth/sign-in-methods | signed-in person |
POST | /v1/auth/signup | signed-in person |
POST | /v1/auth/two-factor/disable | signed-in person |
POST | /v1/auth/two-factor/enable | signed-in person |
POST | /v1/auth/two-factor/recovery-codes | signed-in person |
POST | /v1/auth/two-factor/setup | signed-in person |
POST | /v1/auth/verify | signed-in person |
POST | /v1/auth/verify/resend | signed-in person |
GET | /v1/billing | signed-in person |
POST | /v1/billing/address | signed-in person |
POST | /v1/billing/checkout | signed-in person |
GET | /v1/billing/checkout/{sessionId} | signed-in person |
GET | /v1/billing/confirmation | signed-in person |
POST | /v1/billing/confirmation/cancel | signed-in person |
POST | /v1/billing/payment | signed-in person |
POST | /v1/billing/plan | signed-in person |
POST | /v1/billing/portal | signed-in person |
GET | /v1/brand-kit-files/{tenantId} | signed-in person |
POST | /v1/broadcast | signed-in person |
GET | /v1/broadcast/{id} | signed-in person |
POST | /v1/broadcast/founder-sign-in | signed-in person |
GET | /v1/broadcast/log | signed-in person |
GET | /v1/broadcast/log/{id} | signed-in person |
GET | /v1/broadcast/pictures | signed-in person |
GET | /v1/broadcast/schedules | signed-in person |
POST | /v1/broadcast/validate | signed-in person |
GET | /v1/broadcasts | signed-in person |
POST | /v1/channels/connector/connect | signed-in person |
GET | /v1/channels/connector/connect/{id} | signed-in person |
GET | /v1/channels/connector/unclaimed | signed-in person |
GET | /v1/commission | signed-in person |
PATCH | /v1/commission | signed-in person |
GET | /v1/commission/contract | signed-in person |
POST | /v1/commission/contract | signed-in person |
POST | /v1/commission/payouts | signed-in person |
POST | /v1/commission/payouts/{id}/link | signed-in person |
GET | /v1/commission/payouts/{id}/statement | signed-in person |
PUT | /v1/commission/tax | signed-in person |
GET | /v1/commission/tax/document | signed-in person |
POST | /v1/commission/tax/document | signed-in person |
GET | /v1/commission/tax/document/link | signed-in person |
POST | /v1/commission/tax/document/upload-link | signed-in person |
GET | /v1/compliance-files/{tenantId} | signed-in person |
PUT | /v1/compliance/approval-rules/{channelId} | signed-in person |
GET | /v1/compliance/auditors | signed-in person |
POST | /v1/compliance/auditors | signed-in person |
POST | /v1/compliance/auditors/{userId}/delete | signed-in person |
POST | /v1/compliance/auditors/{userId}/resend | signed-in person |
GET | /v1/connect-return | signed-in person |
GET | /v1/export-files/{jobId} | signed-in person |
GET | /v1/export-files/zip | signed-in person |
POST | /v1/forms | signed-in person |
GET | /v1/health | signed-in person |
GET | /v1/keys | signed-in person |
POST | /v1/keys | signed-in person |
PATCH | /v1/keys/{keyId} | signed-in person |
POST | /v1/keys/{keyId}/remove | signed-in person |
POST | /v1/keys/{keyId}/reveal | signed-in person |
POST | /v1/keys/{keyId}/revoke | signed-in person |
GET | /v1/keys/permissions | signed-in person |
GET | /v1/kit/{token} | signed-in person |
POST | /v1/kit/{token}/{postGroupId}/deleted | signed-in person |
POST | /v1/kit/{token}/{postGroupId}/published | signed-in person |
POST | /v1/kit/{token}/{postGroupId}/skip | signed-in person |
POST | /v1/licence | signed-in person |
POST | /v1/licence/offer/{offerId}/accept | signed-in person |
POST | /v1/licence/offer/billing-details | signed-in person |
GET | /v1/mail/stop | signed-in person |
POST | /v1/mail/stop | signed-in person |
POST | /v1/mockup-hook/{id} | signed-in person |
POST | /v1/oauth/consent | signed-in person |
POST | /v1/oauth/describe | signed-in person |
GET | /v1/partner/channels/{token} | signed-in person |
POST | /v1/partner/channels/{token} | signed-in person |
GET | /v1/partner/confirm/{token} | signed-in person |
POST | /v1/partner/confirm/{token} | signed-in person |
GET | /v1/partner/kit/{token} | signed-in person |
GET | /v1/partner/stop/{token} | signed-in person |
POST | /v1/partner/stop/{token} | signed-in person |
GET | /v1/partner/webhook-stop/{token} | signed-in person |
POST | /v1/partner/webhook-stop/{token} | signed-in person |
GET | /v1/partner/webhook/{token} | signed-in person |
POST | /v1/partner/webhook/{token} | signed-in person |
GET | /v1/payout | signed-in person |
POST | /v1/payout | signed-in person |
GET | /v1/pocket-app/clips | signed-in person |
POST | /v1/pocket-app/pair | signed-in person |
POST | /v1/pocket-app/push | signed-in person |
POST | /v1/pocket-app/settings | signed-in person |
GET | /v1/pocket-app/state | signed-in person |
POST | /v1/pocket-app/takes | signed-in person |
GET | /v1/pocket-app/takes/{id} | signed-in person |
POST | /v1/pocket-app/takes/{id}/archive | signed-in person |
POST | /v1/pocket-app/takes/{id}/change | signed-in person |
GET | /v1/pocket-app/takes/{id}/clip | signed-in person |
POST | /v1/pocket-app/takes/{id}/discard | signed-in person |
POST | /v1/pocket-app/takes/{id}/files | signed-in person |
GET | /v1/pocket-app/takes/{id}/files/{fileId} | signed-in person |
PUT | /v1/pocket-app/takes/{id}/files/{fileId} | signed-in person |
POST | /v1/pocket-app/takes/{id}/files/{fileId}/delete | signed-in person |
POST | /v1/pocket-app/takes/{id}/make | signed-in person |
POST | /v1/pocket-app/takes/{id}/note | signed-in person |
POST | /v1/pocket-app/takes/{id}/post | signed-in person |
POST | /v1/pocket-app/takes/{id}/preview | signed-in person |
POST | /v1/pocket-app/takes/{id}/reopen | signed-in person |
POST | /v1/pocket-app/takes/{id}/text | signed-in person |
POST | /v1/pocket-app/takes/{id}/unarchive | signed-in person |
POST | /v1/pocket-app/transcribe | signed-in person |
POST | /v1/pocket-app/unpair | signed-in person |
PATCH | /v1/pocket/{id}/devices/{deviceId} | signed-in person |
POST | /v1/pocket/{id}/devices/{deviceId}/delete | signed-in person |
POST | /v1/pocket/{id}/interview | signed-in person |
POST | /v1/pocket/{id}/pair | signed-in person |
GET | /v1/ready | signed-in person |
GET | /v1/referrals/resolve | signed-in person |
POST | /v1/renders/buy | signed-in person |
POST | /v1/renders/drop | signed-in person |
POST | /v1/renders/keep | signed-in person |
GET | /v1/schedule-files/{tenantId} | signed-in person |
POST | /v1/staff-access/leave | signed-in person |
PATCH | /v1/staff-access/member-profile | signed-in person |
POST | /v1/storage/split | signed-in person |
POST | /v1/streams/{id}/test | signed-in person |
POST | /v1/stripe/webhook | signed-in person |
POST | /v1/team/leave | signed-in person |
GET | /v1/team/markets | signed-in person |
POST | /v1/team/markets | signed-in person |
POST | /v1/team/name | signed-in person |
GET | /v1/team/staff-access | signed-in person |
POST | /v1/team/staff-access | signed-in person |
POST | /v1/templates/sync | signed-in person |
POST | /v1/upload-files | signed-in person |
GET | /v1/version | signed-in person |
POST | /v1/webhook/secret | signed-in person |
POST | /v1/webhook/secret/reveal | signed-in person |
GET | /v1/whoami | signed-in person |
POST | /v1/zernio/webhook | signed-in person |