Shopify

Shopify Users API

The Users API from Shopify — 18 operation(s) for users.

GitHub OpenAPI

Documentation

📖
Documentation
https://shopify.dev/docs/api/admin-rest
📖
Documentation
https://shopify.dev/docs/api/ajax

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/openapi/shopify-users-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-product-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-customer-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-order-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-collection-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-inventory-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-schema/shopify-fulfillment-schema.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-product-structure.json
📊
JSONStructure
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-structure/shopify-order-structure.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/json-ld/shopify-context.jsonld
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-create-product-example.json
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/examples/shopify-list-orders-example.json
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/vocabulary/shopify-vocabulary.yml
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/rules/shopify-rules.yml
🔗
Reference
https://shopify.dev/docs/api/ajax/reference

OpenAPI Specification

shopify-users-api-openapi.yml Raw ↑ 
openapi: 3.1.0
info:
  title: Shopify Admin REST About Users API
  description: The Shopify Admin REST API lets you build apps and integrations that extend and enhance the Shopify admin. Access products, customers, orders, inventory, fulfillment, and more. Endpoints are organized by resource type and versioned by release date.
  version: 2025-01
  contact:
    name: Shopify
    url: https://shopify.dev/docs/api/admin-rest
    email: api@shopify.com
  license:
    name: Shopify API Terms
    url: https://www.shopify.com/legal/api-terms
  x-date: '2026-03-04'
servers:
- url: https://{store}.myshopify.com/admin/api/2025-01
  description: Shopify Admin REST API
  variables:
    store:
      default: my-store
      description: The Shopify store subdomain
security:
- AccessToken: []
tags:
- name: Users
paths:
  /admin/api/2020-01/users.json:
    get:
      summary: Shopify Retrieves A List Of All Users
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-01
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show on a page.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: page_info
        description: A unique ID used to access a certain page of results.
        schema: {}
        required: false
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_users
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/users/{user_id}.json:
    get:
      summary: Shopify Retrieves A Single User
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-01
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          type: string
        description: user_id
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_users_param_user_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-01/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-01
      parameters: []
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202001_get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/users.json:
    get:
      summary: Shopify Retrieves A List Of All Users
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-04
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show on a page.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: page_info
        description: A unique ID used to access a certain page of results.
        schema: {}
        required: false
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_users
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/users/{user_id}.json:
    get:
      summary: Shopify Retrieves A Single User
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-04
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          type: string
        description: user_id
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_users_param_user_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-04/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-04
      parameters: []
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202004_get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/users.json:
    get:
      summary: Shopify Retrieves A List Of All Users
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-07
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show on a page.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: page_info
        description: A unique ID used to access a certain page of results.
        schema: {}
        required: false
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_users
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/users/{user_id}.json:
    get:
      summary: Shopify Retrieves A Single User
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-07
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          type: string
        description: user_id
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_users_param_user_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-07/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-07
      parameters: []
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202007_get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/users.json:
    get:
      summary: Shopify Retrieves A List Of All Users
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2020-10
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show on a page.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: page_info
        description: A unique ID used to access a certain page of results.
        schema: {}
        required: false
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: get_users
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/users/{user_id}.json:
    get:
      summary: Shopify Retrieves A Single User
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2020-10
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          type: string
        description: user_id
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: get_users_param_user_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2020-10/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2020-10
      parameters: []
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/users.json:
    get:
      summary: Shopify Retrieves A List Of All Users
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-2021-01
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show on a page.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: page_info
        description: A unique ID used to access a certain page of results.
        schema: {}
        required: false
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_users
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/users/{user_id}.json:
    get:
      summary: Shopify Retrieves A Single User
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-2021-01
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          type: string
        description: user_id
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_users_param_user_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/2021-01/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-2021-01
      parameters: []
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_202101_get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/users.json:
    get:
      summary: Shopify Retrieves A List Of All Users
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#index-unstable
      parameters:
      - in: query
        name: limit
        description: "The maximum number of results to show on a page.\n                  (default: 50, maximum: 250)"
        schema: {}
        required: false
      - in: query
        name: page_info
        description: A unique ID used to access a certain page of results.
        schema: {}
        required: false
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_users
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/users/{user_id}.json:
    get:
      summary: Shopify Retrieves A Single User
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#show-unstable
      parameters:
      - in: path
        name: user_id
        required: true
        schema:
          type: string
        description: user_id
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_users_param_user_id
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
  /admin/api/unstable/users/current.json:
    get:
      summary: Shopify Retrieves Information About The User Account Associated With The Access Token Used To Make This Api Request
      description: https://shopify.dev/docs/admin-api/rest/reference/plus/user#current-unstable
      parameters: []
      tags:
      - Users
      responses:
        '200':
          description: ''
      operationId: deprecated_unstable_get_users_current
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
components:
  securitySchemes:
    AccessToken:
      type: apiKey
      name: X-Shopify-Access-Token
      in: header
      description: Access token obtained via OAuth