Search staff accounts

Get all available information about existing staff accounts in the store.

Access scopes

Requires the following access scope: read_staff

Response

A JSON object with the following fields:

Subscription

FieldTypeDescription
staffListobj<StaffList>List of staff accounts invited to the store

StaffList

FieldTypeDescription
idstringStaff account ID
namestringStaff member name
emailstringAccount email
staffScopesstringScopes declaring permissions for the staff account. See: Get staff scopes
Empty value = no restrictions. Check Help Center for more i
inviteAcceptedbooleanSpecifies if invite is accepted. Possible values: true if accepted, false if not
Language
Click Try It! to start a request and see the response here!