API version: unstable
API version: 2021-07 Release candidate
API version: 2021-04 Latest
API version: 2021-01
API version: 2020-10
API version: 2020-07
API version: 2020-04
API version: 2020-01 Unsupported
API version: 2019-10 Unsupported

User

Version 2019-10

Shopify Plus

The User resource is available for private apps and custom apps installed on Shopify Plus stores. Contact Shopify Plus Support to enable this API resource for your store.

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.

What you can do with User

The Shopify API lets you do the following with the User resource. More detailed versions of these general actions may be available:

User properties

account_owner 
"account_owner": false

Whether the user is the owner of the Shopify account.
bio 
"bio": "A person on a mission"

The description the user has written for themselves.
email 
"email": "joe@example.com"

The user's email address.
first_name 
"first_name": "Joe"

The user's first name.
id 
"id": 1234567890

The ID of the user's staff.
im 
"im": "joe-chat@example.com"

The user's IM account address.
last_name 
"last_name": "Smith"

The user's last name.
permissions 
"permissions": [
  "full"
]

The permissions that the user's staff has. Users will either have full permissions or a list of specific permissions. Valid values:

  • full: The user has the same permissions as the account owner with some exceptions, such as modifying the account billing or deleting staff.
  • dashboard: The user can see statistics on the shop's performance.
  • orders: The user can view and modify orders.
  • customers: The user can view and modify customers.
  • marketing: The user can view and modify marketing related products such as discount codes.
  • products: The user can view and modify products.
  • gift_cards: The user can view and modify gift cards.
  • pages: The user can view and modify shop pages.
  • links: The user can view and modify links and menus.
  • themes: The user can view and modify shop themes.
  • applications: The user can authorize the installation of third-party applications.
  • preferences: The user can view the preferences and configuration of a shop.
  • reports: The user can view and create reports.
phone 
"phone": "(555) 555-5555"

The user's phone number.
receive_announcements 
"receive_announcements": 0

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

screen_name
deprecated 
"screen_name": "joesmith"

This property is deprecated.
url 
"url": "http://example.com"

The user's homepage or other web address.
locale 
"locale": "en"

The user'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
user_type 
"user_type": "regular"

The type of account the user has. Valid values:

  • regular: The user's account can access the Shopify admin.
  • restricted: The user's account cannot access the Shopify admin.
  • invited: The user has not yet accepted the invitation to create staff.
  • collaborator: The user account of a partner who collaborates with the merchant.

Endpoints

GET /admin/api/2019-10/users.json
Retrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit

The maximum number of results to show on a page.

(default: 50, maximum: 250)
page_info

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

Retrieve a list of all users

GET /admin/api/2019-10/users.json
View Response 
HTTP/1.1 200 OK
{
  "users": [
    {
      "id": 799407056,
      "first_name": "Steve",
      "email": "steve@apple.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": true,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [
        "full",
        "applications",
        "channels",
        "customers",
        "dashboard",
        "domains",
        "draft_orders",
        "edit_orders",
        "edit_private_apps",
        "gift_cards",
        "links",
        "locations",
        "marketing",
        "marketing_section",
        "orders",
        "overviews",
        "pages",
        "preferences",
        "products",
        "reports",
        "translations",
        "themes",
        "view_private_apps",
        "shopify_payments_accounts",
        "shopify_payments_transfers",
        "staff_audit_log_view",
        "staff_management_update",
        "applications_billing",
        "attestation_authority",
        "authentication_management",
        "balance_bank_accounts_management",
        "billing_application_charges",
        "billing_charges",
        "billing_invoices_pay",
        "billing_invoices_view",
        "billing_payment_methods_manage",
        "billing_payment_methods_view",
        "billing_settings",
        "billing_subscriptions",
        "capital",
        "customer_private_data",
        "domains_management",
        "enable_private_apps",
        "experiments_management",
        "gdpr_actions",
        "payment_settings",
        "shopify_payments",
        "staff_api_permission_management",
        "staff_management",
        "staff_management_activation",
        "staff_management_create",
        "staff_management_delete",
        "support_methods",
        "export_customers",
        "export_draft_orders",
        "export_orders",
        "export_products"
      ],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
      "tfa_enabled?": false
    },
    {
      "id": 930143300,
      "first_name": "noaccesssteve",
      "email": "noaccesssteve@jobs.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": false,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/930143300",
      "tfa_enabled?": false
    }
  ]
}
GET /admin/api/2019-10/users/{user_id}.json
Retrieves a single user

Retrieve a single user

GET /admin/api/2019-10/users/799407056.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
GET /admin/api/2019-10/users/current.json
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.

Retrieve the the currently logged-in user

GET /admin/api/2019-10/users/current.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
Version 2020-01

