Choose a version:

staffMember

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.

Anchor to Arguments

Arguments

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

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to StaffMemberStaffMember

•StaffMember

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 CompanyLocation objects for B2B operations, limiting their actions to those locations.

Anchor to accountTypeaccountType

•AccountType

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.

Arguments

Anchor to maxWidthmaxWidth

•Int

Deprecated

Anchor to maxHeightmaxHeight

•Int

Deprecated

Anchor to fallbackfallback

•StaffMemberDefaultImage

Default:DEFAULT

The default image returned if the staff member has no avatar.

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 firstNamefirstName

•String

The staff member's first name.

Anchor to idid

•ID!

non-null

A globally-unique ID.

Anchor to initialsinitials

•[String!]

The staff member's initials, if available.

Anchor to isShopOwnerisShopOwner

•Boolean!

non-null

Whether the staff member is the shop owner.

Anchor to lastNamelastName

•String

The staff member's last name.

Anchor to localelocale

•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 namename

•String!

non-null

The staff member's full name.

Anchor to phonephone

•String

The staff member's phone number.

Anchor to privateDataprivateData

•StaffMemberPrivateData!

non-null

The data used to customize the Shopify admin experience for the staff member.

Was this section helpful?

Examples

Retrieves a single user

Query

query StaffMember($id: ID!) {
  staffMember(id: $id) {
    active
    avatar {
      url
    }
    email
    exists
    firstName
    id
    initials
    isShopOwner
    lastName
    locale
    name
    phone
  }
}

Variables

