users
List users
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
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
No recorded changes to this operation across all 1 revision of this API.