Shopify Plus

The User resource is available for private apps and custom apps installed on Shopify Plus stores. Contact Shopify Plus Support to enable this API resource for your store.

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.

What you can do with User

The Shopify API lets you do the following with the User resource. More detailed versions of these general actions may be available:

User properties

account_owner 
"account_owner": false

Whether the user is the owner of the Shopify account.
bio 
"bio": "A person on a mission"

The description the user has written for themselves.
email 
"email": "joe@example.com"

The user's email address.
first_name 
"first_name": "Joe"

The user's first name.
id 
"id": 1234567890

The ID of the user's staff.
im 
"im": "joe-chat@example.com"

The user's IM account address.
last_name 
"last_name": "Smith"

The user's last name.
permissions 
"permissions": [
  "full"
]

The permissions that the user's staff has. Users will either have full permissions or a list of specific permissions. Valid values:

  • full: The user has the same permissions as the account owner with some exceptions, such as modifying the account billing or deleting staff.
  • dashboard: The user can see statistics on the shop's performance.
  • orders: The user can view and modify orders.
  • customers: The user can view and modify customers.
  • marketing: The user can view and modify marketing related products such as discount codes.
  • products: The user can view and modify products.
  • gift_cards: The user can view and modify gift cards.
  • pages: The user can view and modify shop pages.
  • links: The user can view and modify links and menus.
  • themes: The user can view and modify shop themes.
  • applications: The user can authorize the installation of third-party applications.
  • preferences: The user can view the preferences and configuration of a shop.
  • reports: The user can view and create reports.
phone 
"phone": "(555) 555-5555"

The user's phone number.
receive_announcements 
"receive_announcements": 0

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

screen_name
deprecated 
"screen_name": "joesmith"

This property is deprecated.
url 
"url": "http://example.com"

The user's homepage or other web address.
locale 
"locale": "en"

The user'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
user_type 
"user_type": "regular"

The type of account the user has. Valid values:

  • regular: The user's account can access the Shopify admin.
  • restricted: The user's account cannot access the Shopify admin.
  • invited: The user has not yet accepted the invitation to create staff.
  • collaborator: The user account of a partner who collaborates with the merchant.

Endpoints

GET /admin/api/2020-01/users.json
Retrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit

The maximum number of results to show on a page.

(default: 50, maximum: 250)
page_info

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

Retrieve a list of all users

GET /admin/api/2020-01/users.json
View Response 
HTTP/1.1 200 OK
{
  "users": [
    {
      "id": 799407056,
      "first_name": "Steve",
      "email": "steve@apple.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": true,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [
        "full",
        "applications",
        "channels",
        "customers",
        "dashboard",
        "domains",
        "draft_orders",
        "edit_orders",
        "edit_private_apps",
        "gift_cards",
        "links",
        "locations",
        "marketing",
        "marketing_section",
        "orders",
        "overviews",
        "pages",
        "preferences",
        "products",
        "reports",
        "translations",
        "themes",
        "view_private_apps",
        "shopify_payments_accounts",
        "shopify_payments_transfers",
        "staff_audit_log_view",
        "staff_management_update",
        "applications_billing",
        "attestation_authority",
        "authentication_management",
        "balance_bank_accounts_management",
        "billing_application_charges",
        "billing_charges",
        "billing_invoices_pay",
        "billing_invoices_view",
        "billing_payment_methods_manage",
        "billing_payment_methods_view",
        "billing_settings",
        "billing_subscriptions",
        "capital",
        "customer_private_data",
        "domains_management",
        "enable_private_apps",
        "experiments_management",
        "gdpr_actions",
        "payment_settings",
        "shopify_payments",
        "staff_api_permission_management",
        "staff_management",
        "staff_management_activation",
        "staff_management_create",
        "staff_management_delete",
        "support_methods",
        "export_customers",
        "export_draft_orders",
        "export_orders",
        "export_products"
      ],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
      "tfa_enabled?": false
    },
    {
      "id": 930143300,
      "first_name": "noaccesssteve",
      "email": "noaccesssteve@jobs.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": false,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/930143300",
      "tfa_enabled?": false
    }
  ]
}
GET /admin/api/2020-01/users/{user_id}.json
Retrieves a single user

Retrieve a single user

GET /admin/api/2020-01/users/799407056.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
GET /admin/api/2020-01/users/current.json
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.

Retrieve the the currently logged-in user

GET /admin/api/2020-01/users/current.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
Version 2020-04

Shopify Plus

The User resource is available for private apps and custom apps installed on Shopify Plus stores. Contact Shopify Plus Support to enable this API resource for your store.

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.

What you can do with User

The Shopify API lets you do the following with the User resource. More detailed versions of these general actions may be available:

User properties

account_owner 
"account_owner": false

