v3

latestSwagger 2.02026-08-067506752.0 MB

app

Find installed app users

get/v1/app/org/{orgId}/install

Path parameters

orgIdstring required

Org identifier (either id or slug)

Query parameters

typestring

Filter by type (app, bundle)

tagsstring

Filter by tag

statusesstring

Filter by App User statuses, comma-separated. Accepted values: ['NORMAL', 'INACTIVE', 'UNINSTALLED']

includeFormerboolean

Whether to include app users with NONE access to orgs they pertain to. Default is false

fromstring

App id to start from

limitinteger

Number of results to return

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"
      ]
    }
  ]
}