> ## Documentation Index > Fetch the complete documentation index at: https://developers.portao3.com.br/llms.txt > Use this file to discover all available pages before exploring further. # List organization users > Lists the users of an organization. Filter by `ids`, `status`, `level` (the access level in this organization), `realmLevel` (the access level in the realm), `hasPin`, `hasMfa`, or a text match on `name`, `email` or `document`. A list filter takes its values comma-separated (`?level=ADMIN,USER`); repeating the parameter (`?level=ADMIN&level=USER`) works too. A page holds up to 100 users (`limit`); send the previous page's `next` cursor for the following one. The organization's active admins, for example, are `?level=ADMIN&status=ACTIVE&limit=100`. ## OpenAPI ````yaml /api-reference/identity.openapi.json get /realms/{realmId}/organizations/{organizationId}/users openapi: 3.0.3 info: title: Identity version: 1.0.0 description: >- Portão 3 identity API. Every endpoint requires a bearer token in the Authorization header (Authorization: Bearer ) unless its page states otherwise; see the Authentication guide. That requirement is not repeated per endpoint. Generated by tools/openapi from code (routes + security) and the hand-written spec (request/response bodies). 4 app groups run without the identity authorizer; publicPatterns enumerates every route they expose, except POST /auth/sign-in, documented with HTTP Basic for the API-client credentials flow. Confidence tiers: generated:typed=45 copied:manual=0 unknown=0. servers: - url: https://api.identity.v2.portao3.com.br/ description: production - url: https://api.identity.dev.3pers.com.br/ description: development security: [] tags: - name: Authentication - name: Current User - name: Custom Fields - name: API Clients - name: Users - name: Organizations - name: Groups - name: Realms paths: /realms/{realmId}/organizations/{organizationId}/users: get: tags: - Users summary: List organization users description: Lists the users of an organization. operationId: getRealmsByRealmIdOrganizationsByOrganizationIdUsers parameters: - name: realmId in: path required: true schema: type: string - name: organizationId in: path required: true schema: type: string - name: ids in: query required: false description: >- Only the users with these IDs. Format: `UUID` --- Example (comma-separated list): `?ids=8f1c2d3e-4b5a-4c6d-9e7f-a1b2c3d4e5f6,29bfc458-6d62-4e37-9a89-dc620926bae5` schema: maxItems: 100 type: array items: type: string format: uuid style: form explode: false - name: name in: query required: false description: >- Only users whose first or last name contains each word of this text (case-insensitive), or whose e-mail contains the whole text. schema: type: string maxLength: 200 example: Ana Souza - name: email in: query required: false description: Only users whose e-mail contains this text (case-insensitive). schema: type: string maxLength: 200 example: '@acme.com.br' - name: document in: query required: false description: >- Only users whose document (CPF) contains these characters. Punctuation is ignored, so `123.456` and `123456` match the same users. schema: type: string maxLength: 32 example: '12345678909' - name: status in: query required: false description: |- Only users in one of these statuses. --- Example (comma-separated list): `?status=ACTIVE,IN_ONBOARDING` schema: type: array items: type: string enum: - IN_ONBOARDING - CREATING - ACTIVE - DEACTIVATED - BLOCKED style: form explode: false - name: level in: query required: false description: |- Only users with one of these access levels in the organization. --- Example: `?level=ADMIN` schema: type: array items: type: string enum: - ADMIN - USER style: form explode: false - name: realmLevel in: query required: false description: |- Only users with one of these access levels in the realm. --- Example: `?realmLevel=ADMIN` schema: type: array items: type: string enum: - ADMIN - USER style: form explode: false - name: hasPin in: query required: false description: >- Only users who set up a transaction PIN (`true`) or did not (`false`). --- Example: `?hasPin=true` schema: type: array items: anyOf: - type: boolean - type: string style: form explode: false - name: hasMfa in: query required: false description: >- Only users who enabled multi-factor authentication (`true`) or did not (`false`). --- Example: `?hasMfa=true` schema: type: array items: anyOf: - type: boolean - type: string style: form explode: false - name: limit in: query required: false description: Page size, 1–100. Defaults to 15. schema: type: integer minimum: 1 maximum: 100 example: 15 - name: next in: query required: false description: >- Cursor returned as `next` by the previous page. Omit for the first page. schema: type: string example: NmEzZjljMjFlNGIwN2Q1YThjMTJmM2U5 - name: orderBy in: query required: false description: Field to sort by. Defaults to `createdAt`. schema: type: string maxLength: 64 example: createdAt - name: order in: query required: false description: Sort direction, `ASC` or `DESC`. Defaults to `DESC` (newest first). schema: type: string maxLength: 8 example: DESC responses: '200': description: Successful response content: application/json: schema: type: object properties: next: type: string nullable: true description: >- Cursor for the next page: send it as the `next` query parameter. `null` on the last page. example: NmEzZjljMjFlNGIwN2Q1YThjMTJmM2U5 items: type: array items: type: object properties: id: type: string description: ID of the user. example: 8f1c2d3e-4b5a-4c6d-9e7f-a1b2c3d4e5f6 format: uuid email: type: string description: >- E-mail address the user signs in with. It can't be changed. example: ana.souza@acme.com.br firstName: type: string description: First name. example: Ana lastName: type: string description: Last name. example: Souza cpf: type: string description: CPF, digits only. example: '52998224725' birthdate: type: string description: Date of birth, at midnight UTC. example: '1990-05-17T00:00:00.000Z' format: date-time phone: type: string description: >- Phone number in E.164 format. Omitted when the user has none. example: '+5511987654321' status: type: string enum: - IN_ONBOARDING - CREATING - ACTIVE - DEACTIVATED - BLOCKED description: >- Lifecycle status. `IN_ONBOARDING`: invited, still completing onboarding. `ACTIVE`: can sign in. `DEACTIVATED`: access removed by an administrator. `BLOCKED`: access suspended, for example after too many wrong PINs. `CREATING`: being set up. example: ACTIVE statusCode: type: string enum: - BLOCKED_BY_PIN - BLOCKED_BY_MFA - BLOCKED_BY_ADMIN - USER_ACTIVE - USER_DEACTIVATED - ONLY_ONBOARDING description: >- Reason behind `status`: `USER_ACTIVE`, `USER_DEACTIVATED`, `ONLY_ONBOARDING`, or the cause of a block (`BLOCKED_BY_PIN`, `BLOCKED_BY_MFA`, `BLOCKED_BY_ADMIN`). example: USER_ACTIVE realm: type: object properties: id: type: string description: ID of the realm. example: f495ff0c-ab54-4f99-8e92-ca8682e4de9b format: uuid level: type: string enum: - ADMIN - USER - APP_CLIENT description: >- Access level in the realm. `ADMIN` can manage every organization and user of the realm; `USER` acts only in the organizations listed in `organizations`. `APP_CLIENT` can appear on users created with that level. example: USER name: type: string description: Display name of the realm. Can be empty. example: '' required: - id - level - name description: The user's realm and their access level in it. hasMfa: type: boolean description: >- Whether the user has set up multi-factor authentication. example: true hasPin: type: boolean description: Whether the user has created a transaction PIN. example: true hasFacialBiometric: type: boolean description: >- Whether the user's face was validated during onboarding. example: true pinErrorsCount: type: number description: >- Consecutive wrong PIN attempts. At 3 the user is blocked (`BLOCKED_BY_PIN`). example: 0 mfaErrorsCount: type: number description: Consecutive wrong multi-factor codes. example: 0 customFields: type: object additionalProperties: {} description: >- Values of the realm's user custom fields, keyed by the custom field's `slug`, for example `{"cost-center": "Marketing"}`. Omitted when the user has none. createdAt: type: string description: When the user was created. example: '2026-03-02T14:21:07.512Z' format: date-time updatedAt: type: string description: When the user last changed. example: '2026-10-13T18:43:50.746Z' format: date-time createdBy: type: string description: >- ID of the user or API client that created this user. Empty when unknown. example: 43230779-2cfb-4525-a40c-77fbf15e68f0 updatedBy: type: string description: >- ID of the user or API client that last changed this user. Empty when unknown. example: 43230779-2cfb-4525-a40c-77fbf15e68f0 deletedBy: type: string description: >- ID of the user or API client that deactivated this user. Empty unless the user was deactivated. example: '' userOrgLevel: type: string enum: - ADMIN - USER - APP_CLIENT description: >- The user's access level in the organization of the request. `ADMIN` manages the organization's users and settings; `USER` uses its wallets and cards. `APP_CLIENT` can appear on memberships created with that level. example: USER required: - cpf - createdAt - createdBy - deletedBy - email - firstName - hasFacialBiometric - hasMfa - hasPin - id - lastName - mfaErrorsCount - pinErrorsCount - realm - status - statusCode - updatedAt - updatedBy - userOrgLevel description: A user of the organization. description: The users on this page. required: - next - items description: A page of the organization's users. '422': description: >- `BAD_REQUEST` — A query parameter is invalid; `fields` lists each offending parameter. content: application/json: schema: type: object properties: traceId: type: string description: >- Identifier of the request that failed. Quote it when contacting support. example: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: type: string enum: - BAD_REQUEST description: >- Stable, machine-readable error code. Branch on this, never on `message`. origin: type: string enum: - IDENTITY description: Service that produced the error. message: type: string description: >- Human-readable explanation. Its wording may change without notice. fields: type: array description: >- One entry per invalid request field (validation errors only). items: type: object properties: field: type: string description: >- Path of the invalid field, e.g. `label` or `values[0].value`. example: label message: type: string description: Why the field was rejected. example: label is required code: type: string description: >- `_` — e.g. `LABEL_REQUIRED`, `TYPE_ONE_OF`, `VALUES_VALUE_TYPE_ERROR`. example: LABEL_REQUIRED values: type: array items: type: string description: >- The accepted values, when the field is an enumeration. required: - field - message - code required: - traceId - code - origin - message example: traceId: 1-68ee2a1b-3c4d5e6f7a8b9c0d1e2f3a4b code: BAD_REQUEST origin: IDENTITY message: >- Bad Request: Your request is invalid or incomplete. Please make sure you are requesting with the right fields. fields: - field: ids message: 'Too big: expected array to have <=100 items' code: IDS_MAX ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.