---
title: "List all shareholder invitations for a merchant"
method: GET
path: "/api/v1/merchants/{merchantId}/shareholder-invitations"
tags: ["Shareholder Invitations"]
---

# List all shareholder invitations for a merchant

`GET /api/v1/merchants/{merchantId}/shareholder-invitations`

## Request

- Base URL: `https://core.quidkey.com`
- URL: `https://core.quidkey.com/api/v1/merchants/{merchantId}/shareholder-invitations`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/banqzinc/apis/quidkey-api/docs/api/v1/merchants/:merchantId/shareholder-invitations/get.ts> (a function with typed inputs; its response is checked against the schema)

List all shareholder invitations for a merchant

## Path parameters

- `merchantId` string, uuid, required

## Response `200`

Success

- ShareholderInvitationListResponse: Response containing a list of shareholder invitations
  - `success` boolean, required: Indicates if the request was successful
  - `data` object[], required
    - `id` string, uuid, required: Shareholder invitation ID
    - `email` string, email, required: Invitee email address
    - `merchant_id` string, uuid, required: Merchant this invitation belongs to
    - `shareholder_type` string, nullable, required: Type of shareholder (individual)
    - `shareholder_country_iso2` string, nullable, required: Country ISO2 code set during onboarding
    - `status` union, required: Current status of the invitation
      - 'pending'
      - 'accepted'
    - `expires_at` string, date-time, required: When this invitation expires
    - `accepted_at` string, date-time, nullable, required: When the invitation was accepted
    - `opened_at` string, date-time, nullable, required: When the invitation link was first opened
    - `current_step` number, required: Current wizard step (0-3)
    - `current_step_name` string, required: Name of the current step (consent, basic_info, address, or complete)
    - `steps_completed` number[], required: Array of completed step numbers
    - `core_shareholder_id` string, uuid, nullable, required: ID of the shareholder created in Core (set after step 1)
    - `invited_by_user_id` string, uuid, nullable, required: User ID of the person who created this invitation
    - `created_at` string, date-time, required: When the invitation was created
    - `display_status` union, required: Computed display status for UI
      - 'accepted'
      - 'filling_details'
      - 'invite_created'
      - 'invite_sent'
    - `total_steps` number, required: Total number of wizard steps

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

## Changes

- **2026-06-17** `b372e7d5563d`: 1 info
  - endpoint added
- **2025-11-02** `919eb7a392aa`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/banqzinc/apis/quidkey-api/changes/api/v1/merchants/:merchantId/shareholder-invitations/get.md)

---

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