users

List users

Changed on Oct 22, 2026

<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Lists the users of your ShipStation account, with optional filters such as status.

get/v2/users

Request

Base URL
https://api.shipstation.com
URL
https://api.shipstation.com/v2/users
Auth
API key in header api-key

Query parameters

status'active' | 'inactive' | 'locked_out' | 'email_lock'

Filter users by their status

page_sizeinteger

The number of results to return per page

pageinteger

The page number to return

Response

List of users

totalinteger

Total number of users

pageinteger

Current page number

pagesinteger

Total number of pages

Example response

{
  "users": [
    {
      "user_id": "123abc4d-1a2b-4321-a1b2-123abc4d5e6f",
      "name": "First Last",
      "username": "user.name",
      "email": "user.name@company.com",
      "status": "Active",
      "last_login_at": "2025-01-01",
      "created_at": "2023-05-28"
    }
  ],
  "total": 75,
  "page": 1,
  "pages": 3,
  "links": {
    "first": {
      "href": "https://api.shipstation.com/v2/users?page=1&page_size=25"
    },
    "last": {
      "href": "https://api.shipstation.com/v2/users?page=3&page_size=25"
    },
    "prev": {
      "href": "https://api.shipstation.com/v2/users?page=1&page_size=25"
    },
    "next": {
      "href": "https://api.shipstation.com/v2/users?page=2&page_size=25"
    }
  }
}

Changes

Oct 22, 20264e29670aa28d Revision changes
- warning
  added the new bring_your_own_label_not_supported enum value to the // response property for the response status
- warning
  added the new bring_your_own_label_not_supported enum value to the // response property for the response status
- warning
  added the new multiple_sales_orders enum value to the // response property for the response status
- warning
  added the new multiple_sales_orders enum value to the // response property for the response status
- warning
  added the new sales_order_link_required enum value to the // response property for the response status
- warning
  added the new sales_order_link_required enum value to the // response property for the response status
Oct 9, 2026934f5935dbea Revision changes
- breaking
  the / response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  removed from the / response property allOf list for the response status
- info
  removed from the / response property allOf list for the response status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status

Operation history (4 revisions)