{
  "id": "gid://shopify/StaffMember/902541635"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query StaffMember($id: ID!) { staffMember(id: $id) { active avatar { url } email exists firstName id initials isShopOwner lastName locale name phone } }",
 "variables": {
    "id": "gid://shopify/StaffMember/902541635"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query StaffMember($id: ID!) {
    staffMember(id: $id) {
      active
      avatar {
        url
      }
      email
      exists
      firstName
      id
      initials
      isShopOwner
      lastName
      locale
      name
      phone
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/StaffMember/902541635"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query StaffMember($id: ID!) {
    staffMember(id: $id) {
      active
      avatar {
        url
      }
      email
      exists
      firstName
      id
      initials
      isShopOwner
      lastName
      locale
      name
      phone
    }
  }
QUERY

variables = {
  "id": "gid://shopify/StaffMember/902541635"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query StaffMember($id: ID!) {
      staffMember(id: $id) {
        active
        avatar {
          url
        }
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
      }
    }`,
    "variables": {
        "id": "gid://shopify/StaffMember/902541635"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'query StaffMember($id: ID!) {
  staffMember(id: $id) {
    active
    avatar {
      url
    }
    email
    exists
    firstName
    id
    initials
    isShopOwner
    lastName
    locale
    name
    phone
  }
}' \
--variables \
'{
  "id": "gid://shopify/StaffMember/902541635"
}'

Response

{
  "staffMember": {
    "active": true,
    "avatar": {
      "url": "https://cdn.shopify.com/s/files/1/2637/1970/users/foo.jpg?v=1731443626"
    },
    "email": "bob@example.com",
    "exists": true,
    "firstName": "bob",
    "id": "gid://shopify/StaffMember/902541635",
    "initials": [
      "b",
      "b"
    ],
    "isShopOwner": true,
    "lastName": "bobsen",
    "locale": "en",
    "name": "bob bobsen",
    "phone": null
  }
}

Retrieves the currently logged-in user

Query

query {
  staffMember {
    active
    avatar {
      url
    }
    email
    exists
    firstName
    id
    initials
    isShopOwner
    lastName
    locale
    name
    phone
    privateData {
      accountSettingsUrl
      createdAt
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { staffMember { active avatar { url } email exists firstName id initials isShopOwner lastName locale name phone privateData { accountSettingsUrl createdAt } } }"
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query {
    staffMember {
      active
      avatar {
        url
      }
      email
      exists
      firstName
      id
      initials
      isShopOwner
      lastName
      locale
      name
      phone
      privateData {
        accountSettingsUrl
        createdAt
      }
    }
  }`,
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query {
    staffMember {
      active
      avatar {
        url
      }
      email
      exists
      firstName
      id
      initials
      isShopOwner
      lastName
      locale
      name
      phone
      privateData {
        accountSettingsUrl
        createdAt
      }
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    staffMember {
      active
      avatar {
        url
      }
      email
      exists
      firstName
      id
      initials
      isShopOwner
      lastName
      locale
      name
      phone
      privateData {
        accountSettingsUrl
        createdAt
      }
    }
  }`,
});

Shopify CLI

shopify app execute \
--query \
'query {
  staffMember {
    active
    avatar {
      url
    }
    email
    exists
    firstName
    id
    initials
    isShopOwner
    lastName
    locale
    name
    phone
    privateData {
      accountSettingsUrl
      createdAt
    }
  }
}'

Response

{
  "staffMember": {
    "active": true,
    "avatar": {
      "url": "https://cdn.shopify.com/s/files/1/2637/1970/users/foo.jpg?v=1731443626"
    },
    "email": "bob@example.com",
    "exists": true,
    "firstName": "bob",
    "id": "gid://shopify/StaffMember/902541635",
    "initials": [
      "b",
      "b"
    ],
    "isShopOwner": true,
    "lastName": "bobsen",
    "locale": "en",
    "name": "bob bobsen",
    "phone": null,
    "privateData": {
      "accountSettingsUrl": "https://www.snowdevil.ca/admin/settings/account/902541635",
      "createdAt": "2005-01-01T00:00:00Z"
    }
  }
}

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query StaffMember($id: ID!) {

staffMember(id: $id) {

active

avatar {

url

}

exists

firstName

initials

isShopOwner

lastName

locale

name

phone

}

}`,

{

variables: {

"id": "gid://shopify/StaffMember/902541635"

);

const json = await response.json();

return json.data;

}

GQL

query StaffMember($id: ID!) {
  staffMember(id: $id) {
    active
    avatar {
      url
    }
    email
    exists
    firstName
    id
    initials
    isShopOwner
    lastName
    locale
    name
    phone
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query StaffMember($id: ID!) { staffMember(id: $id) { active avatar { url } email exists firstName id initials isShopOwner lastName locale name phone } }",
 "variables": {
    "id": "gid://shopify/StaffMember/902541635"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  query StaffMember($id: ID!) {
    staffMember(id: $id) {
      active
      avatar {
        url
      }
      email
      exists
      firstName
      id
      initials
      isShopOwner
      lastName
      locale
      name
      phone
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/StaffMember/902541635"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `query StaffMember($id: ID!) {
      staffMember(id: $id) {
        active
        avatar {
          url
        }
        email
        exists
        firstName
        id
        initials
        isShopOwner
        lastName
        locale
        name
        phone
      }
    }`,
    "variables": {
        "id": "gid://shopify/StaffMember/902541635"
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query StaffMember($id: ID!) {
    staffMember(id: $id) {
      active
      avatar {
        url
      }
      email
      exists
      firstName
      id
      initials
      isShopOwner
      lastName
      locale
      name
      phone
    }
  }
QUERY

variables = {
  "id": "gid://shopify/StaffMember/902541635"
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'query StaffMember($id: ID!) {
  staffMember(id: $id) {
    active
    avatar {
      url
    }
    email
    exists
    firstName
    id
    initials
    isShopOwner
    lastName
    locale
    name
    phone
  }
}' \
--variables \
'{
  "id": "gid://shopify/StaffMember/902541635"
}'

Input variables

JSON

{

"id": "gid://shopify/StaffMember/902541635"

}

Response

JSON

{

"staffMember": {

"active": true,

"avatar": {

"url": "https://cdn.shopify.com/s/files/1/2637/1970/users/foo.jpg?v=1731443626"

"email": "bob@example.com",

"exists": true,

"firstName": "bob",

"id": "gid://shopify/StaffMember/902541635",

"initials": [

"b",

"b"

"isShopOwner": true,

"lastName": "bobsen",

"locale": "en",

"name": "bob bobsen",

"phone": null

}