---
title: "GET /v1/domains/{domainId}/users/invitations"
method: GET
path: "/v1/domains/{domainId}/users/invitations"
tags: ["User invitations"]
---

# GET /v1/domains/{domainId}/users/invitations

`GET /v1/domains/{domainId}/users/invitations`

List user invitations

## Path parameters

- `domainId` string, uuid, required

## Query parameters

- `limit` integer
- `startingAfter` string, uuid
- `sortOrder` 'ASC' | 'DESC'
- `sortBy` 'Code' | 'ValidUntil' | 'CreatedAt' | 'LastModifiedAt' | 'Alias'
- `status` CoreExtensionsInvitationStatusQuery[]
- `alias` string
- `roles[ ]` string[]

## Response `200`

OK

- CoreExtensionsInvitationPaginationResult
  - `items` CoreExtensionsInvitationOut[], required
    - `id` string, uuid, required
    - `code` string, required
    - `status` 'Pending' | 'DeviceRegistered' | 'Expired' | 'Cancelled' | 'Completed', required
    - `validUntil` string, date-time, required
    - `user` CoreExtensionsUserEditOut, required
      - `alias` string, required
      - `customProperties` object, required
      - `description` string, nullable
      - `id` string, uuid, required
      - `domainId` string, uuid, required
      - `lock` 'Unlocked' | 'Locked', required
      - `roles` string[], required
      - `publicKey` string, nullable
    - `metadata` CoreExtensionsMetadata, required
      - `createdAt` string, date-time, required
      - `lastModifiedAt` string, date-time, required
      - `createdBy` CoreExtensionsUserReference, required
        - `id` string, uuid, required
        - `domainId` string, uuid, required
  - `count` integer, required
  - `currentStartingAfter` string, uuid, nullable
  - `nextStartingAfter` string, uuid, nullable

---

[API](https://skmtc.net/ripple/apis/ripple-custody-api.md) · [All operations](https://skmtc.net/ripple/apis/ripple-custody-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ripple/ripple-custody-api/revisions/0b55c0ddf07a/schema)