Skip to main content
Anchor to staffMembers

staffMembers

query

Returns a paginated list of StaffMember 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 StaffMemberConnection for cursor-based pagination.

Anchor to Arguments

StaffMemberConnection arguments

•StaffMemberConnection
Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to lastlast
•Int

The last n elements from the paginated list.

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.

Anchor to account_type
•string

Filter by account type.

Valid values:

  • collaborator
  • collaborator_team_member
  • invited
  • regular
  • requested
  • restricted
  • saml
Anchor to email
•string

Filter by email.

Anchor to first_name
•string

Filter by first name.

Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to last_name
•string

Filter by last name.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•StaffMembersSortKeys
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.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•[StaffMemberEdge!]!
non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•[StaffMember!]!
non-null

A list of nodes that are contained in StaffMemberEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•PageInfo!
non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?