Telstra Field Workforce Partners API Operations API

openapi: 3.2.0
info:
  title: Field Workforce Partners API Operations API
  description: '# Introduction


    The WFM Partner Gateway application exposes Field Workforce Partners API to allow partners to interact with the Telstra workforce management ecosystem. The application supports two types of partners:


    Inbound Partners (partner organisations which need Telstra WFM technicians to complete their field activities)


    Outbound Partners (partner organisations which provide workforce capacity to Telstra to supplement its internal workforce if needed by working on Telstra tasks)


    Each partner will be assigned a PartnerID value to use in the API operation requests, with partners expected to support mTLS/oauth integration with static source IP/IP ranges which need to be whitelisted by Telstra. # Version Control

    **Version** | **Date** | **Change Summary**

    ------------|----------------|----------------------

    1.0.0 | 05-02-2025 | FSIT-2883 - Initial swagger and added create new Partner API. 1.1.0 | 17-02-2025 | FSIT-3177 - Added update partner API

    1.2.0 | 04-03-2025 | FSIT-3666 - Added retrieve task list API

    1.3.0 | 11-03-2025 | APT-12769 - Added Reference Data - Retrieve API

    1.4.0 | 26-03-2025 | FSIT-3983 - Added Task - Update API

    1.5.0 | 22-04-2025 | FSIT-4368 - Added Task - Retrieve API

    1.6.0 | 05-08-2025 | FSIT-5071 - Added Partner - Retrieve API

    1.7.0 | 09-03-2026 | FSIT-11310 - Added Query Available Slots API

    1.8.0 | 12-03-2026 | FSIT-11310 - Added Reserve Appointment API

    1.9.0 | 13-03-2026 | FSIT-11310 - Added Cancel Appointment API

    2.0.0 | 13-03-2026 | FSIT-11310 - Added Reschedule Appointment API

    2.1.0 | 25-03-2026 | FSIT-11340 - Added Retrieve Appointment API

    2.1.1 | 30-03-2026 | FSIT-11322 - Added Update Appointment API

    2.1.2 | 01-04-2026 | FSIT-12352, FSIT-12345, FSIT-12339 - Updated Create, Update and Retrieve Partner APIs to support inbound partners. 2.1.3 | 13-04-2026 | FSIT-12723 - Added Retrieve Service Offerings API

    0.22.0 | 09-06-2026 | Benn: MyAPI cat1 compliance updates: version number to 0.22.0, base path to v0, namespace change, API name changed


    # Features


    The Field Workforce Partners API provides the following features:

    | Feature | Description |

    |---|---|

    |`Partner - Create` | This API operation can be used to create a new partner record in the WFM Partner Gateway. It will only be available to API consumers in the ADMIN category (ie a partner cannot create another partner).|

    |`Partner - Update` | This API operation can be used to update selected attributes of the partner record.|

    |`Partner - Retrieve` | This API operation can be used to retrieve partner record in the WFM Partner Gateway. Partner details in the system are private and can only be accessed by the respective partner and the ADMIN.|

    |`Task List - Retrieve`| This API operation will support the outbound partner to perform a retrieval of a summary task listing with selected query criteria supported based on the data within the WFM Partner Gateway system.|

    |`Reference Data - Retrieve`| This API operation will support the partner to retrieve the current reference data options supported in the WFM Partner Gateway at the point in time. This will support the partner to provide only valid reasons/options when updating the tasks.|

    |`Task - Update`| This API operation is used to action update events against the task. It will be used by the outbound partner to manage the tasks which they have been assigned, supporting use cases like accepting tasks, completing tasks etc.|

    |`Task - Retrieve`| This API operation will support an outbound partner to retrieve the details of a particular task and provide the low level details needed to support the partner to complete the task. Details returned will include the customer details, site contacts, jobs required, notes and other elements of the task.|

    |`Appointment - Query Available Slots`| This API operation can be used by inbound partners to query workforce availability. A list of available slots based on the request attributes will be returned.'
  version: 0.22.0
servers:
- url: https://prod.okapi.ogw.evolve.okapi.telstra.com/field-workforce-partners/v0
  description: (PARTNER USE - Production)
tags:


# --- truncated at 32 KB (251 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/telstra/refs/heads/main/openapi/telstra-field-workforce-partners-api-operations-api-openapi.yml