Field app
The field-operations platform: contacts, turf, canvassing, events and the people doing the work.
appLines of business274 operationsid app
How it sits
An app is already assembled from parts, with a face of its own. The counts and the links below are from the platform's spec and the other services' own descriptions.
| Operations | 274 GET 125 · POST 98 · DELETE 26 · PUT 21 · PATCH 4 |
| Resources | 33 |
| Leaned on by | Campaign |
| Leans on | none named |
| In recipes | A field team's turf pack; A post-event heat map |
What it can do
274 operations in 33 resources, as the spec declares them. Each row is one call; paths are relative to the part.
scout
| Method | Path | Does |
|---|---|---|
| POST | /api/scout/bridge/broadcast | Create bridge broadcast |
| GET | /api/scout/bridge/connection | Get bridge connection status |
| POST | /api/scout/bridge/publish | Create publish system message |
| POST | /api/scout/bridge/resolve | Create resolve address |
| POST | /api/scout/bridge/send | Create bridge send message |
| POST | /api/scout/bridge/start | Create start bridge service |
| GET | /api/scout/bridge/status | Get bridge status |
| POST | /api/scout/bridge/stop | Create stop bridge service |
| POST | /api/scout/dm/{user_id} | Get or create dm |
| POST | /api/scout/events/enable-mesh | Create enable mesh events |
| GET | /api/scout/events/status | Get events status |
| POST | /api/scout/mesh/query | Create mesh query |
| POST | /api/scout/mesh/request | Create mesh request |
| DELETE | /api/scout/messages/{message_id} | Delete message |
| PATCH | /api/scout/messages/{message_id} | Update edit message |
| GET | /api/scout/rooms | List rooms |
| POST | /api/scout/rooms | Create room |
| DELETE | /api/scout/rooms/{room_id} | Delete archive room |
| GET | /api/scout/rooms/{room_id} | Get room |
| PATCH | /api/scout/rooms/{room_id} | Update room |
| GET | /api/scout/rooms/{room_id}/members | List room members |
| POST | /api/scout/rooms/{room_id}/members | Add Room Member |
| DELETE | /api/scout/rooms/{room_id}/members/{user_id} | Delete remove room member |
| GET | /api/scout/rooms/{room_id}/messages | List messages |
| POST | /api/scout/rooms/{room_id}/messages | Create send message |
| GET | /api/scout/rooms/{room_id}/objects | List room objects |
| POST | /api/scout/rooms/{room_id}/read | Create mark room read |
| GET | /api/scout/system-rooms | List system rooms |
| POST | /api/scout/system-rooms/{system_type} | Get or create system room |
29 operations
walkbooks
| Method | Path | Does |
|---|---|---|
| GET | /api/walkbooks/ | List walkbooks |
| POST | /api/walkbooks/ | Create walkbook |
| GET | /api/walkbooks/my-assignments | Get my assignments |
| POST | /api/walkbooks/sync | Create sync walkbook actions |
| GET | /api/walkbooks/sync/{sync_id} | Get sync details |
| DELETE | /api/walkbooks/{walkbook_id} | Delete walkbook |
| GET | /api/walkbooks/{walkbook_id} | Get walkbook |
| PUT | /api/walkbooks/{walkbook_id} | Update walkbook |
| GET | /api/walkbooks/{walkbook_id}/actions | Get walkbook actions |
| GET | /api/walkbooks/{walkbook_id}/actions/since | Get actions since |
| GET | /api/walkbooks/{walkbook_id}/assignments | List assignments |
| POST | /api/walkbooks/{walkbook_id}/assignments | Create assignment |
| DELETE | /api/walkbooks/{walkbook_id}/assignments/{assignment_id} | Delete assignment |
| PUT | /api/walkbooks/{walkbook_id}/assignments/{assignment_id} | Update Assignment |
| POST | /api/walkbooks/{walkbook_id}/assignments/{assignment_id}/force-release | Create force release checkout |
| POST | /api/walkbooks/{walkbook_id}/checkin | Create checkin walkbook |
| POST | /api/walkbooks/{walkbook_id}/checkout | Create checkout walkbook |
| GET | /api/walkbooks/{walkbook_id}/download | Get download walkbook |
| POST | /api/walkbooks/{walkbook_id}/export | Create export walkbook |
| POST | /api/walkbooks/{walkbook_id}/refresh-count | Create refresh walkbook count |
| GET | /api/walkbooks/{walkbook_id}/stats | Get walkbook stats |
| GET | /api/walkbooks/{walkbook_id}/status | Get walkbook status |
| GET | /api/walkbooks/{walkbook_id}/sync-history | Get sync history |
23 operations
communications
| Method | Path | Does |
|---|---|---|
| GET | /api/communications/ | List communications |
| POST | /api/communications/ | Create communication |
| GET | /api/communications/batches | List batches |
| GET | /api/communications/batches/{batch_id} | Get batch |
| GET | /api/communications/queue/pending | Get pending queue |
| GET | /api/communications/queue/stats | Get queue stats |
| POST | /api/communications/send | Create send communication |
| POST | /api/communications/send-to-event | Create send to event |
| POST | /api/communications/send-to-segment | Create send to segment |
| GET | /api/communications/stats/summary | Get communication stats |
| GET | /api/communications/templates/ | List templates |
| POST | /api/communications/templates/ | Create template |
| DELETE | /api/communications/templates/{template_id} | Delete template |
| GET | /api/communications/templates/{template_id} | Get template |
| PUT | /api/communications/templates/{template_id} | Update template |
| POST | /api/communications/templates/{template_id}/render | Create render template |
| DELETE | /api/communications/{communication_id} | Delete communication |
| GET | /api/communications/{communication_id} | Get communication |
| PUT | /api/communications/{communication_id} | Update communication |
| POST | /api/communications/{communication_id}/cancel | Create cancel communication |
| POST | /api/communications/{communication_id}/queue | Create queue communication |
21 operations
events
| Method | Path | Does |
|---|---|---|
| GET | /api/events/ | List events |
| POST | /api/events/ | Create event |
| DELETE | /api/events/{event_id} | Delete event |
| GET | /api/events/{event_id} | Get event |
| PUT | /api/events/{event_id} | Update event |
| DELETE | /api/events/{event_id}/page | Delete event page |
| GET | /api/events/{event_id}/page | Get event page |
| POST | /api/events/{event_id}/page | Create event page |
| PUT | /api/events/{event_id}/page | Update event page |
| GET | /api/events/{event_id}/page/attachments | List attachments |
| POST | /api/events/{event_id}/page/attachments | Upload Attachment |
| DELETE | /api/events/{event_id}/page/attachments/{attachment_id} | Delete attachment |
| GET | /api/events/{event_id}/page/attachments/{attachment_id} | Get Attachment |
| POST | /api/events/{event_id}/page/attachments/{attachment_id}/retry | Create retry attachment analysis |
| POST | /api/events/{event_id}/page/preview-token | Create regenerate preview token |
| GET | /api/events/{event_id}/page/registrations | List page registrations |
| PUT | /api/events/{event_id}/page/status | Update event page status |
| POST | /api/events/{event_id}/registrations | Create register for event |
| DELETE | /api/events/{event_id}/registrations/{registration_id} | Delete cancel registration |
| PUT | /api/events/{event_id}/registrations/{registration_id} | Update registration |
20 operations
surveys
| Method | Path | Does |
|---|---|---|
| GET | /api/surveys/ | List surveys |
| POST | /api/surveys/ | Create survey |
| GET | /api/surveys/health | Get check yasp health |
| POST | /api/surveys/responses | Create submit response |
| GET | /api/surveys/segment/{segment_id} | Get segment surveys |
| POST | /api/surveys/segment/{segment_id} | Create link survey to segment |
| DELETE | /api/surveys/segment/{segment_id}/{survey_id} | Delete unlink survey from segment |
| PUT | /api/surveys/segment/{segment_id}/{survey_id} | Update segment survey link |
| GET | /api/surveys/{survey_id} | Get survey |
| PUT | /api/surveys/{survey_id} | Update survey |
| POST | /api/surveys/{survey_id}/archive | Create archive survey |
| POST | /api/surveys/{survey_id}/pause | Create pause survey |
| POST | /api/surveys/{survey_id}/publish | Create publish survey |
| POST | /api/surveys/{survey_id}/questions | Create add question |
| DELETE | /api/surveys/{survey_id}/questions/{question_id} | Delete question |
| PUT | /api/surveys/{survey_id}/questions/{question_id} | Update question |
| POST | /api/surveys/{survey_id}/resume | Create resume survey |
17 operations
files
| Method | Path | Does |
|---|---|---|
| POST | /api/files/admin/ensure-bucket | Create ensure bucket |
| POST | /api/files/admin/user-folder | Create user folder |
| GET | /api/files/admin/user-folders | List user folders |
| GET | /api/files/download/{path} | Get download file |
| POST | /api/files/folder | Create folder |
| GET | /api/files/health | Get check files health |
| GET | /api/files/info/{path} | Get file info |
| GET | /api/files/list | List folder |
| GET | /api/files/roots | Get accessible roots |
| POST | /api/files/signed-url/{path} | Get signed url |
| POST | /api/files/upload | Create upload file |
| DELETE | /api/files/{path} | Delete file |
12 operations
list-loader
| Method | Path | Does |
|---|---|---|
| GET | /api/list-loader/history | Get history |
| POST | /api/list-loader/upload | Create upload file |
| POST | /api/list-loader/{job_id}/analyze | Create analyze mappings |
| POST | /api/list-loader/{job_id}/execute | Create execute import |
| GET | /api/list-loader/{job_id}/files | List job files |
| GET | /api/list-loader/{job_id}/mappings | Get mappings |
| PUT | /api/list-loader/{job_id}/mappings | Update mappings |
| GET | /api/list-loader/{job_id}/preview | Get preview |
| POST | /api/list-loader/{job_id}/select-worksheet | Create select worksheet |
| GET | /api/list-loader/{job_id}/status | Get status |
| POST | /api/list-loader/{job_id}/validate | Create validate data |
| GET | /api/list-loader/{job_id}/worksheets | Get worksheets |
12 operations
tags
| Method | Path | Does |
|---|---|---|
| GET | /api/tags/ | List tags |
| POST | /api/tags/ | Create tag |
| GET | /api/tags/for/{record_type}/{record_id} | Get tags for record |
| POST | /api/tags/for/{record_type}/{record_id} | Create add tags to record |
| DELETE | /api/tags/for/{record_type}/{record_id}/{tag_id} | Delete remove tag from record |
| GET | /api/tags/hierarchy | Get tag hierarchy |
| GET | /api/tags/search | Get search tags |
| GET | /api/tags/stats/usage | Get tag usage stats |
| DELETE | /api/tags/{tag_id} | Delete tag |
| GET | /api/tags/{tag_id} | Get tag |
| PUT | /api/tags/{tag_id} | Update tag |
| GET | /api/tags/{tag_id}/records | Get records with tag |
12 operations
segments
| Method | Path | Does |
|---|---|---|
| GET | /api/segments/ | List segments |
| POST | /api/segments/ | Create segment |
| DELETE | /api/segments/{segment_id} | Delete segment |
| GET | /api/segments/{segment_id} | Get segment |
| PUT | /api/segments/{segment_id} | Update segment |
| POST | /api/segments/{segment_id}/execute | Create execute segment |
| GET | /api/segments/{segment_id}/geojson | Get segment geojson |
| GET | /api/segments/{segment_id}/persons | Get segment persons |
| POST | /api/segments/{segment_id}/persons/bulk | Create bulk add persons to segment |
| DELETE | /api/segments/{segment_id}/persons/{person_id} | Delete remove person from segment |
| POST | /api/segments/{segment_id}/persons/{person_id} | Create add person to segment |
11 operations
intel
| Method | Path | Does |
|---|---|---|
| GET | /api/intel/briefing | Get briefing |
| POST | /api/intel/crawl | Create start crawl |
| POST | /api/intel/fetch | Create fetch url |
| GET | /api/intel/health | Get health check |
| GET | /api/intel/jobs | List jobs |
| GET | /api/intel/jobs/{job_id} | Get job |
| POST | /api/intel/jobs/{job_id}/cancel | Create cancel job |
| POST | /api/intel/jobs/{job_id}/poll | Create poll job |
| POST | /api/intel/search | Create start search |
| POST | /api/intel/transcript | Create fetch transcript |
10 operations
auth
| Method | Path | Does |
|---|---|---|
| GET | /api/auth/me | Get read users me |
| GET | /api/auth/osm/callback | Get osm callback |
| POST | /api/auth/osm/link | Create link osm account |
| GET | /api/auth/osm/link-callback | Get osm link callback |
| GET | /api/auth/osm/login | Get osm login |
| GET | /api/auth/osm/status | Get osm status |
| DELETE | /api/auth/osm/unlink | Delete unlink osm account |
| POST | /api/auth/token | Create login for access token |
8 operations
integrations
| Method | Path | Does |
|---|---|---|
| GET | /api/integrations/ | List integrations |
| POST | /api/integrations/typeform/seed-tags | Create seed typeform tags |
| GET | /api/integrations/typeform/status | Get typeform status |
| POST | /api/integrations/typeform/sync | Create sync typeform |
| GET | /api/integrations/{integration} | Get integration |
| POST | /api/integrations/{integration}/test | Create test integration |
| DELETE | /api/integrations/{integration}/{key} | Delete reset setting |
| PUT | /api/integrations/{integration}/{key} | Update setting |
8 operations
persons
| Method | Path | Does |
|---|---|---|
| GET | /api/persons/ | List persons |
| POST | /api/persons/ | Create person |
| POST | /api/persons/batch | Create batch import persons |
| POST | /api/persons/bulk-import | Create bulk import csv |
| GET | /api/persons/search/semantic | Get semantic search persons |
| DELETE | /api/persons/{person_id} | Delete person |
| GET | /api/persons/{person_id} | Get person |
| PUT | /api/persons/{person_id} | Update person |
8 operations
work-queue
| Method | Path | Does |
|---|---|---|
| GET | /api/work-queue/action-types | Get action types |
| GET | /api/work-queue/all-queues | Get all queues |
| GET | /api/work-queue/my-assignments | Get my assignments |
| GET | /api/work-queue/stats/today | Get today stats |
| GET | /api/work-queue/{assignment_id}/next | Get next contact |
| POST | /api/work-queue/{queue_item_id}/action | Create log action |
| POST | /api/work-queue/{queue_item_id}/complete | Create complete item |
| POST | /api/work-queue/{queue_item_id}/skip | Create skip item |
8 operations
assignments
| Method | Path | Does |
|---|---|---|
| GET | /api/assignments | List assignments |
| POST | /api/assignments | Create assignment |
| GET | /api/assignments/user/{user_id} | Get user assignments |
| DELETE | /api/assignments/{assignment_id} | Delete assignment |
| GET | /api/assignments/{assignment_id} | Get assignment |
| PUT | /api/assignments/{assignment_id} | Update assignment |
| POST | /api/assignments/{assignment_id}/populate | Create populate work queue |
7 operations
i360
| Method | Path | Does |
|---|---|---|
| GET | /api/i360/filters | Get filter options |
| GET | /api/i360/geojson | Get all voters geojson |
| POST | /api/i360/import | Create import voters to audience |
| POST | /api/i360/save-as-segment | Create save search as segment |
| GET | /api/i360/search | Get search voters |
| GET | /api/i360/stats | Get search stats |
| GET | /api/i360/voter/{svid} | Get voter detail |
7 operations
users
| Method | Path | Does |
|---|---|---|
| GET | /api/users/ | List users |
| POST | /api/users/ | Create user |
| DELETE | /api/users/{user_id} | Delete user |
| GET | /api/users/{user_id} | Get user |
| PUT | /api/users/{user_id} | Update user |
| POST | /api/users/{user_id}/password | Create change password |
| POST | /api/users/{user_id}/toggle-active | Create toggle user active status |
7 operations
embeddings
| Method | Path | Does |
|---|---|---|
| POST | /api/embeddings/cache/clear | Create clear cache |
| GET | /api/embeddings/cache/stats | Get cache stats |
| POST | /api/embeddings/embed | Create embedding |
| POST | /api/embeddings/embed/batch | Create batch embeddings |
| GET | /api/embeddings/models | List ollama models |
| GET | /api/embeddings/stats | Get embedding stats |
6 operations
goals
| Method | Path | Does |
|---|---|---|
| GET | /api/goals/ | List goals |
| POST | /api/goals/ | Create goal |
| GET | /api/goals/stats | Get goal stats |
| DELETE | /api/goals/{goal_id} | Delete goal |
| GET | /api/goals/{goal_id} | Get goal |
| PUT | /api/goals/{goal_id} | Update goal |
6 operations
patches
| Method | Path | Does |
|---|---|---|
| GET | /api/patches/ | List patches |
| GET | /api/patches/persons/{person_id} | Get person patches |
| POST | /api/patches/persons/{person_id} | Create patches |
| GET | /api/patches/stats | Get patch stats |
| PATCH | /api/patches/{patch_id} | Update review patch |
| POST | /api/patches/{patch_id}/apply | Create apply patch |
6 operations
branding
| Method | Path | Does |
|---|---|---|
| GET | /api/branding/ | Get branding |
| PUT | /api/branding/ | Update branding |
| DELETE | /api/branding/logo/{logo_type} | Delete logo |
| POST | /api/branding/logo/{logo_type} | Create upload logo |
| GET | /api/branding/logos | List logos |
5 operations
cb-chat
| Method | Path | Does |
|---|---|---|
| GET | /api/cb-chat/datasets | Get datasets |
| GET | /api/cb-chat/health | Get chat health |
| POST | /api/cb-chat/message | Create chat message |
| GET | /api/cb-chat/suggestions | Get suggestions |
| GET | /api/cb-chat/warmup | Get chat warmup |
5 operations
conversations
| Method | Path | Does |
|---|---|---|
| GET | /api/conversations | List conversations |
| GET | /api/conversations/shared/{share_id} | Get shared conversation |
| DELETE | /api/conversations/{conversation_id} | Delete archive conversation |
| GET | /api/conversations/{conversation_id} | Get conversation |
| PATCH | /api/conversations/{conversation_id} | Update conversation |
5 operations
chat
| Method | Path | Does |
|---|---|---|
| GET | /api/chat/health | Get chat health check |
| POST | /api/chat/query | Create process chat query |
| POST | /api/chat/reload | Create reload chat system |
| GET | /api/chat/workflows | List workflows |
4 operations
hello-page
| Method | Path | Does |
|---|---|---|
| GET | /api/hello-page/config | Get hello page config |
| PUT | /api/hello-page/config | Update hello page config |
| POST | /api/hello-page/config/reset | Create reset hello page config |
| GET | /api/hello-page/templates | List hello page templates |
4 operations
interactions
| Method | Path | Does |
|---|---|---|
| GET | /api/interactions/persons/{person_id} | Get person interactions |
| POST | /api/interactions/persons/{person_id} | Create interaction |
| GET | /api/interactions/persons/{person_id}/summary | Get person interaction summary |
3 operations
exports
| Method | Path | Does |
|---|---|---|
| GET | /api/exports/persons | Get export persons |
| GET | /api/exports/segments/{segment_id} | Get export segment |
2 operations
health
| Method | Path | Does |
|---|---|---|
| GET | /health | Basic health check |
| GET | /health/detailed | Detailed health check |
2 operations
public
| Method | Path | Does |
|---|---|---|
| GET | /api/public/events/{slug} | Get public event page |
| POST | /api/public/events/{slug}/register | Create register for event |
2 operations
api
| Method | Path | Does |
|---|---|---|
| GET | /api | Api Root |
1 operation
prime
| Method | Path | Does |
|---|---|---|
| GET | /prime | Prime application caches |
1 operation
protected
| Method | Path | Does |
|---|---|---|
| GET | /api/protected | Protected Route |
1 operation
status
| Method | Path | Does |
|---|---|---|
| GET | /status | Service status overview |
1 operation
All the partsLines of businessThe platform's own id for this service is cbapp.
forge-catalog.json, generated Oct 30, 2026