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
object
Type
string
Description
The type of object. Always staff.
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. null if not set.
Name
employmentType
Type
string
Description
The staff member's employment type (e.g. Full-time). null if not set.
Name
livemode
Type
boolean
Description
true if the object exists in live mode (returned by a ds_live_… key), false in test mode.

GET/v1/staff

List staff

Returns a list of the active staff in your organisation, ordered by name. The response is the standard list envelope wrapping an array of staff objects. Requires the read:users scope.

Optional attributes

Name
limit
Type
integer
Description
A limit on the number of objects to return, between 1 and 100. Defaults to 25.
Name
starting_after
Type
integer
Description
A cursor for pagination. Pass the id of the last staff member from the previous page to fetch the next page. Iterate while has_more is true.

Request

GET

/v1/staff

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

Response

{
  "object": "list",
  "url": "/v1/staff",
  "has_more": true,
  "data": [
    {
      "object": "staff",
      "id": 482,
      "ref": "f4b9c0a1e2d3…",
      "name": "Jordan Avery",
      "email": "jordan.avery@example.org",
      "position": "Support Worker",
      "employmentType": "Full-time",
      "livemode": true
    }
  ]
}