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

# List portal consumer invites

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

## Request

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

Returns a paginated list of invites 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[]
- `status` union
  - 'pending' | 'accepted'
  - string[]

## Headers

- `Metorial-Version` string

## Response `200`

Successful response

- ConsumerInviteList
  - `items` ConsumerInvite[], required
    - `object` 'consumer.invite', required
    - `id` string, required
    - `status` 'pending' | 'accepted', required
    - `portal_url` string, nullable, required
    - `consumer_profile` object, required
      - `object` 'consumer.profile#preview', required
      - `id` string, required
      - `name` string, required
      - `email` string, required
    - `invited_by` object, required
      - `object` 'organization.actor#preview', required
      - `id` string, required
      - `name` string, required
      - `email` string, nullable, required
    - `message` string, nullable, required
    - `accepted_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, 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)