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

Request

List user invitations

Security

httpAuth

Path

domainIdstring, (uuid)required

Query

limitinteger, (int32)

startingAfterstring, (uuid)

sortOrderstring

Enum:"ASC""DESC"

sortBystring

Enum:"Code""ValidUntil""CreatedAt""LastModifiedAt""Alias"

statusArray of strings

Items Enum:"Pending""DeviceRegistered""Expired""Cancelled""Completed""Active"

aliasstring

roles[]Array of strings

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/custody/v1.41/devbox/v1/domains/{domainId}/users/invitations?limit=0&startingAfter=497f6eca-6276-4993-bfeb-53cbbbba6f08&sortOrder=ASC&sortBy=Code&status=Pending&alias=string&roles%5B%5D=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body

itemsArray of objectsrequired

countinteger, (int32)required

currentStartingAfterstring or null, (uuid)

nextStartingAfterstring or null, (uuid)

Response

{
  "items": [
    { … }
  ],
  "count": 0,
  "currentStartingAfter": "651be221-e717-4828-840c-fe29ed82c461",
  "nextStartingAfter": "2e35122f-8704-4d6f-b465-9a3a43a644e9"
}