Whether the user is the owner of the Shopify account.
bio 
"bio": "A person on a mission"

The description the user has written for themselves.
email 
"email": "joe@example.com"

The user's email address.
first_name 
"first_name": "Joe"

The user's first name.
id 
"id": 1234567890

The ID of the user's staff.
im 
"im": "joe-chat@example.com"

The user's IM account address.
last_name 
"last_name": "Smith"

The user's last name.
permissions 
"permissions": [
  "full"
]

The permissions that the user's staff has. Users will either have full permissions or a list of specific permissions. Valid values:

  • full: The user has the same permissions as the account owner with some exceptions, such as modifying the account billing or deleting staff.
  • dashboard: The user can see statistics on the shop's performance.
  • orders: The user can view and modify orders.
  • customers: The user can view and modify customers.
  • marketing: The user can view and modify marketing related products such as discount codes.
  • products: The user can view and modify products.
  • gift_cards: The user can view and modify gift cards.
  • pages: The user can view and modify shop pages.
  • links: The user can view and modify links and menus.
  • themes: The user can view and modify shop themes.
  • applications: The user can authorize the installation of third-party applications.
  • preferences: The user can view the preferences and configuration of a shop.
  • reports: The user can view and create reports.
phone 
"phone": "(555) 555-5555"

The user's phone number.
receive_announcements 
"receive_announcements": 0

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

screen_name
deprecated 
"screen_name": "joesmith"

This property is deprecated.
url 
"url": "http://example.com"

The user's homepage or other web address.
locale 
"locale": "en"

The user'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
user_type 
"user_type": "regular"

The type of account the user has. Valid values:

  • regular: The user's account can access the Shopify admin.
  • restricted: The user's account cannot access the Shopify admin.
  • invited: The user has not yet accepted the invitation to create staff.
  • collaborator: The user account of a partner who collaborates with the merchant.

Endpoints

GET /admin/api/2020-04/users.json
Retrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit

The maximum number of results to show on a page.

(default: 50, maximum: 250)
page_info

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

Retrieve a list of all users

GET /admin/api/2020-04/users.json
View Response 
HTTP/1.1 200 OK
{
  "users": [
    {
      "id": 799407056,
      "first_name": "Steve",
      "email": "steve@apple.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": true,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [
        "full",
        "applications",
        "channels",
        "customers",
        "dashboard",
        "domains",
        "draft_orders",
        "edit_orders",
        "edit_private_apps",
        "gift_cards",
        "links",
        "locations",
        "marketing",
        "marketing_section",
        "orders",
        "overviews",
        "pages",
        "preferences",
        "products",
        "reports",
        "translations",
        "themes",
        "view_private_apps",
        "shopify_payments_accounts",
        "shopify_payments_transfers",
        "staff_audit_log_view",
        "staff_management_update",
        "applications_billing",
        "attestation_authority",
        "authentication_management",
        "balance_bank_accounts_management",
        "billing_application_charges",
        "billing_charges",
        "billing_invoices_pay",
        "billing_invoices_view",
        "billing_payment_methods_manage",
        "billing_payment_methods_view",
        "billing_settings",
        "billing_subscriptions",
        "capital",
        "customer_private_data",
        "domains_management",
        "enable_private_apps",
        "experiments_management",
        "gdpr_actions",
        "payment_settings",
        "shopify_payments",
        "staff_api_permission_management",
        "staff_management",
        "staff_management_activation",
        "staff_management_create",
        "staff_management_delete",
        "support_methods",
        "export_customers",
        "export_draft_orders",
        "export_orders",
        "export_products"
      ],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
      "tfa_enabled?": false
    },
    {
      "id": 930143300,
      "first_name": "noaccesssteve",
      "email": "noaccesssteve@jobs.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": false,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/930143300",
      "tfa_enabled?": false
    }
  ]
}
GET /admin/api/2020-04/users/{user_id}.json
Retrieves a single user

Retrieve a single user

GET /admin/api/2020-04/users/799407056.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
GET /admin/api/2020-04/users/current.json
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.

Retrieve the the currently logged-in user

GET /admin/api/2020-04/users/current.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
Version 2020-07

Shopify Plus

The User resource is available for private apps and custom apps installed on Shopify Plus stores. Contact Shopify Plus Support to enable this API resource for your store.

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.

What you can do with User

The Shopify API lets you do the following with the User resource. More detailed versions of these general actions may be available:

User properties

account_owner 
"account_owner": false

Whether the user is the owner of the Shopify account.
bio 
"bio": "A person on a mission"

The description the user has written for themselves.
email 
"email": "joe@example.com"

The user's email address.
first_name 
"first_name": "Joe"

The user's first name.
id 
"id": 1234567890

