---
updatedAt: 2026-05-11T14:55:41.000Z
agentTools:
  projectIndex: https://api.authaction.com/llms.txt
---

# List paginated users

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "paths": {
    "/api/v1/users": {
      "get": {
        "operationId": "UserController_findMany",
        "summary": "List paginated users",
        "parameters": [
          {
            "name": "page",
            "required": false,
            "in": "query",
            "description": "The current page",
            "schema": {
              "default": 0,
              "example": "0",
              "type": "number"
            }
          },
          {
            "name": "limit",
            "required": false,
            "in": "query",
            "description": "The amount of items to be returned",
            "schema": {
              "default": 10,
              "example": 10,
              "type": "number"
            }
          },
          {
            "name": "email",
            "required": false,
            "in": "query",
            "description": "Filter by email input",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "connection",
            "required": false,
            "in": "query",
            "description": "Name of the connection",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Request successful",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "statusCode": {
                      "type": "number",
                      "example": 200
                    },
                    "message": {
                      "type": "string",
                      "example": "success"
                    },
                    "data": {
                      "$ref": "#/components/schemas/PaginatedPopulatedUsersListObject"
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "User not member of tenant"
          }
        },
        "tags": [
          "Users"
        ],
        "security": [
          {
            "bearer": []
          }
        ]
      }
    }
  },
  "info": {
    "title": "AuthAction",
    "description": "authentication and authorization",
    "version": "1.0",
    "contact": {}
  },
  "tags": [
    {
      "name": "Users",
      "description": "User management endpoints"
    }
  ],
  "servers": [
    {
      "url": "https://{tenant}.{region}.authaction.com",
      "description": "Dynamic server based on tenant",
      "variables": {
        "tenant": {
          "default": "your-tenant-name",
          "description": "The tenant identifier"
        },
        "region": {
          "default": "eu",
          "description": "The tenant region (au|ca|cn|eu|in|jp|us)"
        }
      }
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer": {
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "type": "http",
        "description": "Obtain a Bearer token by passing M2M client app credential through the /oauth2/m2m/token endpoint"
      }
    },
    "schemas": {
      "PopulatedUserObject": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "example": "66428caae1e46c76af3f128f"
          },
          "name": {
            "type": "string",
            "example": "John"
          },
          "email": {
            "type": "string",
            "example": "john.doe@abc.com"
          },
          "externalId": {
            "type": "string",
            "example": "1000243578"
          },
          "username": {
            "type": "string",
            "example": "johndoe"
          },
          "tenant": {
            "type": "string",
            "example": "99428caae1e46c76af3f128f"
          },
          "connection": {
            "type": "string",
            "example": "11428caae1e46c76af3f128f"
          },
          "applications": {
            "example": [
              "88428caae1e46c76af3f128f"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "roles": {
            "example": [
              "77428caae1e46c76af3f138f"
            ],
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "plan": {
            "type": "string",
            "example": "11428caae1e46c76af3f148f"
          },
          "emailVerified": {
            "type": "boolean",
            "example": false
          },
          "isBlocked": {
            "type": "boolean",
            "example": false
          },
          "createdAt": {
            "type": "string",
            "example": "2024-07-17T14:37:00Z"
          },
          "updatedAt": {
            "type": "string",
            "example": "2024-07-17T14:37:00Z"
          }
        },
        "required": [
          "id",
          "name",
          "email",
          "externalId",
          "username",
          "tenant",
          "connection",
          "applications",
          "roles",
          "plan",
          "emailVerified",
          "isBlocked",
          "createdAt",
          "updatedAt"
        ]
      },
      "PaginationMetaOutputDto": {
        "type": "object",
        "properties": {
          "itemsCount": {
            "type": "number",
            "description": "The length of items array (i.e., the amount of items on this page)",
            "example": 10
          },
          "totalItems": {
            "type": "number",
            "description": "The total amount of SomeEntity matching the filter conditions",
            "example": 10
          },
          "itemsPerPage": {
            "type": "number",
            "description": "The requested items per page (i.e., the limit parameter)",
            "example": 10
          },
          "totalPages": {
            "type": "number",
            "description": "The total amount of pages (based on the limit)",
            "example": 5
          },
          "currentPage": {
            "type": "number",
            "description": "The current page this paginator `points` to",
            "example": 2
          }
        },
        "required": [
          "itemsCount",
          "itemsPerPage",
          "currentPage"
        ]
      },
      "PaginatedPopulatedUsersListObject": {
        "type": "object",
        "properties": {
          "items": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/PopulatedUserObject"
            }
          },
          "meta": {
            "$ref": "#/components/schemas/PaginationMetaOutputDto"
          }
        },
        "required": [
          "items",
          "meta"
        ]
      }
    }
  }
}
```