Get staff accounts

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

📘

To get the information about staff accounts use secret token. The read_staff access scope is required. Reach out to us at [email protected] to add the scope.

Headers

NameTypeDescription
AuthorizationstringoAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.

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
Authorization
Query