---
title: "List portal consumer profiles"
method: GET
path: "/portals/{portal_id}/consumer-profile"
tags: ["Portal Consumer Profiles"]
---

# List portal consumer profiles

`GET /portals/{portal_id}/consumer-profile`

## Request

- Base URL: `https://api.metorial.com`
- URL: `https://api.metorial.com/portals/{portal_id}/consumer-profile`
- Auth: HTTP bearer

Returns a paginated list of consumer profiles for a portal.

## Path parameters

- `portal_id` string, required

## Query parameters

- `limit` number
- `after` string
- `before` string
- `cursor` string
- `order` 'asc' | 'desc'
- `search` string
- `email` union
  - string
  - string[]
- `consumer_group_id` string
- `status` union
  - 'active' | 'invited'
  - string[]

## Headers

- `Metorial-Version` string

## Response `200`

Successful response

- ConsumerProfileList
  - `items` object[], required
    - `object` 'consumer.profile', required
    - `id` string, required
    - `name` string, required
    - `email` string, required
    - `image_url` string, required
    - `consumer_id` string, required
    - `user_id` string, nullable, required
    - `status` 'active' | 'invited', required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `groups` Group[], nullable, required
      - `object` 'consumer.profile.group_assignment', required
      - `group` ConsumerGroup, required
        - `object` 'consumer.group', required
        - `id` string, required
        - `status` 'active' | 'archived' | 'deleted', required
        - `name` string, required
        - `description` string, nullable, required
        - `is_default` boolean, required
        - `created_at` string, date-time, required
        - `updated_at` string, date-time, required
      - `assigned_via` 'default' | 'manual' | 'sso' | 'user', required
  - `pagination` object, required
    - `has_more_before` boolean, required
    - `has_more_after` boolean, required

## Other responses

- `400`: Invalid parameters or action
- `401`: Missing or invalid API key
- `403`: The key lacks permission for this resource
- `404`: No such resource
- `422`: Validation failed
- `429`: Rate limit exceeded
- `500`: Unexpected server error

---

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