User

Shopify Plus

The User resource is available to Shopify Plus merchants only. Contact your Merchant Success Manager to enable this API resource for your store.

The User resource lets your retrieve information about staff accounts on a Shopify shop.

The store owner can add, remove, and edit staff accounts. Staff members with full permissions can edit only the permissions of other staff accounts, and staff members with individual permissions can edit only their own staff account. The API only lets you retrieve information about staff accounts.

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 account.

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 account 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 accounts.
  • 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 a staff account.
  • collaborator: The user account of a partner who collaborates with the merchant.

Endpoints

GET /admin/users.json
Retrieves a list of all users

Retrieve a list of all users

GET /admin/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"
      ],
      "locale": "en",
      "user_type": "regular",
      "phone_validated?": false,
      "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",
      "phone_validated?": false,
      "tfa_enabled?": false
    }
  ]
}
GET /admin/users/799407056.json
Retrieves a single user

Retrieve a single user

GET /admin/users/#{user_id}.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"
    ],
    "locale": "en",
    "user_type": "regular",
    "phone_validated?": false,
    "tfa_enabled?": false
  }
}
GET /admin/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/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"
    ],
    "locale": "en",
    "user_type": "regular",
    "phone_validated?": false,
    "tfa_enabled?": false
  }
}