The ID of the user's staff.
im 
"im": "joe-chat@example.com"

The user's IM account address.
last_name 
"last_name": "Smith"

The user's last name.
permissions 
"permissions": [
  "full"
]

The permissions that the user's staff has. Users will either have full permissions or a list of specific permissions. Valid values:

  • full: The user has the same permissions as the account owner with some exceptions, such as modifying the account billing or deleting staff.
  • dashboard: The user can see statistics on the shop's performance.
  • orders: The user can view and modify orders.
  • customers: The user can view and modify customers.
  • marketing: The user can view and modify marketing related products such as discount codes.
  • products: The user can view and modify products.
  • gift_cards: The user can view and modify gift cards.
  • pages: The user can view and modify shop pages.
  • links: The user can view and modify links and menus.
  • themes: The user can view and modify shop themes.
  • applications: The user can authorize the installation of third-party applications.
  • preferences: The user can view the preferences and configuration of a shop.
  • reports: The user can view and create reports.
phone 
"phone": "(555) 555-5555"

The user's phone number.
receive_announcements 
"receive_announcements": 0

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

screen_name
deprecated 
"screen_name": "joesmith"

This property is deprecated.
url 
"url": "http://example.com"

The user's homepage or other web address.
locale 
"locale": "en"

The user'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
user_type 
"user_type": "regular"

The type of account the user has. Valid values:

  • regular: The user's account can access the Shopify admin.
  • restricted: The user's account cannot access the Shopify admin.
  • invited: The user has not yet accepted the invitation to create staff.
  • collaborator: The user account of a partner who collaborates with the merchant.

Endpoints

GET /admin/api/2020-07/users.json
Retrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit

The maximum number of results to show on a page.

(default: 50, maximum: 250)
page_info

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

Retrieve a list of all users

GET /admin/api/2020-07/users.json
View Response 
HTTP/1.1 200 OK
{
  "users": [
    {
      "id": 799407056,
      "first_name": "Steve",
      "email": "steve@apple.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": true,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [
        "full",
        "applications",
        "channels",
        "customers",
        "dashboard",
        "domains",
        "draft_orders",
        "edit_orders",
        "edit_private_apps",
        "gift_cards",
        "links",
        "locations",
        "marketing",
        "marketing_section",
        "orders",
        "overviews",
        "pages",
        "preferences",
        "products",
        "reports",
        "translations",
        "themes",
        "view_private_apps",
        "shopify_payments_accounts",
        "shopify_payments_transfers",
        "staff_audit_log_view",
        "staff_management_update",
        "applications_billing",
        "attestation_authority",
        "authentication_management",
        "balance_bank_accounts_management",
        "billing_application_charges",
        "billing_charges",
        "billing_invoices_pay",
        "billing_invoices_view",
        "billing_payment_methods_manage",
        "billing_payment_methods_view",
        "billing_settings",
        "billing_subscriptions",
        "capital",
        "customer_private_data",
        "domains_management",
        "enable_private_apps",
        "experiments_management",
        "gdpr_actions",
        "payment_settings",
        "shopify_payments",
        "staff_api_permission_management",
        "staff_management",
        "staff_management_activation",
        "staff_management_create",
        "staff_management_delete",
        "support_methods",
        "export_customers",
        "export_draft_orders",
        "export_orders",
        "export_products"
      ],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
      "tfa_enabled?": false
    },
    {
      "id": 930143300,
      "first_name": "noaccesssteve",
      "email": "noaccesssteve@jobs.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": false,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/930143300",
      "tfa_enabled?": false
    }
  ]
}
GET /admin/api/2020-07/users/{user_id}.json
Retrieves a single user

Retrieve a single user

GET /admin/api/2020-07/users/799407056.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
GET /admin/api/2020-07/users/current.json
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.

Retrieve the the currently logged-in user

GET /admin/api/2020-07/users/current.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
Version 2020-10

Shopify Plus

The User resource is available for private apps and custom apps installed on Shopify Plus stores. Contact Shopify Plus Support to enable this API resource for your store.

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.

What you can do with User

The Shopify API lets you do the following with the User resource. More detailed versions of these general actions may be available:

User properties

account_owner 
"account_owner": false

Whether the user is the owner of the Shopify account.
bio 
"bio": "A person on a mission"

The description the user has written for themselves.
email 
"email": "joe@example.com"

The user's email address.
first_name 
"first_name": "Joe"

The user's first name.
id 
"id": 1234567890

The ID of the user's staff.
im 
"im": "joe-chat@example.com"

The user's IM account address.
last_name 
"last_name": "Smith"

The user's last name.
permissions 
"permissions": [
  "full"
]

