Diversity Sync API
The Diversity Sync API lets you read data from your organisation — staff, participants, your roster, shift notes, and forms — programmatically, using a scoped API key you create in the admin panel. Every request is over HTTPS, authenticated with a bearer token, and scoped to your organisation and to the permissions of the staff member who created the key.
Getting started
To get started, create an API key in Admin → API Keys in your Diversity Sync workspace, choose the scopes it should carry, then exchange it for a short-lived access token and start making requests. The API is a curated, versioned surface under /v1 covering your organisation's directory data — staff, participants, sites, positions, and participant groups — as well as your roster, shift notes, and forms.
Resources
Staff
List the active staff in your organisation, with names, positions, and contact details.
Participants
List the participants you support, scoped to the access of the key’s staff member.
Sites
List the locations and programs your organisation operates.
Positions
List the staff position titles configured in your organisation.
Participant groups
List the participant groups your organisation has configured.
Shifts
Read your roster — list published shifts across a date range and retrieve a single shift.
Shift notes
List the shift note timeline — the contributions staff record against a participant.
Forms
List form and register templates, and read the submissions made against them.