---
title: "List OrgUsers"
method: GET
path: "/organizations/{orgId}/users"
tags: ["OrgUsers"]
---

# List OrgUsers

`GET /organizations/{orgId}/users`

Retrieve a list of OrgUsers.

Retrieves a list of all users within a specified Organization. Use this endpoint to get an overview of all users and their basic details. The list can be paginated for easier management.

## Path parameters

- `orgId` string, required

## Query parameters

- `pageSize` integer
- `nextToken` string
- `ids` string[]

## Response `200`

Returns a list of OrgUsers

- PaginatedOrgUserResponseData
  - `data` OrgUserResponse[]
    - `id` string, required — The UUID of the entity.
    - `version` integer — The version number: - **Create:** On initial Create to insert a new entity, the version is set at 1 in the response. - **Update:** On successful Update, the version is incremented by 1 in the response.
    - `firstName` string — The first name of the user.
    - `lastName` string — The surname of the user.
    - `contactNumber` string — The user's contact telephone number.
    - `email` string — The email address for this user.
    - `organizations` string[] — An array listing the Organizations where this user has access.
    - `firstAcceptedTermsAndConditions` string, date-time — The date and time *(in ISO 8601 format)* when this user first accepted the the m3ter terms and conditions.
    - `lastAcceptedTermsAndConditions` string, date-time — The date and time *(in ISO 8601 format)* when this user last accepted the the m3ter terms and conditions.
    - `supportUser` boolean — Indicates whether this is a m3ter Support user.
    - `dtCreated` string, date-time — The date and time *(in ISO-8601 format)* when the user was created.
    - `dtLastModified` string, date-time — The date and time *(in ISO-8601 format)* when the user was last modified.
    - `createdBy` string — The user who created this user.
    - `lastModifiedBy` string — The unique identifier (UUID) of the user who last modified this user record.
    - `permissionPolicy` PermissionStatement[] — An array of permission statements for the user. Each permission statement defines a specific permission for the user.
      - `effect` 'ALLOW' | 'DENY', required
      - `action` PermissionAction[], required — The actions available to users who are assigned the Permission Policy - what they can do or cannot do with respect to the specified resource. **NOTE:** Use lower case and a colon-separated format, for example, if you want to confer full CRUD, use: ``` "config:create", "config:delete", "config:retrieve", "config:update" ```
      - `resource` string[], required — See [Statements - Available Resources](https://www.m3ter.com/docs/guides/managing-organization-and-users/creating-and-managing-permissions#statements---available-resources) for a listing of available resources for Permission Policy statements.
    - `dtEndAccess` string, date-time — The date and time *(in ISO 8601 format)* when the user's access will end. Used to set or update the date and time a user's access expires.
  - `nextToken` string

## Other responses

- `4XX` — Error message
- `5XX` — Error message

---

[API](https://skmtc.net/m3ter-com/apis/m3ter-api.md) · [All operations](https://skmtc.net/m3ter-com/apis/m3ter-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/m3ter-com/m3ter-api/versions/ac93d1a9e6d9/schema)