The permissions that the user's staff has. Users will either have full permissions or a list of specific permissions. Valid values:

  • full: The user has the same permissions as the account owner with some exceptions, such as modifying the account billing or deleting staff.
  • dashboard: The user can see statistics on the shop's performance.
  • orders: The user can view and modify orders.
  • customers: The user can view and modify customers.
  • marketing: The user can view and modify marketing related products such as discount codes.
  • products: The user can view and modify products.
  • gift_cards: The user can view and modify gift cards.
  • pages: The user can view and modify shop pages.
  • links: The user can view and modify links and menus.
  • themes: The user can view and modify shop themes.
  • applications: The user can authorize the installation of third-party applications.
  • preferences: The user can view the preferences and configuration of a shop.
  • reports: The user can view and create reports.
phone 
"phone": "(555) 555-5555"

The user's phone number.
receive_announcements 
"receive_announcements": 0

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

screen_name
deprecated 
"screen_name": "joesmith"

This property is deprecated.
url 
"url": "http://example.com"

The user's homepage or other web address.
locale 
"locale": "en"

The user'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
user_type 
"user_type": "regular"

The type of account the user has. Valid values:

  • regular: The user's account can access the Shopify admin.
  • restricted: The user's account cannot access the Shopify admin.
  • invited: The user has not yet accepted the invitation to create staff.
  • collaborator: The user account of a partner who collaborates with the merchant.

Endpoints

GET /admin/api/2020-10/users.json
Retrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit

The maximum number of results to show on a page.

(default: 50, maximum: 250)
page_info

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

Retrieve a list of all users

GET /admin/api/2020-10/users.json
View Response 
HTTP/1.1 200 OK
{
  "users": [
    {
      "id": 799407056,
      "first_name": "Steve",
      "email": "steve@apple.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": true,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [
        "full",
        "applications",
        "channels",
        "customers",
        "dashboard",
        "domains",
        "draft_orders",
        "edit_orders",
        "edit_private_apps",
        "gift_cards",
        "links",
        "locations",
        "marketing",
        "marketing_section",
        "orders",
        "overviews",
        "pages",
        "preferences",
        "products",
        "reports",
        "translations",
        "themes",
        "view_private_apps",
        "shopify_payments_accounts",
        "shopify_payments_transfers",
        "staff_audit_log_view",
        "staff_management_update",
        "applications_billing",
        "attestation_authority",
        "authentication_management",
        "balance_bank_accounts_management",
        "billing_application_charges",
        "billing_charges",
        "billing_invoices_pay",
        "billing_invoices_view",
        "billing_payment_methods_manage",
        "billing_payment_methods_view",
        "billing_settings",
        "billing_subscriptions",
        "capital",
        "customer_private_data",
        "domains_management",
        "enable_private_apps",
        "experiments_management",
        "gdpr_actions",
        "payment_settings",
        "shopify_payments",
        "staff_api_permission_management",
        "staff_management",
        "staff_management_activation",
        "staff_management_create",
        "staff_management_delete",
        "support_methods",
        "export_customers",
        "export_draft_orders",
        "export_orders",
        "export_products"
      ],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
      "tfa_enabled?": false
    },
    {
      "id": 930143300,
      "first_name": "noaccesssteve",
      "email": "noaccesssteve@jobs.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": false,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/930143300",
      "tfa_enabled?": false
    }
  ]
}
GET /admin/api/2020-10/users/{user_id}.json
Retrieves a single user

Retrieve a single user

GET /admin/api/2020-10/users/799407056.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
GET /admin/api/2020-10/users/current.json
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.

Retrieve the the currently logged-in user

GET /admin/api/2020-10/users/current.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
Version 2021-01

Shopify Plus

The User resource is available for private apps and custom apps installed on Shopify Plus stores. Contact Shopify Plus Support to enable this API resource for your store.

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.

What you can do with User

The Shopify API lets you do the following with the User resource. More detailed versions of these general actions may be available:

User properties

account_owner 
"account_owner": false

Whether the user is the owner of the Shopify account.
bio 
"bio": "A person on a mission"

The description the user has written for themselves.
email 
"email": "joe@example.com"

The user's email address.
first_name 
"first_name": "Joe"

The user's first name.
id 
"id": 1234567890

The ID of the user's staff.
im 
"im": "joe-chat@example.com"

The user's IM account address.
last_name 
"last_name": "Smith"

The user's last name.
permissions 
"permissions": [
  "full"
]

The permissions that the user's staff has. Users will either have full permissions or a list of specific permissions. Valid values:

  • full: The user has the same permissions as the account owner with some exceptions, such as modifying the account billing or deleting staff.
  • dashboard: The user can see statistics on the shop's performance.
  • orders: The user can view and modify orders.
  • customers: The user can view and modify customers.
  • marketing: The user can view and modify marketing related products such as discount codes.
  • products: The user can view and modify products.
  • gift_cards: The user can view and modify gift cards.
  • pages: The user can view and modify shop pages.
  • links: The user can view and modify links and menus.
  • themes: The user can view and modify shop themes.
  • applications: The user can authorize the installation of third-party applications.
  • preferences: The user can view the preferences and configuration of a shop.
  • reports: The user can view and create reports.
