Staff

Staff are the people in your organisation. On this page you'll find the staff model and the endpoint for listing the active staff your key is allowed to see. Listing staff requires the read:users scope.

The staff model

The staff model contains the core profile details of a staff member in your organisation.

Properties

Name
id
Type
integer
Description
Unique identifier for the staff member within your organisation.
Name
ref
Type
string
Description
Stable reference for the staff member, safe to store on your side.
Name
name
Type
string
Description
The staff member's full name.
Name
email
Type
string
Description
The staff member's email address.
Name
position
Type
string
Description
The staff member's position or title, if set.
Name
employmentType
Type
string
Description
The staff member's employment type (e.g. Full-time), if set.

GET/v1/staff

List staff

Returns a paginated list of the active staff in your organisation, ordered by name. Requires the read:users scope.

Optional attributes

Name
page
Type
integer
Description
The page to return, starting at 1. Defaults to 1.
Name
pageSize
Type
integer
Description
The number of items per page (1–100). Defaults to 25.

Request

GET

/v1/staff

curl -G https://api.diversitysync.com/v1/staff \
  -H "Authorization: Bearer {access_token}" \
  -d pageSize=25

Response

{
  "page": 1,
  "pageSize": 25,
  "staff": [
    {
      "id": 482,
      "ref": "f4b9c0a1e2d3…",
      "name": "Jordan Avery",
      "email": "jordan.avery@example.org",
      "position": "Support Worker",
      "employmentType": "Full-time"
    }
  ]
}