Cosmic Admin API Reference

listProjectInvitations

Lists project invitations and provides detailed information for listed invitations

Request parameters

Parameter NameDescriptionRequired
accountlist resources by account. Must be used with the domainId parameter.false
activeonlyif true, list only active invitations - having Pending state and ones that are not timed out yetfalse
domainidlist only resources belonging to the domain specifiedfalse
idlist invitations by idfalse
isrecursivedefaults to false, but if true, lists all resources from the parent specified by the domainId till leaves.false
keywordList by keywordfalse
listallIf set to false, list only resources belonging to the command's caller; if set to true - list resources that the caller is authorized to see. Default value is falsefalse
pagefalse
pagesizefalse
projectidlist by project idfalse
statelist invitations by statefalse

Response Tags

Response NameDescription
idthe id of the invitation
accountthe account name of the project's owner
domainthe domain name where the project belongs to
domainidthe domain id the project belongs to
emailthe email the invitation was sent to
projectthe name of the project
projectidthe id of the project
statethe invitation state