# Supported calculated staff availability from an Addon Kit function **URL:** \ **Category:** API & SDK\ **Created:** [October 2, 2026, 8:07am UTC](https://community.servicem8.com/t/supported-calculated-staff-availability-from-an-addon-kit-function/1215 "2026-10-02T08:07:47Z")\ **Posts on this page:** 4\ **Page:** 1
**Author:** ![admin\_team](https://avatars.discourse-cdn.com/v4/letter/a/85e7bf/32.png) [@admin\_team](https://community.servicem8.com/u/admin_team)\ **Post date:** [October 2, 2026, 8:07am UTC](https://community.servicem8.com/t/supported-calculated-staff-availability-from-an-addon-kit-function/1215/1 "2026-10-02T08:07:47Z")
Hi, we need help with supported calculated staff availability from an Addon Kit function. We are building a private, read-only ServiceM8 Addon Kit job action. We need calculated free windows for selected staff over a same-day Australia/Sydney interval, considering business hours, staff hours, leave and booked activities. We need unrounded windows and must not ignore existing bookings. The ServiceM8 ChatGPT get\_availability tool supports this operation, but we have not found a documented equivalent for an Addon Kit function. The REST availability.json endpoint describes Availability records rather than the calculated availability\_windows result. Please confirm the supported endpoint, request and response schema, required scopes and authentication method for this calculation from an Addon Kit function. Can event.auth.accessToken access it? If a separate OAuth grant is required, please provide the supported authorization and refresh flow. We will not reuse the ChatGPT connector credentials. Alternatively, please identify a complete documented API model for staff working hours, exceptions and leave so we can calculate equivalent windows ourselves. Account-wide opening hours alone are insufficient. Current scopes: read\_jobs, read\_customers, read\_schedule and read\_staff. The action will remain read-only and will not recommend allocations until verified. ServiceM8 Helpdesk directed us to this community for API and development questions. Any supported approach or documentation would be appreciated. Thank you. ---
**Author:** ![admin\_team](https://avatars.discourse-cdn.com/v4/letter/a/85e7bf/32.png) [@admin\_team](https://community.servicem8.com/u/admin_team)\ **Post date:** [October 2, 2026, 10:38am UTC](https://community.servicem8.com/t/supported-calculated-staff-availability-from-an-addon-kit-function/1215/2 "2026-10-02T10:38:43Z")
One related integration requirement: our building inspectors start from the home locations already saved in ServiceM8 under Staff \> Options \> Auto Route Home Address. We want to use those existing settings as the authoritative source, rather than ask staff to enter them again. We confirmed that this field is populated in the UI, but the corresponding staff resource returned through the ServiceM8 connector did not include an address/home field. The published staff schema describes lat/lng as current or last-known location, which is not the same as the saved home address. Is there a supported read-only API or Addon Kit operation to retrieve Auto Route Home Address? Please confirm the field/endpoint, required scope and authentication contract, or whether this setting is unavailable to add-ons. No actual home addresses or credentials are included here. ---
**Author:** ![Cody](https://sea2.discourse-cdn.com/flex002/user_avatar/community.servicem8.com/cody/32/52_2.png) [@Cody](https://community.servicem8.com/u/Cody)\ **Post date:** [October 5, 2026, 8:09am UTC](https://community.servicem8.com/t/supported-calculated-staff-availability-from-an-addon-kit-function/1215/3 "2026-10-05T08:09:40Z")
Hi Admin Team, There isn’t currently a supported public REST or Addon Kit endpoint for returning calculated staff availability windows, including unrounded free periods derived from working hours, leave, unavailability and existing bookings. The documented `read_schedule` scope covers JobActivity and JobAllocation resources, but not a calculated availability result. `event.auth.accessToken` can be used by a Lambda function to authenticate requests to ServiceM8 APIs within the OAuth scopes requested in the add-on manifest, and a new token is provided each time the function is invoked. However, there’s no supported calculated-availability endpoint for that token to access, and using a separate OAuth authorization or refresh flow wouldn’t expose one. We also can’t confirm the ChatGPT availability tool as an API contract available to Addon Kit functions. There also isn’t a complete documented API model for reproducing the calculation independently. In particular, Staff Leave records aren’t exposed as a supported, versioned REST resource, while `availability.json` isn’t a documented or officially supported endpoint. We therefore don’t recommend building against that endpoint or other internal availability methods. For now, we’d recommend not implementing this calculation until a supported availability API is published. Thanks, Cody ---
**Author:** ![Cody](https://sea2.discourse-cdn.com/flex002/user_avatar/community.servicem8.com/cody/32/52_2.png) [@Cody](https://community.servicem8.com/u/Cody)\ **Post date:** [October 5, 2026, 10:40am UTC](https://community.servicem8.com/t/supported-calculated-staff-availability-from-an-addon-kit-function/1215/4 "2026-10-05T10:40:32Z")
Hi admin\_team, Auto Route Home Address is currently documented as an Auto Routing setting configured under Account \> Settings \> Staff \> Edit \> Options, but we can’t confirm a published REST API field or Addon Kit operation for retrieving it. The documented Staff endpoint requires the `read_staff` scope, but its response schema doesn’t include Auto Route Home Address. Its `lat` and `lng` fields represent the staff member’s current or last-known location, as you noted. For Addon Kit Lambda functions, `event.auth.accessToken` can authenticate requests to ServiceM8 APIs covered by the OAuth scopes requested by the add-on. However, as there’s no documented operation for this setting, we can’t provide a supported endpoint, additional scope, or authentication contract for reading it. If read access to this setting is required for your integration, email the use case to [support@servicem8.com](mailto:support@servicem8.com) as a feature request. Thanks, Cody