User

Shopify Plus

The User resource is available to Shopify Plus merchants only.

What can you 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 }

Identifies if the user is the owner of the Shopify account

bio
{ "bio" : "A person on a mission" }

User specified description of oneself

email
{ "email" : "joe@example.com" }

Email address associated with this account

first_name
{ "first_name" : "Joe" }

The first name of the account user

id
{ "id" : 1234567890 }

The account id

im
{ "im" : "joe-chat@example.com" }

The IM account address

last_name
{ "last_name" : "Smith" }

The last name of the account user

permissions
{ "permissions" : ["full"] }
{ "permissions" : ["limited", "orders", "products"] }

The permissions that the account has. Users will either have "full" or "limited" permissions. Limited permissions are scoped to a user in that they can only view certain parts of the Shopify Admin

The types of permissions a limited user can have are as follows:

  • dashboard: Can see Shop performance and statistics
  • orders: Can view and modify orders
  • customers: Can view and modify customers
  • marketing: Can view and modify marketing related products such as discount codes
  • products: Can view and modify products
  • gift_cards: Can view and modify gift cards
  • pages: Can view and modify shop pages
  • links: Can view and modify links and menus
  • themes: Can view and modify shop themes
  • applications: Can authorize the installation of third party applications
  • preferences: Can view the preferences and configuration of a shop
  • reports: Can view and create reports

phone
{ "phone" : "(555) 555-5555" }

Phone number associated with the account

pin
{ "pin" : "1234" }

Point of Sale Access Code for this account. Pin is deprecated and will be removed on 2014-08-01.

receive_announcements
{ "receive_announcements" : 0 }

Whether or not this account will receive email announcements from Shopify

screen_name
{ "screen_name" : "joesmith" }

screen_name is deprecated and will be removed on 2014-08-01.

url
{ "url" : "http://example.com" }

Homepage or other web address

user_type
{ "user_type" : "regular" }

The type that the account is:

  • regular - A normal account that can access the web admin
  • open_id - A user account that uses google authentication to access web admin
  • restricted - A user account that cannot access the web admin

Endpoints

GET/admin/users.json

Get all the 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"
      ],
      "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": [
        "limited"
      ],
      "user_type": "regular",
      "phone_validated?": false,
      "tfa_enabled?": false
    }
  ]
}
GET/admin/users/799407056.json

Get a user

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

Retrieve information about the user account associated with the access token used to make this api request. This request is useful only when the access token was created for a specific user of the shop.

Get the current 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"
    ],
    "user_type": "regular",
    "phone_validated?": false,
    "tfa_enabled?": false
  }
}