Staff
Requires 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.
A user account that can access the Shopify admin to manage store operations. Includes personal information and account status.
You can assign staff members to objects for B2B operations, limiting their actions to those locations.
Anchor to FieldsFields
- Anchor to accountTypeaccount•Account
Type Type The type of account the staff member has.
- Anchor to activeactive•Boolean!non-null
Whether the staff member is active.
- Anchor to avataravatar•Image!non-null
The image used as the staff member's avatar in the Shopify admin.
- Anchor to maxWidthmax•Int
Width Deprecated - Anchor to maxHeightmax•Int
Height Deprecated - Anchor to fallbackfallback•Staff
Member Default Image Default:DEFAULT The default image returned if the staff member has no avatar.
Arguments
- Anchor to emailemail•String!non-null
The staff member's email address.
- Anchor to existsexists•Boolean!non-null
Whether the staff member's account exists.
- Anchor to firstNamefirst•String
Name The staff member's first name.
- •ID!non-null
A globally-unique ID.
- Anchor to identityAccountidentity•Identity
Account Account The Identity account details for the staff member.
- Anchor to initialsinitials•[String!]
The staff member's initials, if available.
- Anchor to isShopOwneris•Boolean!
Shop Owner non-null Whether the staff member is the shop owner.
- Anchor to lastNamelast•String
Name The staff member's last name.
- Anchor to localelocale•String!non-null
The staff member's preferred locale. Locale values use the format
languageor, wherelanguageis a two-letter language code, andis a two-letter country code. For example:enor- Anchor to namename•String!non-null
The staff member's full name.
- Anchor to phonephone•String
The staff member's phone number.
- Anchor to privateDataprivate•Staff
Data Member Private Data! non-null The data used to customize the Shopify admin experience for the staff member.
- Anchor to identityAccountUrlidentity•URL
Account Url Deprecated
Anchor to QueriesQueries
- •query
The staff member making the API request.
- •query
Retrieves a staff member by ID. If no ID is provided, the query returns the staff member that's making the request. A staff member is a user who can access the Shopify admin to manage store operations.
Provides staff member details such as email, name, and shop owner status. When querying the current user (with or without an ID), additional private data becomes available.
- •ID
The ID of the staff member to return. If no ID is provided, then the staff member making the query (if any) is returned.
Arguments
- •query
Returns a paginated list of
objects for the shop. Staff members are users who can access the Shopify admin to manage store operations.Supports filtering by account type, email, and name, with an option to sort results. The query returns a
for cursor-based pagination.- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
- Anchor to sortKeysort•Staff
Key Members Sort Keys Default:ID Sort the underlying list using a key. If your query is slow or returns an error, then try specifying a sort key that matches the field used in the search.
- Anchor to queryquery•String
A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.
Arguments