Skip to main content
GET
A support member is a user in your organisation that belongs to one named Wordsmith engineer. It holds no role of its own, so it can see nothing until your organisation approves a support access grant for it. Suspended support members are included. sign_in_mode is customer_identity when the engineer signs in through your own identity provider with email, or wordsmith_driven when Wordsmith staff reach it only by acting on behalf of it. Adding and removing support members happens in the web app.

Authentication

Requires an API key, or an OAuth token with directory:admin. directory:admin is never granted by default. The caller must also hold a role with the view support access permission; the predefined admin role holds both. A Wordsmith support member is always refused, whatever role it holds. Support access must be turned on for your organisation.

Query parameters

string
The cursor from the previous page.
integer
default:"50"
Support members per page, up to 200.

Response

Returns 200 with a page of support members.

Errors