---
title: "Get a list of users"
method: GET
path: "/users"
tags: ["Users"]
---

# Get a list of users

`GET /users`

## Response `200`

User

- UserResponse — A full response object for a user-related endpoint.
  - `meta` object — Information about the Nutshell instance making the request
    - `instanceId` string — The Nutshell instance ID
    - `siteId` string — Site ID for WebFX customers
    - `next` string — The URL to the next page of results
    - `previous` string — The URL to the previous page of results
    - `total` integer
  - `users` object[]
    - `avatarUrl` string — The URL of the entity's avatar image.
    - `initials` string — The initials of the entity, used as a fallback for the avatar image.
    - `id` string — The API ID of this entity, formatted {integer}-{entityType}
    - `name` unknown
    - `firstName` unknown
    - `modifiedTime` integer
    - `isEnabled` boolean
    - `hasSetPassword` boolean
    - `isAdministrator` boolean
    - `isViewingRestricted` boolean
    - `isHiddenFromFilters` boolean
    - `canAccessEmailMarketing` boolean
    - `permissions` Permissions
      - `canAccessSetup` boolean
      - `canAccessMarketing` boolean
      - `canBulkEdit` boolean
      - `canExport` boolean
      - `canViewSharedEmails` boolean
      - `canImport` boolean
      - `canMergeEntities` boolean
      - `canDeleteEntities` boolean
      - `canAssignEntities` boolean
      - `canAccessBilling` boolean
      - `canManageEmailTemplates` boolean
      - `canAccessCrm` boolean
      - `canAccessFullCampaigns` boolean
      - `canUsePeopleIQ` boolean
      - `canUseInbox` boolean
    - `emails` string[]
    - `phonecallerType` unknown

---

[API](https://skmtc.dev/nutshell/apis/nutshell-api.md) · [All operations](https://skmtc.dev/nutshell/apis/nutshell-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nutshell/nutshell-api/revisions/14f59cf6a09a/schema)