---
title: "Get list of client apps"
method: GET
path: "/workspaces/{workspace_id}/clientapps"
tags: ["Client Apps"]
---

# Get list of client apps

`GET /workspaces/{workspace_id}/clientapps`

## Request

- Base URL: `https://app.mammoth.io/api/v2`
- URL: `https://app.mammoth.io/api/v2/workspaces/{workspace_id}/clientapps`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-KEY` and API key in header `X-API-SECRET` and API key in header `X-WORKSPACE-ID`

Get list of client apps specific to given user and workspace

## Path parameters

- `workspace_id` integer, required: Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

## Query parameters

- `limit` integer: Max number of result to return
- `offset` integer: Distance from the beginning of the list of results
- `fields` string: Fields to return. Can be (id, app_name)
- `sort` string, nullable: Returned client apps based on this parameter Use the format '(field:asc)' for ascending and '(field:desc)' for descending order.

## Response `200`

List of client apps

- ClientAppsList
  - `result` union[], required
    - union
      - ClientAppSchema
        - `description` string, nullable: Description of client app or api tokens
        - `workspace_id` integer, nullable: Workspace ID of client app or api tokens
        - `user_id` integer, nullable: User ID of client app or api tokens
        - `last_usage` string, date-time, nullable: Last usage of client app or api tokens
        - `created_at` string, date-time, nullable: Creation time of client app or api tokens. Null for apps created before this was recorded.
        - `id` integer, required: ID of client app or api tokens
        - `app_name` string, required: Name of client app or api tokens
        - `app_key` string, required: App key of client app or api tokens
      - ClientAppMinSchema
        - `id` integer, required: ID of client app or api tokens
        - `app_name` string, required: Name of client app or api tokens
        - `app_key` string, required: App key of client app or api tokens
        - `type` 'legacy' | 'token', required: Which credential this app authenticates with — 'legacy' for the X-API-KEY/X-API-SECRET pair or 'token' for a single Bearer token. app_key is only a usable credential (paired with the secret) for a legacy app — for a token app it is a display id only.
      - ClientAppStdSchema
        - `id` integer, required: ID of client app or api tokens
        - `app_name` string, required: Name of client app or api tokens
        - `app_key` string, required: App key of client app or api tokens
        - `type` 'legacy' | 'token', required: Which credential this app authenticates with — 'legacy' for the X-API-KEY/X-API-SECRET pair or 'token' for a single Bearer token. app_key is only a usable credential (paired with the secret) for a legacy app — for a token app it is a display id only.
        - `description` string, nullable: Description of client app or api tokens
        - `workspace_id` integer, required: Workspace ID of client app or api tokens
        - `user_id` integer, required: User ID of client app or api tokens
        - `project_id` integer, nullable: Project ID of client app or api tokens
        - `last_usage` string, date-time, nullable: Last usage of client app or api tokens
        - `created_at` string, date-time, nullable: Creation time of client app or api tokens. Null for apps created before this was recorded.
      - ClientAppFullSchema
        - `id` integer, required: ID of client app or api tokens
        - `app_name` string, required: Name of client app or api tokens
        - `app_key` string, required: App key of client app or api tokens
        - `type` 'legacy' | 'token', required: Which credential this app authenticates with — 'legacy' for the X-API-KEY/X-API-SECRET pair or 'token' for a single Bearer token. app_key is only a usable credential (paired with the secret) for a legacy app — for a token app it is a display id only.
        - `description` string, nullable: Description of client app or api tokens
        - `workspace_id` integer, required: Workspace ID of client app or api tokens
        - `user_id` integer, required: User ID of client app or api tokens
        - `project_id` integer, nullable: Project ID of client app or api tokens
        - `last_usage` string, date-time, nullable: Last usage of client app or api tokens
        - `created_at` string, date-time, nullable: Creation time of client app or api tokens. Null for apps created before this was recorded.
      - ClientAppFieldsSchema
        - `description` string, nullable: Description of client app or api tokens
        - `workspace_id` integer, nullable: Workspace ID of client app or api tokens
        - `user_id` integer, nullable: User ID of client app or api tokens
        - `last_usage` string, date-time, nullable: Last usage of client app or api tokens
        - `created_at` string, date-time, nullable: Creation time of client app or api tokens. Null for apps created before this was recorded.
        - `id` integer, nullable: ID of client app or api tokens
        - `app_name` string, nullable: Name of client app or api tokens
        - `app_key` string, nullable: App key of client app or api tokens
        - `type` 'legacy' | 'token': Which credential this app authenticates with — 'legacy' for the X-API-KEY/X-API-SECRET pair or 'token' for a single Bearer token. app_key is only a usable credential (paired with the secret) for a legacy app — for a token app it is a display id only.

## Other responses

- `400`: Bad Request
- `401`: Authorization error
- `403`: Request forbidden -- authorization will not help

---

[API](https://skmtc.dev/mammoth/apis/mammoth-analytics.md) · [All operations](https://skmtc.dev/mammoth/apis/mammoth-analytics/llms.txt) · [OpenAPI document](https://skmtc.dev/mammoth/apis/mammoth-analytics/revisions/4b2c943a00dc?raw)