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.
| Scope | users Deprecated scope name: get_citizenaccess_citizens_invitations |
| App Type | Citizen |
| Authorization Type | Access token |
| URI | /v4/citizenaccess/citizens/invitations?userName={userName}&name={name}&delegateStatus={delegateStatus}&offset={offset}&limit={limit}&lang={lang} |
| HTTP Method | GET |
| Automation Version(s) | 7.3.3.5 |
| Field or Parameter | Type | Required | Values | Description | Automation Version |
|---|---|---|---|---|---|
| delegateStatus | string | No | PENDING | ACCEPT | REJECT | EXPIRED | The status of the delegate request. | 7.3.3.5 |
| lang | String | No | � | Indicates the language applied. | 7.3.3.5 |
| limit | long | No | � | Indicates the number of items that are returned in each page. | 7.3.3.5 |
| name | string | No | � | The name of the object to be queried. | 7.3.3.5 |
| offset | long | No | � | Indicates the offset start of each page by the number specified. | 7.3.3.5 |
| userName | string | No | � | The login name of the user to be queried. | 7.3.3.5 |
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result[] | result{} | � | 7.3.3.5 |
| result.delegateStatus | string | The status of the delegate request. | 7.3.3.5 |
| result.id | long | The delegate id. | 7.3.3.5 |
| result.invitationMessage | string | The invitation message sent to the delegate. | 7.3.3.5 |
| result.name | string | The delegate's nick name. | 7.3.3.5 |
| result.permissions[] | result.permissions{} | Contains delegate permission attributes. | 7.3.3.5 |
| result.permissions.amendAllowed | boolean | If true, the delegate is allowed to amend records. | 7.3.3.5 |
| result.permissions.createRecordAllowed | boolean | If true, the delegate is allowed to create records. | 7.3.3.5 |
| result.permissions.documentAllowed | boolean | If true, the delegate is allowed to manage documents. | 7.3.3.5 |
| result.permissions.inspectionAllowed | boolean | If true, the delegate is allowed to manage inspections. | 7.3.3.5 |
| result.permissions.level | string | The permission level. | 7.3.3.5 |
| result.permissions.levelValue | string | The value for the permission level, as configured in Automation. | 7.3.3.5 |
| result.permissions.paymentAllowed | boolean | If true, the delegate is allowed to make payments. | 7.3.3.5 |
| result.permissions.renewalAllowed | boolean | If true, the delegate is allowed to renew records. | 7.3.3.5 |
| result.permissions.viewRecordAllowed | boolean | If true, the delegate is allowed to view records. | 7.3.3.5 |
| result.userName | string | The delegate's login name. | 7.3.3.5 |
| status | integer | The record status. | 7.3.3.5 |
{
"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": "apiextuser1@accela.com",
"invitationMessage": "You are invited",
"delegateStatus": "PENDING"
}
],
"status": 200,
"page": {
"offset": 0,
"limit": 25,
"hasmore": false
}
}