Skip to main content
GET
Returns one row per person in your organisation, active or suspended, for a periodic access review. Agents and service accounts are left out. Wordsmith support members are included with is_support_member: true and seat_type: "support": each is a Wordsmith engineer who holds no role and can reach your data only through a support access grant your organisation approved. Each row lists the member’s roles, the teams they belong to, and direct_access: how many resources of each kind they hold a grant on individually, such as {"repository": 3, "session": 12}. It counts what they created and what was shared with them by name. Access they have through a team or a role is not counted there; see teams and the roles instead. last_active_at is the last time the member used Wordsmith as themselves, on any surface: the apps, Slack, Teams, email, an API key or a connected app. Wordsmith records it at most once an hour. It is null for a member who has not used Wordsmith since Wordsmith started recording it. inactive_since is when the inactivity policy counts their inactivity from. join_method is invite when the member accepted an invite, with who sent it and when. Otherwise it is other: they joined through single sign-on, SCIM, domain auto-join, Slack or Teams. Wordsmith counts direct_access in the background and stores the counts. Each member’s direct_access_counted_at says when theirs was counted, and direct_access_refreshed_at says when the last successful recount finished. A request starts a recount when the counts are over a day old, when the last recount failed, or when a member who joined since has none. direct_access_refreshing is true while one runs. direct_access_refresh_failed is true when the latest recount failed, so the counts are from the last successful one. Everything else in the review is read when you request it. incomplete_member_ids lists members without current counts: someone who just joined, or a member the last recount could not count. Their direct_access is null, not an empty count. Request the review again once direct_access_refreshing is false.

Inactivity policy

dormancy_policy is your organisation’s inactivity policy. When dormant_after_days is set, Wordsmith suspends each member in scope (all_members, or only members marked is_external) who has had no activity for that many days, once a day, and tells the members who can reactivate them. A member’s inactivity counts from the latest of their last activity, when they joined, when they were last reactivated, when an admin marked them external (for an external-only policy), and when the policy was last turned on or changed (enabled_at).

Authentication

Requires an API key, or an OAuth token with directory:admin. The caller must also be an organisation admin, or hold a role with the access review permission. directory:admin is never granted by default.

Response

Returns 200 with the review.

Errors