v3

latestSwagger 2.02026-08-067506752.0 MB

app

Get all active installs of this app

get/v1/app/install/{appId}

Path parameters

appIdstring required

App id

Query parameters

orgTypesstring

Comma-separated list of org types to include. Defaults to all org types.

hasRunProcessboolean

Whether to require that the app has run at least one process. Defaults to true.

internalOptionsstring

Filter app users by internal option key-value pair

Response

successful operation

nextstring

Example response

{
  "data": [
    {
      "id": "588f7ee98f138b19220041a7",
      "appId": "588f7ee98f138b19220041a7",
      "name": {
        "first": "Jane",
        "middle": "Quidditch",
        "last": "Public",
        "pref": "JQ",
        "prefLast": "Smith"
      },
      "email": "bob@example.com",
      "orgs": [
        {
          "orgId": "5887a7718f138b6a2a0041a7",
          "personId": "5887a7718f138b6a2a0041a7",
          "groupIds": [
            "588f7ee98f138b19220041a7"
          ],
          "roleId": "5887a7718f138b6a2a0041a7",
          "policyIds": [
            "588f7ee98f138b19220041a7"
          ],
          "homeEmail": "bob@example.com",
          "workEmail": "robert.doe@example.com",
          "workRoleId": "67c851da3dd1668c2fdd7e44"
        }
      ],
      "bundleInstall": {
        "entities": [
          {
            "entityId": "588f7ee98f138b19220041a7",
            "originalId": "588f7ee98f138b19220041a7"
          }
        ]
      },
      "activeAt": "2017-01-24T13:57:52Z",
      "loginAt": "2017-01-24T13:57:52Z",
      "appRunCheckAt": "2024-02-29T09:30:00Z",
      "title": "CEO",
      "remoteIp": "127.0.0.1",
      "createId": "588f7ee98f138b19220041a7",
      "createBehalfId": "588f7ee98f138b19220041a7",
      "createAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "createAt": "2017-01-24T13:57:52Z",
      "updateId": "588f7ee98f138b19220041a7",
      "updateBehalfId": "588f7ee98f138b19220041a7",
      "updateAttribution": {
        "principalUserId": "588f7ee98f138b19220041a7",
        "agentUserIds": [
          "588f7ee98f138b19220041a7"
        ],
        "eventId": "588f7ee98f138b19220041a7",
        "aiChatId": "588f7ee98f138b19220041a7"
      },
      "updateAt": "2017-01-24T13:57:52Z",
      "verifyAt": "2017-01-24T13:57:52Z",
      "emailSettings": [
        {
          "category": "ADMINISTRATIVE"
        }
      ],
      "shareAccess": [
        {
          "userId": "5887a7718f138b6a2a0041a7",
          "groupId": "5887a7718f138b6a2a0041a7",
          "fields": "name,image,title"
        }
      ],
      "agentConfig": {
        "approvedPolicyRules": [
          {
            "departmentIds": [
              "588f7ee98f138b19220041a7"
            ],
            "filter": "department:engineering and under:me",
            "targets": [
              {
                "personId": "588f7ee98f138b19220041a7"
              }
            ]
          }
        ],
        "managerJobId": "588f7ee98f138b19220041a7",
        "contentIds": [
          "588f7ee98f138b19220041a7"
        ]
      }
    }
  ],
  "access": [
    {
      "ids": [
        "588f7ee98f138b19220041a7"
      ]
    }
  ]
}