phone 
"phone": "(555) 555-5555"

The user's phone number.
receive_announcements 
"receive_announcements": 0

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

screen_name
deprecated 
"screen_name": "joesmith"

This property is deprecated.
url 
"url": "http://example.com"

The user's homepage or other web address.
locale 
"locale": "en"

The user'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
user_type 
"user_type": "regular"

The type of account the user has. Valid values:

  • regular: The user's account can access the Shopify admin.
  • restricted: The user's account cannot access the Shopify admin.
  • invited: The user has not yet accepted the invitation to create staff.
  • collaborator: The user account of a partner who collaborates with the merchant.

Endpoints

GET /admin/api/2021-01/users.json
Retrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit

The maximum number of results to show on a page.

(default: 50, maximum: 250)
page_info

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

Retrieve a list of all users

GET /admin/api/2021-01/users.json
View Response 
HTTP/1.1 200 OK
{
  "users": [
    {
      "id": 799407056,
      "first_name": "Steve",
      "email": "steve@apple.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": true,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [
        "full",
        "applications",
        "channels",
        "customers",
        "dashboard",
        "domains",
        "draft_orders",
        "edit_orders",
        "edit_private_apps",
        "gift_cards",
        "links",
        "locations",
        "marketing",
        "marketing_section",
        "orders",
        "overviews",
        "pages",
        "preferences",
        "products",
        "reports",
        "translations",
        "themes",
        "view_private_apps",
        "shopify_payments_accounts",
        "shopify_payments_transfers",
        "staff_audit_log_view",
        "staff_management_update",
        "applications_billing",
        "attestation_authority",
        "authentication_management",
        "balance_bank_accounts_management",
        "billing_application_charges",
        "billing_charges",
        "billing_invoices_pay",
        "billing_invoices_view",
        "billing_payment_methods_manage",
        "billing_payment_methods_view",
        "billing_settings",
        "billing_subscriptions",
        "capital",
        "customer_private_data",
        "domains_management",
        "enable_private_apps",
        "experiments_management",
        "gdpr_actions",
        "payment_settings",
        "shopify_payments",
        "staff_api_permission_management",
        "staff_management",
        "staff_management_activation",
        "staff_management_create",
        "staff_management_delete",
        "support_methods",
        "export_customers",
        "export_draft_orders",
        "export_orders",
        "export_products"
      ],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
      "tfa_enabled?": false
    },
    {
      "id": 930143300,
      "first_name": "noaccesssteve",
      "email": "noaccesssteve@jobs.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": false,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/930143300",
      "tfa_enabled?": false
    }
  ]
}
GET /admin/api/2021-01/users/{user_id}.json
Retrieves a single user

Retrieve a single user

GET /admin/api/2021-01/users/799407056.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
GET /admin/api/2021-01/users/current.json
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.

Retrieve the the currently logged-in user

GET /admin/api/2021-01/users/current.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
Version 2021-04 (Latest)

Shopify Plus

The User resource is available for private apps and custom apps installed on Shopify Plus stores. Contact Shopify Plus Support to enable this API resource for your store.

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.

What you can do with User

The Shopify API lets you do the following with the User resource. More detailed versions of these general actions may be available:

User properties

account_owner 
"account_owner": false

Whether the user is the owner of the Shopify account.
bio 
"bio": "A person on a mission"

The description the user has written for themselves.
email 
"email": "joe@example.com"

The user's email address.
first_name 
"first_name": "Joe"

The user's first name.
id 
"id": 1234567890

The ID of the user's staff.
im 
"im": "joe-chat@example.com"

The user's IM account address.
last_name 
"last_name": "Smith"

The user's last name.
permissions 
"permissions": [
  "full"
]

The permissions that the user's staff has. Users will either have full permissions or a list of specific permissions. Valid values:

  • full: The user has the same permissions as the account owner with some exceptions, such as modifying the account billing or deleting staff.
  • dashboard: The user can see statistics on the shop's performance.
  • orders: The user can view and modify orders.
  • customers: The user can view and modify customers.
  • marketing: The user can view and modify marketing related products such as discount codes.
  • products: The user can view and modify products.
  • gift_cards: The user can view and modify gift cards.
  • pages: The user can view and modify shop pages.
  • links: The user can view and modify links and menus.
  • themes: The user can view and modify shop themes.
  • applications: The user can authorize the installation of third-party applications.
  • preferences: The user can view the preferences and configuration of a shop.
  • reports: The user can view and create reports.
