# Profiles

## Search account profiles

`$ cadenya workspace-admin:profiles list`

**get** `/v1/account/profiles`

Searches the account's profiles for a member picker, with free-form name/email search and an optional type filter. Account-scoped; admin only.

### Parameters

- `--cursor: optional string`

  Pagination cursor from previous response

- `--limit: optional number`

  Maximum number of results to return

- `--query: optional string`

  Free-form search over profile name and email. Case-insensitive substring
  match; empty returns all profiles.

### Returns

- `ListProfilesResponse: object { items, pagination }`

  - `items: optional array of Profile`

    - `metadata: object { id, accountId, name, 3 more }`

      AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

      - `id: string`

        Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

      - `accountId: string`

        Account this resource belongs to for multi-tenant isolation (prefixed ULID)

      - `name: string`

        Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool")
        Required for resources that users interact with directly

      - `profileId: string`

      - `externalId: optional string`

        External ID for the resource (e.g., a workflow ID from an external system)

      - `labels: optional map[string]`

        Arbitrary key-value pairs for categorization and filtering
        Examples: {"environment": "production", "team": "platform", "version": "v2"}

    - `spec: object { type, email, name }`

      Configuration for a profile.

      - `type: "PROFILE_TYPE_UNSPECIFIED" or "PROFILE_TYPE_USER" or "PROFILE_TYPE_API_KEY" or "PROFILE_TYPE_SYSTEM"`

        Whether this profile represents a human user, an API key, or a system
        principal.

        - `"PROFILE_TYPE_UNSPECIFIED"`

        - `"PROFILE_TYPE_USER"`

        - `"PROFILE_TYPE_API_KEY"`

        - `"PROFILE_TYPE_SYSTEM"`

      - `email: optional string`

        Email address of the profile. Required and unique within an account for
        user profiles.

      - `name: optional string`

        Display name (e.g., "Bobby Tables").

  - `pagination: optional object { nextCursor, total }`

    - `nextCursor: optional string`

    - `total: optional number`

### Example

```cli
cadenya workspace-admin:profiles list \
  --api-key 'My API Key'
```

#### Response

```json
{
  "items": [
    {
      "metadata": {
        "id": "id",
        "accountId": "accountId",
        "name": "name",
        "profileId": "profileId",
        "externalId": "externalId",
        "labels": {
          "foo": "string"
        }
      },
      "spec": {
        "type": "PROFILE_TYPE_UNSPECIFIED",
        "email": "email",
        "name": "name"
      }
    }
  ],
  "pagination": {
    "nextCursor": "nextCursor",
    "total": 0
  }
}
```