---
title: "Users collection"
method: GET
path: "/users"
tags: ["Users"]
---

# Users collection

`GET /users`

## Request

- Base URL: `https://sb2api.servicechannel.com/v3`
- URL: `https://sb2api.servicechannel.com/v3/users`
- Auth: OAuth 2
  - Authorization code: `https://sb2login.servicechannel.com/oauth/authorize`
  - Token URL: `https://sb2login.servicechannel.com/oauth/token`
- TypeScript: <https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/docs/users/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the list of all users of the current subscriber (the main user is also included) for successful request.
            <br />**Note**: This method is available to subscriber users with the *Super Admin* secondary role.

## Query parameters

- `subscriberId` integer
- `startIndex` integer
- `maxCount` integer
- `userFilterType` 'Corporate' | 'All'
- `feedRolesFilter` string[]
- `includeMliInfo` boolean
- `includeMlpInfo` boolean
- `includeTotalCount` boolean

## Response `200`

Indicates that the request succeeded and that the requested information is in the response.

- ServiceChannelServicesMessagingUsersUser[]
  - `Id` integer: Unique user identifier.
  - `SubscriberId` integer: Unique subscriber ID.
  - `UserName` string: Username of the user.<br /> • For subscriber users, the username appears as **User Id** on the "General Info" tab of the user profile page.<br /> • For provider users, the username is listed as **UserID** under "Access" on the "General" tab of the user profile page.
  - `FullName` string: Full name of the user.<br /> • For subscriber users, the full name appears as **User Name** on the "General Info" tab of the user profile page.<br /> • For provider users, you can see their first and last name under "Basic" on the "General" tab of the user profile page.
  - `Email` string: User’s email address.
  - `PsmEmail` string: Email address through which a user can reset their password.
  - `Disabled` boolean: Defines if a user is deactivated.
  - `IsLocked` boolean: Defines if a user is locked.
  - `Roles` string[]: Secondary roles assigned to a subscriber user that determine their permissions and level of access to various Service Automation modules.
  - `Permissions` string[]: Permissions assigned to a subscriber user that determine whether they have full or read-only access to various Service Automation modules.
  - `UserType` 'Corporate' | 'Dashboard' | 'ServiceChannel': Subscriber user type defining their level of access to ServiceChannel:<br /> • `Corporate` — a user can work in Service Automation.<br /> • `Dashboard` — a user can only access the dashboard assigned to them.<br />`0` is returned for provider users.
  - `Dashboard` ServiceChannelServicesMessagingUsersDashboardInfo: Dashboard details object.
    - `Id` integer: Unique dashboard identifier.
    - `Name` string: Dashboard name.
    - `RedirectToDashboard` boolean: Defines whether a subscriber user is redirected to a dashboard once they log in.
  - `Access` ServiceChannelServicesMessagingUsersAccessOptions: Object listing locations, districts, regions, and trades a subscriber user has access to. Learn more about [granting access based on locations, districts, and regions](https://servicechannel.atlassian.net/wiki/spaces/SCU/pages/585107276/Location+District+Region+Access+Tab) in ServiceChannel University.
    - `Locations` string[]: Locations a user has access to.
    - `Districts` string[]: Districts a user has access to.
    - `Regions` string[]: Regions a user has access to.
    - `Trades` string[]: Trades a user is permitted to work with.
  - `Limits` ServiceChannelServicesMessagingUsersLimitOptions: Object for NTE, proposal, and invoice limits set for a subscriber user.
    - `NteLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user.
      - `Amount` number, double: Limit amount.
      - `CurrencyId` integer: Identifier of the currency the limit is set in.
    - `ProposalLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user.
      - `Amount` number, double: Limit amount.
      - `CurrencyId` integer: Identifier of the currency the limit is set in.
    - `InvoiceLimit` ServiceChannelServicesMessagingUsersLimit: Object for limit details set for a subscriber user.
      - `Amount` number, double: Limit amount.
      - `CurrencyId` integer: Identifier of the currency the limit is set in.
  - `FeedRole` string
  - `MliUserInfo` ServiceChannelServicesMessagingUsersMliUserInfo
    - `Id` integer
    - `MliLevel` string
    - `MliLocations` integer[]
  - `MlpUserInfo` ServiceChannelServicesMessagingUsersMlpUserInfo
    - `Id` integer
    - `MlpLevel` string
    - `MlpLocations` integer[]

## Other responses

- `400`: Bad Request - the request could not be understood or was missing required parameters.
- `401`: Indicates that the requested resource requires authentication. <br/>Error codes: <br/> 504 - API call rejected by security permissions;
- `404`: Indicates that the requested resource does not exist on the server. <br/>Error codes: <br/> 502 - Users not found;

---

[API](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3.md) - [All operations](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/llms.txt) - [OpenAPI document](https://skmtc.dev/servicechannel/apis/servicechannel-api-v-3/revisions/d490d6596809?raw)