Telstra · OpenAPI Overlay 1.0.0

API Evangelist agent overlay for Field Workforce Partners API

15 actions 15 updates update extends ../openapi/_original/telstra-field-workforce-partners-api-openapi.json
Generated by API Evangelist Written by API Evangelist tooling for Telstra's API. It is a proposal applied on top of the contract, not a document Telstra publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-agent-toolx-agent-read-onlyx-agent-destructivex-mcp-tool-namex-apievangelist

Targets 15

$.info
$.paths['/partner'].post
$.paths['/partner'].patch
$.paths['/partner'].get
$.paths['/task-list'].get
$.paths['/reference-data'].get
$.paths['/task'].patch
$.paths['/task-detail'].get
$.paths['/appointment/slot-enquiry'].post
$.paths['/appointment/reservation'].post
$.paths['/appointment'].delete
$.paths['/appointment'].patch
$.paths['/appointment'].get
$.paths['/appointment/reschedule'].post
$.paths['/service-offerings'].get

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist agent overlay for Field Workforce Partners API
  version: 1.0.0
extends: ../openapi/_original/telstra-field-workforce-partners-api-openapi.json
x-generated: '2026-10-20'
x-method: generated
x-source: openapi/telstra-field-workforce-partners-api-openapi.yml
x-rationale: Adds agent-facing annotations (tool / read-only / destructive flags and candidate MCP tool names, matching mcp/telstra-mcp.yml)
  and provenance without mutating the original contract.
actions:
- target: $.info
  description: Record API Evangelist provenance for this contract.
  update:
    x-apievangelist:
      provider: telstra
      profiled: '2026-10-20'
      original: openapi/_original/telstra-field-workforce-partners-api-openapi.json
- target: $.paths['/partner'].post
  description: Agent annotations for Partner-Create.
  update:
    x-agent-tool: true
    x-agent-read-only: false
    x-agent-destructive: false
    x-mcp-tool-name: partner_create
- target: $.paths['/partner'].patch
  description: Agent annotations for Partner-Update.
  update:
    x-agent-tool: true
    x-agent-read-only: false
    x-agent-destructive: false
    x-mcp-tool-name: partner_update
- target: $.paths['/partner'].get
  description: Agent annotations for Partner-Retrieve.
  update:
    x-agent-tool: true
    x-agent-read-only: true
    x-agent-destructive: false
    x-mcp-tool-name: partner_retrieve
- target: $.paths['/task-list'].get
  description: Agent annotations for TaskList-Retrieve.
  update:
    x-agent-tool: true
    x-agent-read-only: true
    x-agent-destructive: false
    x-mcp-tool-name: task_list_retrieve
- target: $.paths['/reference-data'].get
  description: Agent annotations for ReferenceData-Retrieve.
  update:
    x-agent-tool: true
    x-agent-read-only: true
    x-agent-destructive: false
    x-mcp-tool-name: reference_data_retrieve
- target: $.paths['/task'].patch
  description: Agent annotations for Task-Update.
  update:
    x-agent-tool: true
    x-agent-read-only: false
    x-agent-destructive: false
    x-mcp-tool-name: task_update
- target: $.paths['/task-detail'].get
  description: Agent annotations for Task-Retrieve.
  update:
    x-agent-tool: true
    x-agent-read-only: true
    x-agent-destructive: false
    x-mcp-tool-name: task_retrieve
- target: $.paths['/appointment/slot-enquiry'].post
  description: Agent annotations for Appointment-QueryAvailableSlots.
  update:
    x-agent-tool: true
    x-agent-read-only: false
    x-agent-destructive: false
    x-mcp-tool-name: appointment_query_available_slots
- target: $.paths['/appointment/reservation'].post
  description: Agent annotations for Appointment-Reserve.
  update:
    x-agent-tool: true
    x-agent-read-only: false
    x-agent-destructive: false
    x-mcp-tool-name: appointment_reserve
- target: $.paths['/appointment'].delete
  description: Agent annotations for Appointment-Cancel.
  update:
    x-agent-tool: true
    x-agent-read-only: false
    x-agent-destructive: true
    x-mcp-tool-name: appointment_cancel
- target: $.paths['/appointment'].patch
  description: Agent annotations for Appointment-Update.
  update:
    x-agent-tool: true
    x-agent-read-only: false
    x-agent-destructive: false
    x-mcp-tool-name: appointment_update
- target: $.paths['/appointment'].get
  description: Agent annotations for Appointment-Retrieve.
  update:
    x-agent-tool: true
    x-agent-read-only: true
    x-agent-destructive: false
    x-mcp-tool-name: appointment_retrieve
- target: $.paths['/appointment/reschedule'].post
  description: Agent annotations for Appointment-Reschedule.
  update:
    x-agent-tool: true
    x-agent-read-only: false
    x-agent-destructive: false
    x-mcp-tool-name: appointment_reschedule
- target: $.paths['/service-offerings'].get
  description: Agent annotations for ServiceOfferings-Retrieve.
  update:
    x-agent-tool: true
    x-agent-read-only: true
    x-agent-destructive: false
    x-mcp-tool-name: service_offerings_retrieve

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay 
curl "https://apis.io/api/v1/overlays/telstra-field-workforce-partners-api-overlay"
All openapi overlays 
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.