GET /v1/users - @printago/api

Query Parameters

search optional

string

role optional

string

status optional

any

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

any[]

rolesrequired

string[]

Role identifiers (usually system role keys like "operator", or role IDs for custom roles).

statusrequired

any

userIdoptional

string

Example Response

200 OK — application/json

{
  "users": [
    {
      "userId": "string",
      "email": "string",
      "displayName": "string",
      "isOwner": true,
      "roles": [
        "string"
      ],
      "permissions": [],
      "lastActive": "2026-08-24T03:58:56.463Z",
      "createdAt": "2026-08-24T03:58:56.463Z",
      "invitationId": "string",
      "expiresAt": "2026-08-24T03:58:56.463Z",
      "invitedByEmail": "string"
    }
  ],
  "total": 1
}