---
updatedAt: 2025-11-11T22:56:24.000Z
agentTools:
  projectIndex: https://pegasus.digitalcomtech.com/llms.txt
---

# View set

View a paginated list of users

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Pegasus Cloud IoT API",
    "description": "Pegasus IoT Cloud API reference documentation. [Github Repo](https://github.com/dctdevelop/pegasus) / [Release notes](https://github.com/dctdevelop/pegasus/tree/master/releases)",
    "contact": {
      "email": "developer@digitalcomtech.com"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "1.0.12"
  },
  "servers": [
    {
      "url": "https://api.pegasusgateway.com",
      "description": "Production server"
    },
    {
      "url": "https://auth.pegasusgateway.com",
      "description": "Authentication server"
    }
  ],
  "tags": [
    {
      "name": "Users"
    }
  ],
  "paths": {
    "/users": {
      "get": {
        "tags": [
          "Users"
        ],
        "summary": "View set",
        "description": "View a paginated list of users",
        "operationId": "viewUsers",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/responseUser200"
                  }
                }
              }
            }
          },
          "400": {
            "description": "bad input parameter"
          }
        },
        "security": [
          {
            "apikeyAuth": []
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "responseUser200": {
        "type": "object",
        "properties": {
          "date_joined": {
            "type": "number",
            "description": "Date of first login",
            "example": 1642919786
          },
          "last_login": {
            "type": "number",
            "description": "Last login (epoch)",
            "example": 1652849786
          },
          "id": {
            "type": "number",
            "description": "User ID",
            "example": 123
          },
          "email": {
            "type": "string",
            "description": "Email",
            "example": "bob@abctrucks.com"
          },
          "is_active": {
            "type": "boolean",
            "description": "If user is active",
            "example": true
          },
          "is_staff": {
            "type": "boolean",
            "description": "If user is an administrator",
            "example": false
          },
          "is_superuser": {
            "type": "boolean",
            "description": "Internal use",
            "example": false
          },
          "first_name": {
            "type": "string",
            "description": "First name",
            "example": "Bob"
          },
          "last_name": {
            "type": "string",
            "description": "Last name",
            "example": "Smith"
          },
          "phone": {
            "type": "string",
            "description": "Phone",
            "example": "(305) 809-0638"
          },
          "groups": {
            "type": "array",
            "description": "Groups associated to the user",
            "items": {
              "type": "number",
              "example": 1
            }
          },
          "prefs": {
            "type": "object",
            "allOf": [
              {
                "description": "User preferences"
              },
              {
                "type": "object",
                "properties": {
                  "coords": {
                    "type": "string",
                    "description": "Coordinate system",
                    "example": "WGS84"
                  },
                  "date_format": {
                    "type": "string",
                    "description": "Date format",
                    "example": "YYYY-MM-DD"
                  },
                  "distance": {
                    "type": "string",
                    "description": "Distance units",
                    "example": "mile"
                  },
                  "hour_format": {
                    "type": "number",
                    "description": "Hour format",
                    "example": 12
                  },
                  "language": {
                    "type": "string",
                    "description": "Language",
                    "example": "en"
                  },
                  "temperature": {
                    "type": "string",
                    "description": "Temperature",
                    "example": "F"
                  },
                  "volume": {
                    "type": "string",
                    "description": "Volume",
                    "example": "liter"
                  }
                }
              }
            ]
          },
          "scopes": {
            "type": "object",
            "allOf": [
              {
                "description": "Scopes for the user"
              },
              {
                "type": "object",
                "properties": {
                  "assets": {
                    "type": "string",
                    "description": "Assets",
                    "example": "r"
                  },
                  "vehicles": {
                    "type": "string",
                    "description": "Vehicles",
                    "example": "r"
                  },
                  "geofences": {
                    "type": "string",
                    "description": "Geofences",
                    "example": "w"
                  }
                }
              }
            ]
          },
          "username": {
            "type": "string",
            "description": "Username",
            "example": "bob@abctrucks.com"
          },
          "__updated": {
            "type": "number",
            "description": "Epoch of last modification done on user",
            "example": 1649865610.294368
          },
          "__created": {
            "type": "number",
            "description": "Epoch of creation",
            "example": 1592351212.609387
          },
          "__version": {
            "type": "string",
            "description": "API version info",
            "example": "7.0.0"
          }
        }
      }
    },
    "securitySchemes": {
      "apikeyAuth": {
        "type": "apiKey",
        "name": "authenticate",
        "in": "header"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```