# Field - X-Radius API > Base URL: https://x-radius.com/api/v1 > Auth: Authorization: Bearer xrt_... (a manager API token) > Envelope: {"data": ...}; lists add {"meta":{page,page_size,total,has_next}} > Errors: {"error":{"code","message","request_id"}} - branch on code, never on message > Timestamps: yyyy-MM-dd HH:mm:ss, UTC > Money: a bare JSON number in major units, with an ISO-4217 currency code beside it > Idempotency: redeem and activate endpoints take a client-supplied request_id (UUID) > > This page: https://x-radius.com/docs/api/field > Every group: https://x-radius.com/llms.txt 51 endpoints in 1 resource groups. 0 carry a hand-written reference entry with examples; the remaining 51 are generated from the running router and carry method, path, authentication, permission and rate-limit bucket, but no request or response example. ### Dispatch field jobs, leads & appointments `PATCH /api/v1/field/appointments/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `POST /api/v1/field/appointments/{id}/cancel` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### GET /api/v1/field/areas `GET /api/v1/field/areas` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch`, `prm_field_config` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `POST /api/v1/field/areas` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `DELETE /api/v1/field/areas/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `PATCH /api/v1/field/areas/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `GET /api/v1/field/board` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `GET /api/v1/field/checklist-templates` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `POST /api/v1/field/checklist-templates` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `DELETE /api/v1/field/checklist-templates/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `PATCH /api/v1/field/checklist-templates/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### GET /api/v1/field/context `GET /api/v1/field/context` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch`, `prm_field_config` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### GET /api/v1/field/jobs `GET /api/v1/field/jobs` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `POST /api/v1/field/jobs` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### GET /api/v1/field/jobs/counts `GET /api/v1/field/jobs/counts` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### GET /api/v1/field/jobs/{id} `GET /api/v1/field/jobs/{id}` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `PATCH /api/v1/field/jobs/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `POST /api/v1/field/jobs/{id}/appointments` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `POST /api/v1/field/jobs/{id}/assign` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `POST /api/v1/field/jobs/{id}/cancel` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### POST /api/v1/field/jobs/{id}/check-in `POST /api/v1/field/jobs/{id}/check-in` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch` - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### PUT /api/v1/field/jobs/{id}/checklist/{itemId} `PUT /api/v1/field/jobs/{id}/checklist/{itemId}` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch` - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### POST /api/v1/field/jobs/{id}/complete `POST /api/v1/field/jobs/{id}/complete` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch` - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### POST /api/v1/field/jobs/{id}/en-route `POST /api/v1/field/jobs/{id}/en-route` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch` - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### POST /api/v1/field/jobs/{id}/photos `POST /api/v1/field/jobs/{id}/photos` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch` - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### DELETE /api/v1/field/jobs/{id}/photos/{photoId} `DELETE /api/v1/field/jobs/{id}/photos/{photoId}` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch` - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### GET /api/v1/field/jobs/{id}/photos/{photoId} `GET /api/v1/field/jobs/{id}/photos/{photoId}` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `GET /api/v1/field/leads` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `POST /api/v1/field/leads` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `DELETE /api/v1/field/leads/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `GET /api/v1/field/leads/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `PATCH /api/v1/field/leads/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `POST /api/v1/field/leads/{id}/convert` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `POST /api/v1/field/leads/{id}/link-user` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `POST /api/v1/field/leads/{id}/stage` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `GET /api/v1/field/settings` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `PATCH /api/v1/field/settings` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### GET /api/v1/field/slot-overrides `GET /api/v1/field/slot-overrides` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_dispatch`, `prm_field_config` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `PUT /api/v1/field/slot-overrides` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `DELETE /api/v1/field/slot-overrides/{windowId}/{date}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### GET /api/v1/field/slot-windows `GET /api/v1/field/slot-windows` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_dispatch`, `prm_field_config` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `POST /api/v1/field/slot-windows` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `DELETE /api/v1/field/slot-windows/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `PUT /api/v1/field/slot-windows/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### GET /api/v1/field/slots `GET /api/v1/field/slots` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_dispatch`, `prm_field_config` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### GET /api/v1/field/teams `GET /api/v1/field/teams` - Authentication: manager session (JWT) or API token - Permission: any one of `prm_field_jobs`, `prm_field_dispatch`, `prm_field_config` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `POST /api/v1/field/teams` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `DELETE /api/v1/field/teams/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `PATCH /api/v1/field/teams/{id}` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Manage field areas, crews, slots & checklists `PUT /api/v1/field/teams/{id}/members` - Authentication: manager session (JWT) or API token - Permission: `prm_field_config` (Manage field areas, crews, slots & checklists) - Risk: danger - Rate limit bucket: `t_mutate` _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._ ### Dispatch field jobs, leads & appointments `GET /api/v1/field/techs` - Authentication: manager session (JWT) or API token - Permission: `prm_field_dispatch` (Dispatch field jobs, leads & appointments) - Risk: write _This endpoint has no hand-written reference entry yet. The method, path, authentication, permission and rate limit above are generated from the running router and are accurate; there is no request or response example._