younifyd
Menu

staffMembers

Returns a paginated list of StaffMember objects for the shop. Staff members are users who can access the Shopify admin to manage store operations.

Use it in a workflow

  1. Add a step and choose the Shopify connector.
  2. Pick the staffMembers action (under Staff).
  3. Fill in the fields below, then reference the result from later steps as {{staffmembers.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql
query StaffMembers($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: StaffMembersSortKeys, $query: String) {
  staffMembers(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        accountType
        active
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
        privateData
      }
    }
    nodes {
      accountType
      active
      email
      exists
      firstName
      id
      initials
      isShopOwner
      lastName
      locale
      name
      phone
      privateData {
        accountSettingsUrl
        createdAt
        permissions
      }
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

sortKeystring

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](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofEMAILFIRST_NAMEIDLAST_NAME

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | account_type | string | Filter by account type. | - `collaborator`<br/> - `collaborator_team_member`<br/> - `invited`<br/> - `regular`<br/> - `requested`<br/> - `restricted`<br/> - `saml` | | email | string | Filter by email. | | first_name | string | Filter by first name. | | id | id | Filter by `id` range. | | | - `id:1234`<br/> - `id:>=1234`<br/> - `id:<=1234` | | last_name | string | Filter by last name. | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

json
{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "EMAIL",
  "query": "string"
}

Response

Read the result with {{staffmembers.response.data.data.staffMembers}}. If the API returns errors, the step fails and they are at {{staffmembers.response.data.errors}}.

edgesarray<object>
cursorobject
nodeobject
nodesarray<object>
accountTypeobject
activeobject
emailobject
existsobject
firstNameobject
idobject
initialsobject
isShopOwnerobject
lastNameobject
localeobject
nameobject
phoneobject
privateDataobject
pageInfoobject
endCursorstring
hasNextPageboolean
hasPreviousPageboolean
startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.