---
title: "Get Users"
method: GET
path: "/scim/v2/Users"
tags: ["SCIM 2.0"]
---

# Get Users

`GET /scim/v2/Users`

## Request

- Base URL: `https://platform.hootsuite.com`
- URL: `https://platform.hootsuite.com/scim/v2/Users`
- Auth: OAuth 2
  - Authorization code: `https://platform.hootsuite.com/oauth2/auth`
  - Token URL: `https://platform.hootsuite.com/oauth2/token`

Retrieves Hootsuite users using the SCIM 2.0 protocol. Support equals filtering on username.

## Query parameters

- `filter` string
- `count` number
- `startIndex` number

## Headers

- `Authorization` string, required

## Response `200`

Success

- ScimUsers
  - `Resources` ScimUser[]
    - `schemas` string[]: Required SCIM schemas
    - `id` string
    - `meta` object
      - `resourceType` string
      - `created` string
      - `lastModified` string
    - `userName` string
    - `name` object
      - `givenName` string
      - `familyName` string
    - `emails` object[]
      - `primary` boolean
      - `value` string
      - `type` string
    - `displayName` string
    - `timezone` string: The user's time zone. If not provided it will default to "America/Vancouver". Valid values are defined at http://php.net/manual/en/timezones.php.
    - `preferredLanguage` 'en' | 'ja' | 'fr' | 'it' | 'es' | 'de' | 'pt_BR' | 'pl' | 'id' | 'zh_CN' | 'zh_HK' | 'zh_TW' | 'nl' | 'ko' | 'ar' | 'ru' | 'th' | 'tr': The user's language.
    - `title` string
    - `groups` object[]
    - `active` boolean
  - `totalResults` number: The total number of users found
  - `startIndex` number: The current offset used for result paging
  - `itemsPerPage` number: The page size used for paging
  - `schemas` string[]

---

[API](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api.md) - [All operations](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api/revisions/adac53bd28bb?raw)