---
title: "Get User entities"
method: GET
path: "/api/v1/entities/users"
tags: ["Users - Entity APIs"]
---

# Get User entities

`GET /api/v1/entities/users`

## Request

- Base URL: `https://www.gooddata.ai`
- URL: `https://www.gooddata.ai/api/v1/entities/users`
- Auth: none declared

User - represents entity interacting with platform

## Query parameters

- `filter` string
- `include` string[]
- `page` integer
- `size` integer
- `sort` string[]
- `metaInclude` string[]: Included meta objects

## Response `200`

Request successfully processed

- JsonApiUserOutList: A JSON:API document with a list of resources
  - `data` JsonApiUserOutWithLinks[], required
    - `attributes` object
      - `authenticationId` string
      - `email` string
      - `firstname` string
      - `lastname` string
      - `systemAccount` boolean: Is user system account
    - `id` string, required: API identifier of an object
    - `relationships` object
      - `userGroups` object
        - `data` JsonApiUserGroupLinkage[], required: References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object.
          - `id` string, required
          - `type` 'userGroup', required
    - `type` 'user', required: Object type
    - `links` ObjectLinks
      - `self` string, uri, required: A string containing the link's URL.
  - `included` JsonApiUserGroupOutWithLinks[]: Included resources
    - `attributes` object
      - `name` string
    - `id` string, required: API identifier of an object
    - `relationships` object
      - `parents` object
        - `data` JsonApiUserGroupLinkage[], required: References to other resource objects in a to-many (\"relationship\"). Relationships can be specified by including a member in a resource's links object.
          - `id` string, required
          - `type` 'userGroup', required
    - `type` 'userGroup', required: Object type
    - `links` ObjectLinks
      - `self` string, uri, required: A string containing the link's URL.
  - `links` ListLinks
    - `self` string, uri, required: A string containing the link's URL.
    - `next` string, uri: A string containing the link's URL for the next page of data.
  - `meta` object
    - `page` PageMetadata
      - `number` integer: The number of the current page
      - `size` integer: The size of the current page
      - `totalElements` integer: The total number of elements
      - `totalPages` integer: The total number of pages
    - `restricted` RestrictedObject[]: References withheld from `included` because the caller may not view them. Their `relationships` entries are kept, so a client can render a placeholder instead of treating the reference as missing. Empty when the caller may view every reference in the payload; absent entirely when no object-level permissions apply to the request.
      - `id` string, required: Object identifier, unique within one workspace hierarchy.
      - `type` 'analyticalDashboard' | 'attribute' | 'attributeHierarchy' | 'computedAttribute' | 'fact' | 'label' | 'metric' | 'userDataFilter' | 'visualizationObject', required: JSON:API type of the restricted object. Matches the `type` of its entry in the resource's `relationships`.

---

[API](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api.md) - [All operations](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gooddata/apis/gooddata-cn-oapi-all-api/revisions/c728ef303bfb?raw)