Skip to main content

UsersListEnvelope

okbooleanrequired

Possible values: [true]

request_idstringrequired
Example: req_01HXYZABC123
data objectrequired
oneOf
users object[]required
  • Array [
    • idstringrequired
    namestringrequired
    emailstringrequired
    roleUserRolerequired

    Possible values: [admin, editor, viewer]

    groupstringrequired
    is_superuserbooleanrequired
    forgot_tokenstringnullable
    created_atdate-timenullable
  • ]
    • property name*any
    UsersListEnvelope
    {
      "ok": true,
      "request_id": "req_01HXYZABC123",
      "data": {
        "users": [
          {
            "id": "string",
            "name": "string",
            "email": "string",
            "role": "admin",
            "group": "string",
            "is_superuser": true,
            "forgot_token": "string",
            "created_at": "2024-07-29T15:51:28.071Z"
          }
        ]
      }
    }