--- title: User description: Retrieve the permissions on staff. From the Shopify admin, merchants can give each staff individual permissions that control access to a part of Shopify. api_version: 2025-10 api_name: admin-rest api_type: rest source_url: html: https://shopify.dev/docs/api/admin-rest/latest/resources/user md: https://shopify.dev/docs/api/admin-rest/latest/resources/user.md --- 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](https://shopify.dev/docs/api/admin-graphql). For details and migration steps, visit our [migration guide](https://shopify.dev/docs/apps/build/graphql/migrate). # User Requires `users` access scope. #### Shopify Plus The User resource is available for [private apps](https://shopify.dev/concepts/apps#private-apps) and [custom apps](https://shopify.dev/concepts/apps#custom-apps) installed on **[Shopify Plus](https://help.shopify.com/en/manual/intro-to-shopify/pricing-plans/shopify-plus)** stores. You need to contact Shopify Plus Support to request the `read_users` [access scope](https://shopify.dev/api/usage/access-scopes) for your app. The User resource lets you retrieve information about staff on a Shopify shop, including [staff permissions](https://help.shopify.com/manual/your-account/staff-accounts/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. \# ## Endpoints * [get](https://shopify.dev/docs/api/admin-rest/latest/resources/user#get-users) [/admin/api/latest/users.​json](https://shopify.dev/docs/api/admin-rest/latest/resources/user#get-users) Retrieves a list of all users [shop](https://shopify.dev/docs/api/admin-graphql/latest/queries/shop?example=retrieves-a-list-of-all-users) * [get](https://shopify.dev/docs/api/admin-rest/latest/resources/user#get-users-user-id) [/admin/api/latest/users/{user\_​id}.​json](https://shopify.dev/docs/api/admin-rest/latest/resources/user#get-users-user-id) Retrieves a single user [staffMember](https://shopify.dev/docs/api/admin-graphql/latest/queries/staffMember?example=retrieves-a-single-user) * [get](https://shopify.dev/docs/api/admin-rest/latest/resources/user#get-users-current) [/admin/api/latest/users/current.​json](https://shopify.dev/docs/api/admin-rest/latest/resources/user#get-users-current) Retrieves the currently logged-in user [staffMember](https://shopify.dev/docs/api/admin-graphql/latest/queries/staffMember?example=retrieves-the-currently-logged-in-user) *** ## The User resource ### Properties *** account\_owner ->[isShopOwner](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember#field-StaffMember.fields.isShopOwner) Whether the user is the owner of the Shopify account. *** bio deprecated The description the user has written for themselves. *** email ->[email](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember#field-StaffMember.fields.email) The user's email address. *** first\_name ->[firstName](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember#field-StaffMember.fields.firstName) The user's first name. *** id ->[id](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember#field-StaffMember.fields.id) The ID of the user's staff. *** im deprecated This property is deprecated. *** last\_name ->[lastName](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember#field-StaffMember.fields.lastName) The user's last name. *** permissions ->[permissions](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMemberPrivateData#field-StaffMemberPrivateData.fields.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](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember#field-StaffMember.fields.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. *** {} ## The User resource ```json { "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" } ``` *** ## getRetrieves a list of all users [shop](https://shopify.dev/docs/api/admin-graphql/latest/queries/shop?example=retrieves-a-list-of-all-users) 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](https://shopify.dev/api/usage/pagination-rest). ### Parameters *** 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. *** ### Examples Retrieve a list of all users get ## /admin/api/2025-10/users.​json ```bash curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/users.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` {} ## Response JSON ```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", "bulk_data_export", "bulk_data_import", "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", ``` ### examples * #### Retrieve a list of all users ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/users.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` ##### ```remix await admin.rest.resources.User.all({ session: session, }); ``` ##### ```ruby # Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::User.all( session: test_session, ) ``` ##### ```node // Session is built by the OAuth process await shopify.rest.User.all({ session: session, }); ``` #### 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","bulk_data_export","bulk_data_import","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","merge_customers","dashboard","delete_products","delete_files","delete_marketing_integrated_campaigns","domains","draft_orders","create_and_edit_draft_orders","apply_discounts_to_draft_orders","mark_draft_orders_as_paid","set_payment_terms_for_draft_orders","delete_draft_orders","pay_draft_orders_by_vaulted_card","edit_files","edit_orders","edit_private_apps","edit_product_cost","edit_product_price","edit_theme_code","gift_cards","create_and_edit_gift_cards","deactivate_gift_cards","export_gift_cards","links","locations","manage_delivery_settings","manage_inventory","view_inventory_transfers","create_and_edit_inventory_transfers","manage_inventory_shipments","manage_policies","manage_product_tags","manage_products","manage_store_credit_settings","manage_taxes_settings","marketing","marketing_section","metaobjects_delete","metaobjects_edit","metaobjects_view","metaobject_definitions_delete","metaobject_definitions_edit","metaobject_definitions_view","orders","over_refund_to_original_payment","overviews","pages","pay_draft_orders_by_credit_card","pay_orders_by_credit_card","pay_orders_by_vaulted_card","preferences","products","refund_orders","refund_to_store_credit","reports","translations","themes","view_all_shopify_credit_transactions","view_balance_bank_accounts","view_files","view_marketing_integrated_campaigns","view_private_apps","view_product_costs","view_store_credit_account_transactions","apply_discounts_to_orders","fulfill_and_ship_orders","buy_shipping_labels","return_orders","manage_abandoned_checkouts","cancel_orders","delete_orders","manage_orders_information","set_payment_terms_for_orders","mark_orders_as_paid","capture_payments_for_orders","view_companies","create_and_edit_companies","delete_companies","manage_company_location_assignments","third_party_money_movement","export_draft_orders","export_orders","export_products","manage_checkout_customer_accounts_editor","manage_checkout_settings","view_price_lists","delete_price_lists","create_and_edit_price_lists","view_catalogs","create_and_edit_catalogs","delete_catalogs","view_markets","create_and_edit_markets","delete_markets","manage_customer_identity_providers","select_existing_legal_entity","sidekick","view_rollouts","create_and_edit_rollouts","delete_rollouts","view_company_store_credit_account_transactions","create_company_store_credit_account_transactions","manage_terms_of_service","quick_sale","shopify_payments_accounts","shopify_payments_transfers","staff_audit_log_view","staff_management_update","applications_billing","attestation_authority","authentication_management","balance_bank_accounts_management","billing_charges","billing_invoices_pay","billing_invoices_view","billing_payment_methods_manage","billing_payment_methods_view","billing_settings","billing_subscriptions","capital","customer_private_data","erase_customer_data","request_customer_data","domains_management","domains_transfer_out","enable_private_apps","experiments_management","manage_all_shopify_credit_cards","manage_tap_to_pay","payment_settings","upgrade_to_plus_plan","shopify_payments","sqlite_bulk_data_transfer","staff_api_permission_management","staff_management","staff_management_activation","staff_management_create","staff_management_delete","support_methods","third_party_gateways","collaborator_request_management","collaborator_request_settings","enable_retail_terms_of_service"],"locale":"en","user_type":"regular","admin_graphql_api_id":"gid://shopify/AdminUserSerializer/548380009","tfa_enabled?":false},{"id":930143300,"first_name":"John","email":"j.limited@example.com","url":"www.example.com","im":null,"screen_name":null,"phone":null,"last_name":"Limited","account_owner":false,"receive_announcements":1,"bio":null,"permissions":[],"locale":"en","user_type":"regular","admin_graphql_api_id":"gid://shopify/AdminUserSerializer/930143300","tfa_enabled?":false}]} ``` *** ## getRetrieves a single user [staffMember](https://shopify.dev/docs/api/admin-graphql/latest/queries/staffMember?example=retrieves-a-single-user) Retrieves a single user ### Parameters *** api\_version string required *** user\_id string required *** ### Examples Retrieve a single user Path parameters user\_​id=​548380009 string required get ## /admin/api/2025-10/users/548380009.​json ```bash curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/users/548380009.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` {} ## Response JSON ```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", "bulk_data_export", "bulk_data_import", "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", ``` ### examples * #### Retrieve a single user ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/users/548380009.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` ##### ```remix await admin.rest.resources.User.find({ session: session, id: 548380009, }); ``` ##### ```ruby # Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::User.find( session: test_session, id: 548380009, ) ``` ##### ```node // Session is built by the OAuth process await shopify.rest.User.find({ session: session, id: 548380009, }); ``` #### 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","bulk_data_export","bulk_data_import","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","merge_customers","dashboard","delete_products","delete_files","delete_marketing_integrated_campaigns","domains","draft_orders","create_and_edit_draft_orders","apply_discounts_to_draft_orders","mark_draft_orders_as_paid","set_payment_terms_for_draft_orders","delete_draft_orders","pay_draft_orders_by_vaulted_card","edit_files","edit_orders","edit_private_apps","edit_product_cost","edit_product_price","edit_theme_code","gift_cards","create_and_edit_gift_cards","deactivate_gift_cards","export_gift_cards","links","locations","manage_delivery_settings","manage_inventory","view_inventory_transfers","create_and_edit_inventory_transfers","manage_inventory_shipments","manage_policies","manage_product_tags","manage_products","manage_store_credit_settings","manage_taxes_settings","marketing","marketing_section","metaobjects_delete","metaobjects_edit","metaobjects_view","metaobject_definitions_delete","metaobject_definitions_edit","metaobject_definitions_view","orders","over_refund_to_original_payment","overviews","pages","pay_draft_orders_by_credit_card","pay_orders_by_credit_card","pay_orders_by_vaulted_card","preferences","products","refund_orders","refund_to_store_credit","reports","translations","themes","view_all_shopify_credit_transactions","view_balance_bank_accounts","view_files","view_marketing_integrated_campaigns","view_private_apps","view_product_costs","view_store_credit_account_transactions","apply_discounts_to_orders","fulfill_and_ship_orders","buy_shipping_labels","return_orders","manage_abandoned_checkouts","cancel_orders","delete_orders","manage_orders_information","set_payment_terms_for_orders","mark_orders_as_paid","capture_payments_for_orders","view_companies","create_and_edit_companies","delete_companies","manage_company_location_assignments","third_party_money_movement","export_draft_orders","export_orders","export_products","manage_checkout_customer_accounts_editor","manage_checkout_settings","view_price_lists","delete_price_lists","create_and_edit_price_lists","view_catalogs","create_and_edit_catalogs","delete_catalogs","view_markets","create_and_edit_markets","delete_markets","manage_customer_identity_providers","select_existing_legal_entity","sidekick","view_rollouts","create_and_edit_rollouts","delete_rollouts","view_company_store_credit_account_transactions","create_company_store_credit_account_transactions","manage_terms_of_service","quick_sale","shopify_payments_accounts","shopify_payments_transfers","staff_audit_log_view","staff_management_update","applications_billing","attestation_authority","authentication_management","balance_bank_accounts_management","billing_charges","billing_invoices_pay","billing_invoices_view","billing_payment_methods_manage","billing_payment_methods_view","billing_settings","billing_subscriptions","capital","customer_private_data","erase_customer_data","request_customer_data","domains_management","domains_transfer_out","enable_private_apps","experiments_management","manage_all_shopify_credit_cards","manage_tap_to_pay","payment_settings","upgrade_to_plus_plan","shopify_payments","sqlite_bulk_data_transfer","staff_api_permission_management","staff_management","staff_management_activation","staff_management_create","staff_management_delete","support_methods","third_party_gateways","collaborator_request_management","collaborator_request_settings","enable_retail_terms_of_service"],"locale":"en","user_type":"regular","admin_graphql_api_id":"gid://shopify/AdminUserSerializer/548380009","tfa_enabled?":false}} ``` *** ## getRetrieves the currently logged-in user [staffMember](https://shopify.dev/docs/api/admin-graphql/latest/queries/staffMember?example=retrieves-the-currently-logged-in-user) 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. ### Parameters *** api\_version string required *** ### Examples Retrieve the the currently logged-in user get ## /admin/api/2025-10/users/current.​json ```bash curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/users/current.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` {} ## Response JSON ```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", "bulk_data_export", "bulk_data_import", "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", ``` ### examples * #### Retrieve the the currently logged-in user ##### ```curl curl -X GET "https://your-development-store.myshopify.com/admin/api/2025-10/users/current.json" \ -H "X-Shopify-Access-Token: {access_token}" ``` ##### ```remix await admin.rest.resources.User.current({ session: session, }); ``` ##### ```ruby # Session is activated via Authentication test_session = ShopifyAPI::Context.active_session ShopifyAPI::User.current( session: test_session, ) ``` ##### ```node // Session is built by the OAuth process await shopify.rest.User.current({ session: session, }); ``` #### 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","bulk_data_export","bulk_data_import","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","merge_customers","dashboard","delete_products","delete_files","delete_marketing_integrated_campaigns","domains","draft_orders","create_and_edit_draft_orders","apply_discounts_to_draft_orders","mark_draft_orders_as_paid","set_payment_terms_for_draft_orders","delete_draft_orders","pay_draft_orders_by_vaulted_card","edit_files","edit_orders","edit_private_apps","edit_product_cost","edit_product_price","edit_theme_code","gift_cards","create_and_edit_gift_cards","deactivate_gift_cards","export_gift_cards","links","locations","manage_delivery_settings","manage_inventory","view_inventory_transfers","create_and_edit_inventory_transfers","manage_inventory_shipments","manage_policies","manage_product_tags","manage_products","manage_store_credit_settings","manage_taxes_settings","marketing","marketing_section","metaobjects_delete","metaobjects_edit","metaobjects_view","metaobject_definitions_delete","metaobject_definitions_edit","metaobject_definitions_view","orders","over_refund_to_original_payment","overviews","pages","pay_draft_orders_by_credit_card","pay_orders_by_credit_card","pay_orders_by_vaulted_card","preferences","products","refund_orders","refund_to_store_credit","reports","translations","themes","view_all_shopify_credit_transactions","view_balance_bank_accounts","view_files","view_marketing_integrated_campaigns","view_private_apps","view_product_costs","view_store_credit_account_transactions","apply_discounts_to_orders","fulfill_and_ship_orders","buy_shipping_labels","return_orders","manage_abandoned_checkouts","cancel_orders","delete_orders","manage_orders_information","set_payment_terms_for_orders","mark_orders_as_paid","capture_payments_for_orders","view_companies","create_and_edit_companies","delete_companies","manage_company_location_assignments","third_party_money_movement","export_draft_orders","export_orders","export_products","manage_checkout_customer_accounts_editor","manage_checkout_settings","view_price_lists","delete_price_lists","create_and_edit_price_lists","view_catalogs","create_and_edit_catalogs","delete_catalogs","view_markets","create_and_edit_markets","delete_markets","manage_customer_identity_providers","select_existing_legal_entity","sidekick","view_rollouts","create_and_edit_rollouts","delete_rollouts","view_company_store_credit_account_transactions","create_company_store_credit_account_transactions","manage_terms_of_service","quick_sale","shopify_payments_accounts","shopify_payments_transfers","staff_audit_log_view","staff_management_update","applications_billing","attestation_authority","authentication_management","balance_bank_accounts_management","billing_charges","billing_invoices_pay","billing_invoices_view","billing_payment_methods_manage","billing_payment_methods_view","billing_settings","billing_subscriptions","capital","customer_private_data","erase_customer_data","request_customer_data","domains_management","domains_transfer_out","enable_private_apps","experiments_management","manage_all_shopify_credit_cards","manage_tap_to_pay","payment_settings","upgrade_to_plus_plan","shopify_payments","sqlite_bulk_data_transfer","staff_api_permission_management","staff_management","staff_management_activation","staff_management_create","staff_management_delete","support_methods","third_party_gateways","collaborator_request_management","collaborator_request_settings","enable_retail_terms_of_service"],"locale":"en","user_type":"regular","admin_graphql_api_id":"gid://shopify/AdminUserSerializer/548380009","tfa_enabled?":false}} ```