Skip to main content

The REST Admin API is a legacy API as of October 1, 2024. Starting April 1, 2025, all new public apps must be built exclusively with the GraphQL Admin API. For details and migration steps, visit our migration guide.

User

Requires users access scope.

Shopify Plus

The User resource is available for private apps and custom apps installed on Shopify Plus stores. You need to contact Shopify Plus Support to request the read_users access scope for your app.

The User resource lets you retrieve information about staff on a Shopify shop, including staff permissions.

Permissions determine the level of access that staff have to a merchant's store. From the Shopify admin, merchants can give each staff individual permissions that control access to a part of Shopify. The API only lets you retrieve information about staff.

Was this section helpful?
#

Endpoints

Anchor to

The User resource

Anchor to

Properties

account_owner
->
isShopOwner

Whether the user is the owner of the Shopify account.

bio
deprecated

The description the user has written for themselves.

email
->
email

The user's email address.

first_name
->
firstName

The user's first name.

id
->
id

The ID of the user's staff.

im
deprecated

This property is deprecated.

last_name
->
lastName

The user's last name.

permissions
->
permissions

The permissions granted to the user's staff account. Valid values:

Show permissions properties
  • applications: The user can authorize the installation of applications.
  • billing_application_charges: The user can approve application charges.
  • billing_charges: The user can view and export billing charges.
  • billing_invoices_view: The user can view billing invoices.
  • billing_payment_methods_view: The user can view billing payment methods.
  • customers: The user can view, create, edit, and delete customers, and respond to customer messages in Shopify Ping.
  • dashboard: The user can view the Home page, which includes sales information and other store data.
  • domains: The user can view, buy, and manage domains.
  • draft_orders: The user can create, update, and delete draft orders.
  • edit_orders: The user can edit orders.
  • edit_private_apps: The user can give permission to private apps to read, write, and make changes to the store.
  • export_customers: The user can export customers.
  • export_draft_orders: The user can export draft orders.
  • export_products: The user can export products and inventory.
  • export_orders: The user can export orders.
  • gift_cards: The user can view, create, issue, and export gift cards to a CSV file.
  • links: The user can view and modify links and navigation menus.
  • locations: The user can create, update, and delete locations where you stock or manage inventory.
  • marketing: The user can view and create discount codes and automatic discounts, and export discounts to a CSV file.
  • marketing_section: The user can view, create, and automate marketing campaigns.
  • orders: The user can view, create, update, delete, and cancel orders, and receive order notifications.
  • overviews: The user can view the Overview and Live view pages, which include sales information, and other store and sales channels data.
  • pages: The user can view, create, update, publish, and delete blog posts and pages.
  • preferences: The user can view the preferences and configuration of a shop.
  • products: The user can view, create, import, and update products, collections, and inventory.
  • reports: The user can view and create all reports, which includes sales information and other store data.
  • shopify_payments_accounts: The user can view Shopify Payments account details.
  • shopify_payments_transfers: The user can view Shopify Payments payouts.
  • staff_audit_log_view: The user can view Shopify admin browser sessions.
  • staff_management_activation: The user can activate or deactivate staff in the store.
  • staff_management_create: The user can add staff to the store.
  • staff_management_delete: The user can delete staff from the store.
  • staff_management_update: The user can update staff in the store.
  • themes: The user can view, update, and publish themes.
  • view_private_apps: The user can view private apps installed on the store.
phone
->
phone

The user's phone number.

receive_announcements
deprecated

Whether this account will receive email announcements from Shopify. Valid values: 0, 1

screen_name
deprecated

This property is deprecated.

url
deprecated

The user's homepage or other web address.

Was this section helpful?
{}

The User resource

{
"account_owner": false,
"bio": "A person on a mission",
"email": "joe@example.com",
"first_name": "Joe",
"id": 1234567890,
"im": "joe-chat@example.com",
"last_name": "Smith",
"permissions": [
"customers",
"dashboard",
"reports"
],
"phone": "(555) 555-5555",
"receive_announcements": 0,
"screen_name": "joesmith",
"url": "http://example.com",
"locale": "en",
"user_type": "regular"
}

