v1

latestOpenAPI 3.0.22026-07-2441902.6 MB

Apps API

Get installation enabled users

Gets the users enabled for a given installation

get/apps/{app_id}/installations/{id}/users

Path parameters

app_idstring required

The app id provided in the app registration step

idstring required

The installation id for a specific account

Response

A paginated list of users of the account enabled for the app

totalinteger

pageinteger

per_pageinteger

Example response

{
  "total": 2,
  "page": 1,
  "per_page": 1,
  "_embdedded": {
    "users": [
      {
        "id": "5b34eb0cdcba1b000bdbd320",
        "name": "Paulo Omni",
        "email": "paulo@talkdesk.com",
        "_links": {
          "self": {
            "href": "http://api-docs.talkdesk.org/users/{user_id}"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users"
    },
    "next": {
      "href": "https://api-docs.talkdesk.org/apps/{app_id}/installations/{installation_id}/users?page=2&per_page=1"
    }
  }
}