StaffMember
object

Choose a version:

Requires read_users access scope. Also: The app must be a finance embedded app or installed on a Shopify Plus or Advanced store. Contact Shopify Support to enable this scope for your app.

Represents the data about a staff member's Shopify account. Merchants can use staff member data to get more information about the staff members in their store.

Anchor to section titled 'Fields'

Fields

Anchor to StaffMember.active active Boolean! non-null: Whether the staff member is active.
Anchor to StaffMember.avatar avatar Image! non-null: The image used as the staff member's avatar in the Shopify admin.
Anchor to StaffMember.email email String! non-null: The staff member's email address.
Anchor to StaffMember.exists exists Boolean! non-null: Whether the staff member's account exists.
Anchor to StaffMember.firstName firstName String: The staff member's first name.
Anchor to StaffMember.id id ID! non-null: A globally-unique ID.
Anchor to StaffMember.initials initials [String!]: The staff member's initials, if available.
Anchor to StaffMember.isShopOwner isShopOwner Boolean! non-null: Whether the staff member is the shop owner.
Anchor to StaffMember.lastName lastName String: The staff member's last name.
Anchor to StaffMember.locale locale String! non-null: The staff member's preferred locale. Locale values use the format language or language-COUNTRY, where language is a two-letter language code, and COUNTRY is a two-letter country code. For example: en or en-US
Anchor to StaffMember.name name String! non-null: The staff member's full name.
Anchor to StaffMember.phone phone String: The staff member's phone number.
Anchor to StaffMember.privateData privateData StaffMemberPrivateData! non-null: The data used to customize the Shopify admin experience for the staff member.