> ## Documentation Index > Fetch the complete documentation index at: https://docs.kodelabs.com/llms.txt > Use this file to discover all available pages before exploring further. # List users > Returns the users of your organization, one page at a time, with the apps each user can access. > [!NOTE] > > Each user in `data` includes `assignedInApps`, the apps the user can access and the role in each. Use the filters to find users by role, app, status, or member type. A user must match every filter you send. > [!NOTE] > > Users are ordered by `_id`, highest first, unless you send `asc` or `dsc`. ## OpenAPI ````yaml /openapi/kode-api.yaml get /api/v1/users openapi: 3.1.0 info: title: KODE API version: 1.0.0 summary: Programmatic access to KODE OS resources and operations. description: > Use the KODE API to work with buildings, data sources, connectors, devices, points, virtual devices, timeseries data, schedules, the ontology, templating, mass writes, spaces, space assignments, tenants, meters, users, actions, and AssetOps work orders. license: name: Proprietary identifier: LicenseRef-Proprietary servers: - url: https://api.kodelabs.com/kodeos description: KODE API security: - bearerAuth: [] tags: - name: Authentication description: OAuth 2.0 discovery, token, and revocation endpoints. - name: Buildings description: Buildings and their areas. - name: Data sources description: Data sources connected to a building. - name: Devices description: Devices and their points. - name: Points description: Point queries and point writes. - name: Timeseries description: Current and historical point values. - name: Actions description: Actions exposed by building data sources. - name: Work orders description: AssetOps work orders, lookups, comments, and attachments. - name: Connectors description: KODE API connectors and the devices and points ingested through them. - name: Schedules description: Schedules discovered on building data sources. - name: Templating description: Apply ontology templates to groups of points. - name: Virtual devices description: Virtual devices that group points from other devices. - name: Ontology description: Canonical types, fields, units, and connections of the KODE ontology. - name: Users description: Users of the organization and their app access. - name: Mass write description: Write values to many points across buildings, and follow each run. - name: Spaces description: Levels and space units of a building, and the meters located in them. - name: Space assignments description: Assign tenants to leasable spaces of a building for a period. - name: Tenants description: Tenants of a building, the people or companies that lease its spaces. - name: Meters description: >- Meters of a building, their space assignments, parent and child links, and readings. paths: /api/v1/users: get: tags: - Users summary: List users description: >- Returns the users of your organization, one page at a time, with the apps each user can access. operationId: listUsers parameters: - name: active in: query schema: type: string pattern: ^(true|false)$ description: >- Return only active users with `true`, or only inactive users with `false`. - name: appId in: query schema: type: array items: type: string description: >- Return users who have access to this app. Only `bms` can be assigned through the API. Repeat the parameter to match any of several apps. - name: asc in: query schema: type: string description: >- Field to sort by, lowest first, for example `email`. Use a field name from the response. An unknown field is accepted and the order is then not defined. - name: dsc in: query schema: type: string default: _id description: Field to sort by, highest first. Defaults to `_id`. - name: limit in: query schema: type: integer format: int32 maximum: 200 minimum: 1 default: 50 description: Number of users per page, from `1` to `200`. - name: memberType in: query schema: type: string pattern: ^(INTERNAL|GUEST)$ description: >- Return only `INTERNAL` users or only `GUEST` users. The value is case-sensitive. - name: page in: query schema: type: integer format: int32 minimum: 1 default: 1 description: Page number to return. The first page is `1`. - name: q in: query schema: type: string description: >- Search text. Matches users by email address. The match is not case-sensitive and can start anywhere in the value. Characters other than letters, digits, spaces, and `@` are ignored, so a term made only of other characters returns an empty page. - name: role in: query schema: type: array items: type: string description: >- Return users with this organization role, for example `CLIENT_ADMIN`. Repeat the parameter to match any of several roles. responses: '200': description: >- A page of users. `itemCount` is the total number of users that match the filters. content: application/json: schema: $ref: '#/components/schemas/PaginatedEntityUserPublic' '400': description: >- A query parameter is invalid. For example, `limit` is above `200`, `page` is below `1`, or `memberType` is not `INTERNAL` or `GUEST`. `error.fields` names the parameter. '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '429': $ref: '#/components/responses/TooManyRequests' components: schemas: PaginatedEntityUserPublic: type: object properties: data: type: array items: $ref: '#/components/schemas/UserPublic' page: type: integer format: int32 limit: type: integer format: int32 pageCount: type: integer format: int32 itemCount: type: integer format: int32 UserPublic: type: object properties: _id: type: string organizationId: type: string createdAt: $ref: '#/components/schemas/Date' type: string readOnly: true updatedAt: $ref: '#/components/schemas/Date' type: string readOnly: true firstName: type: string lastName: type: string email: type: string phone: type: string position: type: string role: type: string memberType: type: string active: type: boolean invitationStatus: type: string assignedInApps: type: array items: $ref: '#/components/schemas/AppAssignmentPublic' Date: type: string description: >- Date and time in UTC, with a numeric offset and no colon, for example `2026-10-28T13:51:31+0000`. examples: - 2026-10-28T13:51:31+0000 AppAssignmentPublic: type: object properties: appId: type: string role: type: string assignmentStatus: type: string responses: Unauthorized: description: The access token is missing, invalid, or expired. Request a new token. Forbidden: description: The service account lacks permission for this building or operation. TooManyRequests: description: >- A rate-limit window is exhausted. Wait, then retry with increasing delays. securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Paste an access token from [Create an access token](/products/kode-api/api-reference/authentication/create-an-access-token). Tokens expire, so request a new one if you receive `401`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.