Printago API
GET /v1/users

List store users

List the members of your store with their roles, permissions and status. Pending and expired invitations are included with status `invited` or `expired`. Paginate with `limit` (default 50) and `offset`.

Requires: user.view

Query Parameters

search optional
string
role optional
string
status optional
"active" | "inactive"
limit optional
number
offset optional
number

Response Schema

GetUsersResponse
totalrequired
number
usersrequired
object[]
createdAtrequired
string
format: date-time
displayNameoptional
string
emailrequired
string
expiresAtoptional
string
Invitation expiry date (invited/expired rows only).
format: date-time
invitationIdoptional
string
Present only for invited/expired rows.
invitedByEmailoptional
string
Email of the person who sent the invitation.
isOwnerrequired
boolean
lastActiveoptional
string
format: date-time
permissionsrequired
enum[]
rolesrequired
string[]
Role identifiers (usually system role keys like "operator", or role IDs for custom roles).
statusrequired
"active" | "invited" | "inactive" | "expired"
activeinvitedinactiveexpired
userIdoptional
string

Example Response

200 OK — application/json 
{
  "users": [
    {
      "userId": "string",
      "email": "string",
      "displayName": "string",
      "isOwner": true,
      "roles": [
        "string"
      ],
      "permissions": [
        "organization.owner"
      ],
      "lastActive": "2025-01-15T12:00:00.000Z",
      "status": "active",
      "createdAt": "2025-01-15T12:00:00.000Z",
      "invitationId": "string",
      "expiresAt": "2025-01-15T12:00:00.000Z",
      "invitedByEmail": "string"
    }
  ],
  "total": 1
}