Anchor to GET request, Retrieves a list of all users
get
Retrieves a list of all users

shop

Retrieves a list of all users. Note: This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to Make paginated requests to the REST Admin API.

Anchor to Parameters of Retrieves a list of all usersParameters

api_version
string
required
limit
≤ 250
default 50

The maximum number of results to show on a page.

page_info

A unique ID used to access a certain page of results.

Was this section helpful?

Anchor to get-users-examplesExamples

Retrieve a list of all users

Was this section helpful?
get

/admin/api/2025-07/users.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/users.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"users": [
{
"id": 548380009,
"first_name": "John",
"email": "j.smith@example.com",
"url": "www.example.com",
"im": null,
"screen_name": null,
"phone": null,
"last_name": "Smith",
"account_owner": true,
"receive_announcements": 1,
"bio": null,
"permissions": [
"applications",
"beacons",
"billing_application_charges",
"channels",
"content",
"content_entries_delete",
"content_entries_edit",
"content_entries_view",
"content_models_delete",
"content_models_edit",
"content_models_view",
"create_store_credit_account_transactions",
"create_and_edit_files",
"create_and_update_marketing_integrated_campaigns",
"create_files",
"custom_pixels_management",
"custom_pixels_view",
"customers",
"create_and_edit_customers",
"delete_customers",

Anchor to GET request, Retrieves a single user
get
Retrieves a single user

staffMember

Retrieves a single user

Anchor to Parameters of Retrieves a single userParameters

api_version
string
required
user_id
string
required
Was this section helpful?

Anchor to get-users-user-id-examplesExamples

Retrieve a single user

Path parameters
user_id=548380009
string
required
Was this section helpful?
get

/admin/api/2025-07/users/548380009.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/users/548380009.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"user": {
"id": 548380009,
"first_name": "John",
"email": "j.smith@example.com",
"url": "www.example.com",
"im": null,
"screen_name": null,
"phone": null,
"last_name": "Smith",
"account_owner": true,
"receive_announcements": 1,
"bio": null,
"permissions": [
"applications",
"beacons",
"billing_application_charges",
"channels",
"content",
"content_entries_delete",
"content_entries_edit",
"content_entries_view",
"content_models_delete",
"content_models_edit",
"content_models_view",
"create_store_credit_account_transactions",
"create_and_edit_files",
"create_and_update_marketing_integrated_campaigns",
"create_files",
"custom_pixels_management",
"custom_pixels_view",
"customers",
"create_and_edit_customers",
"delete_customers",
"export_customers",

Anchor to GET request, Retrieves the currently logged-in user
get
Retrieves the currently logged-in user

staffMember

Retrieves information about the user account associated with the access token used to make this API request. This request works only when the access token was created for a specific user of the shop.

Anchor to Parameters of Retrieves the currently logged-in userParameters

api_version
string
required
Was this section helpful?

Anchor to get-users-current-examplesExamples

Retrieve the the currently logged-in user

Was this section helpful?
get

/admin/api/2025-07/users/current.json

curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-07/users/current.json" \
-H "X-Shopify-Access-Token: {access_token}"

{}

Response

JSON
HTTP/1.1 200 OK
{
"user": {
"id": 548380009,
"first_name": "John",
"email": "j.smith@example.com",
"url": "www.example.com",
"im": null,
"screen_name": null,
"phone": null,
"last_name": "Smith",
"account_owner": true,
"receive_announcements": 1,
"bio": null,
"permissions": [
"applications",
"beacons",
"billing_application_charges",
"channels",
"content",
"content_entries_delete",
"content_entries_edit",
"content_entries_view",
"content_models_delete",
"content_models_edit",
"content_models_view",
"create_store_credit_account_transactions",
"create_and_edit_files",
"create_and_update_marketing_integrated_campaigns",
"create_files",
"custom_pixels_management",
"custom_pixels_view",
"customers",
"create_and_edit_customers",
"delete_customers",
"export_customers",