---
title: "Filter Users"
method: GET
path: "/scim/v2/{workspaceId}/Users"
tags: ["SCIM"]
---

# Filter Users

`GET /scim/v2/{workspaceId}/Users`

## Request

- Base URL: `https://api.carbonvoice.app`
- URL: `https://api.carbonvoice.app/scim/v2/{workspaceId}/Users`
- Auth: none declared

## Path parameters

- `workspaceId` string, required

## Query parameters

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

## Response `200`

- UserSCIMListResponse
  - `schemas` string[], required: Schema Definition for the List Resource
  - `totalResults` number, required: Total number of results based on given filter
  - `startIndex` number, required: Index to paginate the results
  - `itemsPerPage` number, required: Total number of results per page
  - `Resources` UserSCIM[], required: List of Users
    - `schemas` string[], required: Schema Definition for the Resource
    - `id` string, required: Unique Identifier for the user at PhononX
    - `externalId` string: External Unique Identifier for the user at Client Side
    - `active` boolean, required: Information about if user is active or not
    - `userName` string, required: Identifier for the user at Okta
    - `name` Name
      - `givenName` string: First Name
      - `familyName` string: Last Name
      - `formatted` string: Full Name
    - `meta` Meta, required
      - `resourceType` string, required
      - `created` string, date-time, required
      - `lastModified` string, date-time, required
      - `location` string, required: Location of the resource at PhononX
    - `emails` Email[], required: List of emails
      - `primary` boolean, required: Is Primary email
      - `value` string, required: Email

---

[API](https://skmtc.dev/carbonvoice/apis/carbon-voice-api.md) · [All operations](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/llms.txt) · [OpenAPI document](https://skmtc.dev/carbonvoice/apis/carbon-voice-api/revisions/b91c5c845122?raw)