phone 
"phone": "(555) 555-5555"

The user's phone number.
receive_announcements 
"receive_announcements": 0

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

screen_name
deprecated 
"screen_name": "joesmith"

This property is deprecated.
url 
"url": "http://example.com"

The user's homepage or other web address.
locale 
"locale": "en"

The user'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
user_type 
"user_type": "regular"

The type of account the user has. Valid values:

  • regular: The user's account can access the Shopify admin.
  • restricted: The user's account cannot access the Shopify admin.
  • invited: The user has not yet accepted the invitation to create staff.
  • collaborator: The user account of a partner who collaborates with the merchant.

Endpoints

GET /admin/api/2021-04/users.json
Retrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit

The maximum number of results to show on a page.

(default: 50, maximum: 250)
page_info

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

Retrieve a list of all users

GET /admin/api/2021-04/users.json
View Response 
HTTP/1.1 200 OK
{
  "users": [
    {
      "id": 799407056,
      "first_name": "Steve",
      "email": "steve@apple.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": true,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [
        "full",
        "applications",
        "channels",
        "customers",
        "dashboard",
        "domains",
        "draft_orders",
        "edit_orders",
        "edit_private_apps",
        "gift_cards",
        "links",
        "locations",
        "marketing",
        "marketing_section",
        "orders",
        "overviews",
        "pages",
        "preferences",
        "products",
        "reports",
        "translations",
        "themes",
        "view_private_apps",
        "shopify_payments_accounts",
        "shopify_payments_transfers",
        "staff_audit_log_view",
        "staff_management_update",
        "applications_billing",
        "attestation_authority",
        "authentication_management",
        "balance_bank_accounts_management",
        "billing_application_charges",
        "billing_charges",
        "billing_invoices_pay",
        "billing_invoices_view",
        "billing_payment_methods_manage",
        "billing_payment_methods_view",
        "billing_settings",
        "billing_subscriptions",
        "capital",
        "customer_private_data",
        "domains_management",
        "enable_private_apps",
        "experiments_management",
        "gdpr_actions",
        "payment_settings",
        "shopify_payments",
        "staff_api_permission_management",
        "staff_management",
        "staff_management_activation",
        "staff_management_create",
        "staff_management_delete",
        "support_methods",
        "export_customers",
        "export_draft_orders",
        "export_orders",
        "export_products"
      ],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
      "tfa_enabled?": false
    },
    {
      "id": 930143300,
      "first_name": "noaccesssteve",
      "email": "noaccesssteve@jobs.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": false,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/930143300",
      "tfa_enabled?": false
    }
  ]
}
GET /admin/api/2021-04/users/{user_id}.json
Retrieves a single user

Retrieve a single user

GET /admin/api/2021-04/users/799407056.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
GET /admin/api/2021-04/users/current.json
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.

Retrieve the the currently logged-in user

GET /admin/api/2021-04/users/current.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
Version 2021-07 (Release candidate)

Shopify Plus

The User resource is available for private apps and custom apps installed on Shopify Plus stores. Contact Shopify Plus Support to enable this API resource for your store.

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.

What you can do with User

The Shopify API lets you do the following with the User resource. More detailed versions of these general actions may be available:

User properties

account_owner 
"account_owner": false

Whether the user is the owner of the Shopify account.
bio 
"bio": "A person on a mission"

The description the user has written for themselves.
email 
"email": "joe@example.com"

The user's email address.
first_name 
"first_name": "Joe"

The user's first name.
id 
"id": 1234567890

The ID of the user's staff.
im 
"im": "joe-chat@example.com"

The user's IM account address.
last_name 
"last_name": "Smith"

The user's last name.
permissions 
"permissions": [
  "customers",
  "dashboard",
  "reports"
]

The permissions that the user's staff has. Users have a list of specific permissions. Valid values:

  • applications: The user can authorize the installation of third-party applications.
  • 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.
  • full: The user has the same permissions as the store owner with some exceptions, such as modifying the account billing or deleting staff accounts. The complete list of explicit permissions that a user with the full permission has access to are returned in the permissions field.
  • 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": "(555) 555-5555"

The user's phone number.
receive_announcements 
"receive_announcements": 0

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

screen_name
deprecated 
"screen_name": "joesmith"

This property is deprecated.
url 
"url": "http://example.com"

The user's homepage or other web address.
locale 
"locale": "en"

The user'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
user_type 
"user_type": "regular"

The type of account the user has. Valid values:

  • regular: The user's account can access the Shopify admin.
  • restricted: The user's account cannot access the Shopify admin.
  • invited: The user has not yet accepted the invitation to create staff.
  • collaborator: The user account of a partner who collaborates with the merchant.

