Get All Invitations

Gets invitations or delegate requests received by the logged-in user. To get the logged-in user's pending invitations, set the {delegateStatus} parameter to PENDING.

Resource Information


Deprecated scope name:   get_citizenaccess_citizens_invitations

App TypeCitizen
Authorization TypeAccess token
URI /v4/citizenaccess/citizens/invitations?userName={userName}&name={name}&delegateStatus={delegateStatus}&offset={offset}&limit={limit}&lang={lang}
Automation Version(s)

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
delegateStatusstringNoPENDING | ACCEPT | REJECT | EXPIREDThe status of the delegate request.
langStringNo Indicates the language applied.
limitlongNo Indicates the number of items that are returned in each page.
namestringNo The name of the object to be queried.
offsetlongNo Indicates the offset start of each page by the number specified.
userNamestringNo The login name of the user to be queried.


Sample Request Head


Response Information

FieldTypeDescriptionAutomation Version
result.delegateStatusstringThe status of the delegate request.
result.idlongThe delegate id.
result.invitationMessagestringThe invitation message sent to the delegate.
result.namestringThe delegate's nick name.
result.permissions[]result.permissions{}Contains delegate permission attributes.
result.permissions.amendAllowedbooleanIf true, the delegate is allowed to amend records.
result.permissions.createRecordAllowedbooleanIf true, the delegate is allowed to create records.
result.permissions.documentAllowedbooleanIf true, the delegate is allowed to manage documents.
result.permissions.inspectionAllowedbooleanIf true, the delegate is allowed to manage inspections.
result.permissions.levelstringThe permission level.
result.permissions.levelValuestringThe value for the permission level, as configured in Automation.
result.permissions.paymentAllowedbooleanIf true, the delegate is allowed to make payments.
result.permissions.renewalAllowedbooleanIf true, the delegate is allowed to renew records.
result.permissions.viewRecordAllowedbooleanIf true, the delegate is allowed to view records.
result.userNamestringThe delegate's login name.
statusintegerThe record status.


Sample Response Body

  "result": [
      "name": "testdelegate",
      "permissions": [
          "level": "MODULE",
          "levelValue": "Building",
          "paymentAllowed": false,
          "createRecordAllowed": false,
          "renewalAllowed": false,
          "documentAllowed": false,
          "amendAllowed": false,
          "viewRecordAllowed": true,
          "inspectionAllowed": false
      "id": 8774,
      "userName": "",
      "invitationMessage": "You are invited",
      "delegateStatus": "PENDING"
  "status": 200,
  "page": {
    "offset": 0,
    "limit": 25,
    "hasmore": false