---
title: "Search"
method: POST
path: "/api/v1/search/app_users"
tags: ["AppUsers"]
---

# Search

`POST /api/v1/search/app_users`

Search app users based on filters specified in the request body.

## Request body

- C1ApiAppV1AppUserServiceSearchRequest — Search App users based on filters specified in the request body
  - `appId` string — The app ID to restrict the search to.
  - `appUserDomains` string[], nullable — A list of account domains to restrict the search to.
  - `appUserIds` string[], nullable — A list of app user IDs to restrict the search to.
  - `appUserStatusDetails` string[], nullable — A list of app user status details to restrict the search to.
  - `appUserStatuses` string[], nullable — A list of app user statuses to restrict the search to.
  - `appUserTypes` string[], nullable — A list of app user types to restrict the search to.
  - `excludeAppUserIds` string[], nullable — A list of app user IDs to remove from the results.
  - `expandMask` C1ApiAppV1AppUserExpandMask — The AppUserExpandMask message contains a list of paths to expand in the response.
    - `paths` string[], nullable — The paths to expand in the response. May be any combination of "*", "identity_user_id", "app_id", and "last_usage".
  - `pageSize` integer — The pageSize where 0 <= pageSize <= 100. Values < 10 will be set to 10. A value of 0 returns the default page size (currently 25)
  - `pageToken` string — The pageToken field.
  - `query` string — Query the apps with a fuzzy search on display name and description.
  - `refs` C1ApiAppV1AppUserRef[], nullable — A list of app users to limit the search to.
    - `appId` string — The ID of the application.
    - `id` string — The ID of the app user.
  - `userIds` string[], nullable — A list of user IDs to restrict the search by.

## Response `200`

Successful response

- C1ApiAppV1AppUserServiceSearchResponse — The AppUserServiceSearchResponse message.
  - `expanded` object[], nullable — List of related objects.
    - `@type` string — The type of the serialized message.
  - `list` C1ApiAppV1AppUserView[], nullable — The list of results containing up to X results, where X is the page size defined in the request.
    - `appPath` string — JSONPATH expression indicating where the app is expanded in expanded arrays indicated in the request.
    - `appUser` C1ApiAppV1AppUser — Application User that represents an account in the application.
      - `appId` string — The ID of the application.
      - `appUserType` 'APP_USER_TYPE_UNSPECIFIED' | 'APP_USER_TYPE_USER' | 'APP_USER_TYPE_SERVICE_ACCOUNT' | 'APP_USER_TYPE_SYSTEM_ACCOUNT' — The appplication user type. Type can be user, system or service.
      - `createdAt` string, date-time
      - `deletedAt` string, date-time
      - `displayName` string — The display name of the application user.
      - `email` string — The email field of the application user.
      - `emails` string[], nullable — The emails field of the application user.
      - `employeeIds` string[], nullable — The employee IDs field of the application user.
      - `id` string — A unique idenditfier of the application user.
      - `identityUserId` string — The conductor one user ID of the account owner.
      - `isExternal` boolean — The isExternal field.
      - `profile` object
      - `status` C1ApiAppV1AppUserStatus — The satus of the applicaiton user.
        - `details` string — The details of applicaiton user status.
        - `status` 'STATUS_UNSPECIFIED' | 'STATUS_ENABLED' | 'STATUS_DISABLED' | 'STATUS_DELETED' — The application user status field.
      - `updatedAt` string, date-time
      - `username` string — The username field of the application user.
      - `usernames` string[], nullable — The usernames field of the application user.
    - `identityUserPath` string — JSONPATH expression indicating where the identity user is expanded in expanded arrays indicated in the request.
    - `lastUsagePath` string — JSONPATH expression indicating where the last usage information is expanded in expanded arrays indicated in the request.
  - `nextPageToken` string — The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retrieved. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

---

[API](https://skmtc.net/conductorone/apis/c1-api.md) · [All operations](https://skmtc.net/conductorone/apis/c1-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/conductorone/c1-api/revisions/d391405a35d3/schema)
