staffMember

Retrieves a staff member by ID. If no ID is provided, the query returns the staff member that's making the request.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the staffMember action (under Staff).
Fill in the fields below, then reference the result from later steps as {{staffmember.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 StaffMember($id: ID) {
  staffMember(id: $id) {
    accountType
    active
    email
    exists
    firstName
    id
    initials
    isShopOwner
    lastName
    locale
    name
    phone
    privateData {
      accountSettingsUrl
      createdAt
      permissions
    }
  }
}

Variables

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

idstring

The ID of the staff member to return. If no ID is provided, then the staff member making the query (if any) is returned.

json

{
  "id": "string"
}

Response

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

accountTypestring

One ofREGULARRESTRICTEDINVITEDREQUESTEDCOLLABORATORCOLLABORATOR_TEAM_MEMBERSAMLINVITED_STORE_OWNER

activeboolean

emailstring

existsboolean

firstNamestring

idstring

initialsarray<string>

isShopOwnerboolean

lastNamestring

localestring

namestring

phonestring

privateDataobject

accountSettingsUrlstring

createdAtstring

permissionsarray<object>

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

Was this page helpful?