The REST Admin API is a legacy API as of October 1, 2024. All apps and integrations should be built with the GraphQL Admin API. For details and migration steps, visit our migration guide.

Anchor to section titled 'undefined'

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 section titled 'The User resource'

The User resource

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:

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 section titled '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 section titled 'Parameters of Retrieves a list of all users'

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.
Was this section helpful?
Anchor to section titled 'Examples of Retrieves a list of all users'

Examples

Was this section helpful?
get
/admin/api/2024-10/users.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/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_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",
        "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",
        "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
    }
  ]
}
Anchor to section titled 'GET request, Retrieves a single user'

get
Retrieves a single user

staffMember
Retrieves a single user
Anchor to section titled 'Parameters of Retrieves a single user'

Parameters

api_version
string
required
user_id
string
required
Was this section helpful?
Anchor to section titled 'Examples of Retrieves a single user'

Examples

Path parameters
userid=548380009
string
required
Was this section helpful?
get
/admin/api/2024-10/users/548380009.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/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_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",
      "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",
      "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
  }
}
Anchor to section titled '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 section titled 'Parameters of Retrieves the currently logged-in user'

Parameters

api_version
string
required
Was this section helpful?
Anchor to section titled 'Examples of Retrieves the currently logged-in user'

Examples

Was this section helpful?
get
/admin/api/2024-10/users/current.json
Copy
curl -X GET "https://your-development-store.myshopify.com/admin/api/2024-10/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_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",
      "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",
      "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
  }
}