Endpoints

GET /admin/api/2021-07/users.json
Retrieves a list of all users. Note: As of version 2021-01, this endpoint implements pagination by using links that are provided in the response header. Sending the page parameter will return an error. To learn more, see Making requests to paginated REST Admin API endpoints.
limit

The maximum number of results to show on a page.

(default: 50, maximum: 250)
page_info

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

Retrieve a list of all users

GET /admin/api/2021-07/users.json
View Response 
HTTP/1.1 200 OK
{
  "users": [
    {
      "id": 799407056,
      "first_name": "Steve",
      "email": "steve@apple.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": true,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [
        "full",
        "applications",
        "channels",
        "customers",
        "dashboard",
        "domains",
        "draft_orders",
        "edit_orders",
        "edit_private_apps",
        "gift_cards",
        "links",
        "locations",
        "marketing",
        "marketing_section",
        "orders",
        "overviews",
        "pages",
        "preferences",
        "products",
        "reports",
        "translations",
        "themes",
        "view_private_apps",
        "shopify_payments_accounts",
        "shopify_payments_transfers",
        "staff_audit_log_view",
        "staff_management_update",
        "applications_billing",
        "attestation_authority",
        "authentication_management",
        "balance_bank_accounts_management",
        "billing_application_charges",
        "billing_charges",
        "billing_invoices_pay",
        "billing_invoices_view",
        "billing_payment_methods_manage",
        "billing_payment_methods_view",
        "billing_settings",
        "billing_subscriptions",
        "capital",
        "customer_private_data",
        "domains_management",
        "enable_private_apps",
        "experiments_management",
        "gdpr_actions",
        "payment_settings",
        "shopify_payments",
        "staff_api_permission_management",
        "staff_management",
        "staff_management_activation",
        "staff_management_create",
        "staff_management_delete",
        "support_methods",
        "export_customers",
        "export_draft_orders",
        "export_orders",
        "export_products"
      ],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
      "tfa_enabled?": false
    },
    {
      "id": 930143300,
      "first_name": "noaccesssteve",
      "email": "noaccesssteve@jobs.com",
      "url": "www.apple.com",
      "im": null,
      "screen_name": null,
      "phone": null,
      "last_name": "Jobs",
      "account_owner": false,
      "receive_announcements": 1,
      "bio": null,
      "permissions": [],
      "locale": "en",
      "user_type": "regular",
      "admin_graphql_api_id": "gid://shopify/StaffMember/930143300",
      "tfa_enabled?": false
    }
  ]
}
GET /admin/api/2021-07/users/{user_id}.json
Retrieves a single user

Retrieve a single user

GET /admin/api/2021-07/users/799407056.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",
      "preferences",
      "products",
      "reports",
      "translations",
      "themes",
      "view_private_apps",
      "shopify_payments_accounts",
      "shopify_payments_transfers",
      "staff_audit_log_view",
      "staff_management_update",
      "applications_billing",
      "attestation_authority",
      "authentication_management",
      "balance_bank_accounts_management",
      "billing_application_charges",
      "billing_charges",
      "billing_invoices_pay",
      "billing_invoices_view",
      "billing_payment_methods_manage",
      "billing_payment_methods_view",
      "billing_settings",
      "billing_subscriptions",
      "capital",
      "customer_private_data",
      "domains_management",
      "enable_private_apps",
      "experiments_management",
      "gdpr_actions",
      "payment_settings",
      "shopify_payments",
      "staff_api_permission_management",
      "staff_management",
      "staff_management_activation",
      "staff_management_create",
      "staff_management_delete",
      "support_methods",
      "export_customers",
      "export_draft_orders",
      "export_orders",
      "export_products"
    ],
    "locale": "en",
    "user_type": "regular",
    "admin_graphql_api_id": "gid://shopify/StaffMember/799407056",
    "tfa_enabled?": false
  }
}
GET /admin/api/2021-07/users/current.json
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.

Retrieve the the currently logged-in user

GET /admin/api/2021-07/users/current.json
View Response 
HTTP/1.1 200 OK
{
  "user": {
    "id": 799407056,
    "first_name": "Steve",
    "email": "steve@apple.com",
    "url": "www.apple.com",
    "im": null,
    "screen_name": null,
    "phone": null,
    "last_name": "Jobs",
    "account_owner": true,
    "receive_announcements": 1,
    "bio": null,
    "permissions": [
      "full",
      "applications",
      "channels",
      "customers",
      "dashboard",
      "domains",
      "draft_orders",
      "edit_orders",
      "edit_private_apps",
      "gift_cards",
      "links",
      "locations",
      "marketing",
      "marketing_section",
      "orders",
      "overviews",
      "pages",