---
updatedAt: 2026-04-21T17:08:38.000Z
agentTools:
  projectIndex: https://docs-connect-api-v3.eventtia.com/llms.txt
---

# List users for the current account

Returns a paginated list of users belonging to the authenticated user's account (archived users are excluded). Requires the `view_users` permission; admin users bypass the permission check.

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "Eventtia API V3",
    "version": "3.0.0",
    "description": "REST API for the Eventtia event management platform."
  },
  "servers": [
    {
      "url": "https://connect.eventtia.com",
      "description": "Production"
    },
    {
      "url": "http://localhost:3000",
      "description": "Local"
    }
  ],
  "components": {
    "securitySchemes": {
      "bearer_auth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "JWT token obtained from POST /api/v3/auth"
      }
    },
    "schemas": {
      "pagination_meta": {
        "type": "object",
        "properties": {
          "total_pages": {
            "type": "integer",
            "example": 5
          }
        }
      },
      "jsonapi_links": {
        "type": "object",
        "properties": {
          "self": {
            "type": "string"
          },
          "first": {
            "type": "string"
          },
          "prev": {
            "type": "string",
            "nullable": true
          },
          "next": {
            "type": "string",
            "nullable": true
          },
          "last": {
            "type": "string"
          }
        }
      },
      "user_attributes": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "example": "Jane Doe"
          },
          "email": {
            "type": "string",
            "format": "email",
            "example": "jane@example.com"
          },
          "default_role_id": {
            "type": "integer",
            "example": 0
          },
          "active": {
            "type": "boolean",
            "example": true
          },
          "access_type": {
            "type": "string",
            "nullable": true,
            "enum": [
              "event_planner",
              "on_site_user",
              null
            ],
            "example": "event_planner"
          },
          "last_sign_in": {
            "type": "string",
            "format": "date-time",
            "nullable": true
          }
        }
      },
      "user_resource": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "type": {
            "type": "string",
            "enum": [
              "users"
            ]
          },
          "attributes": {
            "$ref": "#/components/schemas/user_attributes"
          }
        },
        "required": [
          "id",
          "type",
          "attributes"
        ]
      }
    }
  },
  "tags": [
    {
      "name": "Users",
      "description": "Manage backoffice users, their roles, and their permissions."
    }
  ],
  "paths": {
    "/api/v3/users": {
      "get": {
        "summary": "List users for the current account",
        "tags": [
          "Users"
        ],
        "operationId": "listUsers",
        "description": "Returns a paginated list of users belonging to the authenticated user's account (archived users are excluded). Requires the `view_users` permission; admin users bypass the permission check.",
        "security": [
          {
            "bearer_auth": []
          }
        ],
        "parameters": [
          {
            "name": "Authorization",
            "in": "header",
            "required": true,
            "description": "Bearer JWT token",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "page[number]",
            "in": "query",
            "required": false,
            "description": "Page number (default: 1)",
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "page[size]",
            "in": "query",
            "required": false,
            "description": "Page size (max: 24, default: 24)",
            "schema": {
              "type": "integer"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Paginated list of users",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "data": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/user_resource"
                      }
                    },
                    "meta": {
                      "$ref": "#/components/schemas/pagination_meta"
                    },
                    "links": {
                      "$ref": "#/components/schemas/jsonapi_links"
                    }
                  },
                  "required": [
                    "data"
                  ]
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized - missing or invalid token"
          }
        }
      }
    }
  }
}
```