# User <div class="note note-plus"> <h4>Shopify Plus</h4> <p>The User resource is available for <a href="/concepts/apps#private-apps">private apps</a> and <a href="/concepts/apps#custom-apps">custom apps</a> installed on <strong><a href="https://help.shopify.com/en/manual/intro-to-shopify/pricing-plans/shopify-plus">Shopify Plus</a></strong> stores. You need to contact Shopify Plus Support to request the <code>read_users</code> <a href="/api/usage/access-scopes">access scope</a> for your app.</p> </div> <p>The User resource lets you retrieve information about staff on a Shopify shop, including <a href="https://help.shopify.com/manual/your-account/staff-accounts/staff-permissions">staff permissions</a>.</p> <p>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. </p> ## Resource Properties ### User * account_owner: Whether the user is the owner of the Shopify account. * Type: x-string * Example: false * bio: The description the user has written for themselves. * Type: x-string * Example: "A person on a mission" * email: The user's email address. * Type: x-string * Example: "joe@example.com" * first_name: The user's first name. * Type: x-string * Example: "Joe" * id: The ID of the user's staff. * Type: x-string * Example: 1234567890 * im: This property is deprecated. * Type: x-string * Example: "joe-chat@example.com" * last_name: The user's last name. * Type: x-string * Example: "Smith" * permissions: <p>The permissions granted to the user's staff account. Valid values:</p> <ul> <li><strong>applications</strong>: The user can authorize the installation of applications.</li> <li><strong>billing_application_charges</strong>: The user can approve application charges.</li> <li><strong>billing_charges</strong>: The user can view and export billing charges.</li> <li><strong>billing_invoices_view</strong>: The user can view billing invoices.</li> <li><strong>billing_payment_methods_view</strong>: The user can view billing payment methods.</li> <li><strong>customers</strong>: The user can view, create, edit, and delete customers, and respond to customer messages in Shopify Ping.</li> <li><strong>dashboard</strong>: The user can view the <strong>Home</strong> page, which includes sales information and other store data.</li> <li><strong>domains</strong>: The user can view, buy, and manage domains.</li> <li><strong>draft_orders</strong>: The user can create, update, and delete draft orders.</li> <li><strong>edit_orders</strong>: The user can edit orders.</li> <li><strong>edit_private_apps</strong>: The user can give permission to private apps to read, write, and make changes to the store.</li> <li><strong>export_customers</strong>: The user can export customers.</li> <li><strong>export_draft_orders</strong>: The user can export draft orders.</li> <li><strong>export_products</strong>: The user can export products and inventory.</li> <li><strong>export_orders</strong>: The user can export orders.</li> <li><strong>gift_cards</strong>: The user can view, create, issue, and export gift cards to a CSV file.</li> <li><strong>links</strong>: The user can view and modify links and navigation menus.</li> <li><strong>locations</strong>: The user can create, update, and delete locations where you stock or manage inventory.</li> <li><strong>marketing</strong>: The user can view and create discount codes and automatic discounts, and export discounts to a CSV file.</li> <li><strong>marketing_section</strong>: The user can view, create, and automate marketing campaigns.</li> <li><strong>orders</strong>: The user can view, create, update, delete, and cancel orders, and receive order notifications.</li> <li><strong>overviews</strong>: The user can view the <strong>Overview</strong> and <strong>Live view</strong> pages, which include sales information, and other store and sales channels data.</li> <li><strong>pages</strong>: The user can view, create, update, publish, and delete blog posts and pages.</li> <li><strong>preferences</strong>: The user can view the preferences and configuration of a shop.</li> <li><strong>products</strong>: The user can view, create, import, and update products, collections, and inventory.</li> <li><strong>reports</strong>: The user can view and create all reports, which includes sales information and other store data.</li> <li><strong>shopify_payments_accounts</strong>: The user can view Shopify Payments account details.</li> <li><strong>shopify_payments_transfers</strong>: The user can view Shopify Payments payouts.</li> <li><strong>staff_audit_log_view</strong>: The user can view Shopify admin browser sessions.</li> <li><strong>staff_management_activation</strong>: The user can activate or deactivate staff in the store.</li> <li><strong>staff_management_create</strong>: The user can add staff to the store.</li> <li><strong>staff_management_delete</strong>: The user can delete staff from the store.</li> <li><strong>staff_management_update</strong>: The user can update staff in the store.</li> <li><strong>themes</strong>: The user can view, update, and publish themes.</li> <li><strong>view_private_apps</strong>: The user can view private apps installed on the store.</li> </ul> * Type: x-string * Example: ["customers", "dashboard", "reports"] * phone: The user's phone number. * Type: x-string * Example: "(555) 555-5555" * receive_announcements: Whether this account will receive email announcements from Shopify. Valid values: <code>0</code>, <code>1</code> * Type: x-string * Example: 0 * screen_name: This property is deprecated. * Type: x-string * Example: "joesmith" * url: The user's homepage or other web address. * Type: x-string * Example: "http://example.com" * locale: The user's preferred locale. Locale values use the format <code>language</code> or <code>language-COUNTRY</code>, where <code>language</code> is a two-letter language code, and <code>COUNTRY</code> is a two-letter country code. For example: <code>en</code> or <code>en-US</code> * Type: x-string * Example: "en" * user_type: <p>The type of account the user has. Valid values:</p> <ul> <li><strong>regular</strong>: The user's account can access the Shopify admin.</li> <li><strong>restricted</strong>: The user's account cannot access the Shopify admin.</li> <li><strong>invited</strong>: The user has not yet accepted the invitation to create staff.</li> <li><strong>collaborator</strong>: The user account of a partner who collaborates with the merchant.</li> </ul> * Type: x-string * Example: "regular" ## Retrieves a list of all users Retrieves a list of all users. <strong>Note:</strong> This endpoint implements pagination by using links that are provided in the response header. To learn more, refer to <a href='/api/usage/pagination-rest'>Make paginated requests to the REST Admin API</a>. ### Endpoint /admin/api/#{api_version}/users.json (GET) ### Parameters * api_version (required): * limit: The maximum number of results to show on a page. * page_info: A unique ID used to access a certain page of results. ### Responses #### 200 Retrieves a list of all users Examples: ##### Retrieve a list of all users Request: ``` GET /admin/api/unstable/users.json ``` Response: ``` 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_files","custom_pixels_management","custom_pixels_view","customers","create_and_edit_customers","delete_customers","export_customers","merge_customers","dashboard","delete_products","delete_files","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","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","overviews","pages","pay_draft_orders_by_credit_card","pay_orders_by_credit_card","pay_orders_by_vaulted_card","preferences","products","refund_orders","reports","translations","themes","view_all_shopify_credit_transactions","view_balance_bank_accounts","view_files","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_markets","create_and_edit_markets","delete_markets","manage_customer_identity_providers","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","view_price_lists","delete_price_lists","create_and_edit_price_lists","view_catalogs","delete_catalogs","create_and_edit_catalogs"],"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}]} ``` ## Retrieves a single user Retrieves a single user ### Endpoint /admin/api/#{api_version}/users/{user_id}.json (GET) ### Parameters * api_version (required): * user_id (required): ### Responses #### 200 Retrieves a single user Examples: ##### Retrieve a single user Request: ``` GET /admin/api/unstable/users/548380009.json ``` Response: ``` 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_files","custom_pixels_management","custom_pixels_view","customers","create_and_edit_customers","delete_customers","export_customers","merge_customers","dashboard","delete_products","delete_files","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","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","overviews","pages","pay_draft_orders_by_credit_card","pay_orders_by_credit_card","pay_orders_by_vaulted_card","preferences","products","refund_orders","reports","translations","themes","view_all_shopify_credit_transactions","view_balance_bank_accounts","view_files","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_markets","create_and_edit_markets","delete_markets","manage_customer_identity_providers","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","view_price_lists","delete_price_lists","create_and_edit_price_lists","view_catalogs","delete_catalogs","create_and_edit_catalogs"],"locale":"en","user_type":"regular","admin_graphql_api_id":"gid://shopify/AdminUserSerializer/548380009","tfa_enabled?":false}} ``` ## 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. ### Endpoint /admin/api/#{api_version}/users/current.json (GET) ### Parameters * api_version (required): ### Responses #### 200 Retrieves the currently logged-in user Examples: ##### Retrieve the the currently logged-in user Request: ``` GET /admin/api/unstable/users/current.json ``` Response: ``` 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_files","custom_pixels_management","custom_pixels_view","customers","create_and_edit_customers","delete_customers","export_customers","merge_customers","dashboard","delete_products","delete_files","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","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","overviews","pages","pay_draft_orders_by_credit_card","pay_orders_by_credit_card","pay_orders_by_vaulted_card","preferences","products","refund_orders","reports","translations","themes","view_all_shopify_credit_transactions","view_balance_bank_accounts","view_files","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_markets","create_and_edit_markets","delete_markets","manage_customer_identity_providers","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","view_price_lists","delete_price_lists","create_and_edit_price_lists","view_catalogs","delete_catalogs","create_and_edit_catalogs"],"locale":"en","user_type":"regular","admin_graphql_api_id":"gid://shopify/AdminUserSerializer/548380009","tfa_enabled?":false}} ```