Public reference

Field

Every endpoint in this group. Open one for its parameters and a worked example.

51 Endpoints

View as Markdown

Field

51

PATCH /api/v1/field/appointments/{id} Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/appointments/{id}/cancel Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/areas

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch prm_field_config

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/areas Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/field/areas/{id} Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PATCH /api/v1/field/areas/{id} Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/board Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/checklist-templates Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/checklist-templates Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/field/checklist-templates/{id} Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PATCH /api/v1/field/checklist-templates/{id} Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/context

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch prm_field_config

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/jobs

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/jobs Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/jobs/counts

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/jobs/{id}

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PATCH /api/v1/field/jobs/{id} Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/jobs/{id}/appointments Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/jobs/{id}/assign Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/jobs/{id}/cancel Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/jobs/{id}/check-in

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PUT /api/v1/field/jobs/{id}/checklist/{itemId}

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/jobs/{id}/complete

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/jobs/{id}/en-route

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/jobs/{id}/photos

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/field/jobs/{id}/photos/{photoId}

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/jobs/{id}/photos/{photoId}

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/leads Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/leads Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/field/leads/{id} Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/leads/{id} Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PATCH /api/v1/field/leads/{id} Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/leads/{id}/convert Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/leads/{id}/link-user Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/leads/{id}/stage Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/settings Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PATCH /api/v1/field/settings Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/slot-overrides

Authentication: Staff token or session
Requires any one of: prm_field_dispatch prm_field_config

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PUT /api/v1/field/slot-overrides Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/field/slot-overrides/{windowId}/{date} Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/slot-windows

Authentication: Staff token or session
Requires any one of: prm_field_dispatch prm_field_config

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/slot-windows Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/field/slot-windows/{id} Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PUT /api/v1/field/slot-windows/{id} Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/slots

Authentication: Staff token or session
Requires any one of: prm_field_dispatch prm_field_config

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/teams

Authentication: Staff token or session
Requires any one of: prm_field_jobs prm_field_dispatch prm_field_config

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

POST /api/v1/field/teams Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

DELETE /api/v1/field/teams/{id} Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PATCH /api/v1/field/teams/{id} Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

PUT /api/v1/field/teams/{id}/members Manage field areas, crews, slots & checklists prm_field_config

Authentication: Staff token or session
Requires permission: prm_field_config Manage field areas, crews, slots & checklists
Rate limit: t_mutate

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

GET /api/v1/field/techs Dispatch field jobs, leads & appointments prm_field_dispatch

Authentication: Staff token or session
Requires permission: prm_field_dispatch Dispatch field jobs, leads & appointments

Read straight from the router that serves this instance. A hand-written description of this endpoint has not been added yet.

Open the full reference

Written to be read by machines too

The reference is public and needs no account, so a tool that has never seen X-Radius can reach a correct first call on its own.

/llms.txt: An index of every page, with one-line summaries.
/llms-full.txt: The whole reference as one Markdown file, with no navigation to crawl.
/openapi.json: OpenAPI 3.1, generated from the router that serves this instance.
/skill.md: A ready-made skill file for an assistant: authentication, the response envelope and the error codes in one page.
<page-url>.md: Append .md to any reference URL for the same page as Markdown.
Accept: text/markdown: Send this header on the ordinary URL and the answer comes back as Markdown instead.

Hand this to your assistant

Read https://x-radius.com/llms.txt, then fetch the endpoint you need as Markdown by appending .md to its URL.

Try it on your own network.

5000 subscribers for 90 days. You pay nothing.

Try it free Talk to us