List organization users

Deprecated

This endpoint is deprecated and may be removed in a future release.

This endpoint was deprecated on 2026-02-12.

It is scheduled for sunset on 2029-01-31.

Description

Similar to an organization admin’s “People View” export, this returns a paged list of specific details about the organization’s users, including their usernames, display names, email addresses, SAML IDs, last logins, workspace memberships, licenses and roles. Results are sorted by displayName.

To obtain an organization’s users, you need its organizationId. To view the organizationId in Wdesk, click your name in the lower left, and select Organization Admin. In the URL in your browser, the organizationId appears as a GUID after the /o/ such as 371b5fc8-fcc4-404a-9d22-d07d8f46a7e0. To view the ID of another organization you manage, select Switch Organizations from the left-hand menu, and search for and select the organization.

Requires the calling user to be an organization admin.

GET /admin/v1/organizations/{organizationId}/orgReportUsers

Required OAuth Scopes

No OAuth scopes are required to use this endpoint.

Parameters

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
organizationId	path	string(uuid)	true	The unique identifier of the organization
page[after]	query	string	false	Paging cursor
page[size]	query	integer(int64)	false	Number of items to return. Maximum of 1000.

Code Samples

curl

curl -X GET https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/orgReportUsers \
    -H 'Accept: application/json' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http GET https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/orgReportUsers \
    X-Version:2022-01-01 \
    Accept:application/json \
    Authorization:"Bearer {access-token}"

wget

wget --method=GET "https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/orgReportUsers" \
    --output-document -  \ 
    --header 'Accept: application/json' \ 
    --header 'Authorization: Bearer {access-token}' \
    --header 'X-Version: 2022-01-01'

python

import requests

headers = {
  'X-Version': '2022-01-01',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.app.wdesk.com/admin/v1/organizations/{organizationId}/orgReportUsers', headers = headers)

print(r.json())

Returns

200 - OK

A report of Organization Users

400 - BAD_REQUEST

An error response. All fields other than “errors” are optional

401 - UNAUTHORIZED

An error response. All fields other than “errors” are optional

403 - FORBIDDEN

An error response. All fields other than “errors” are optional

404 - NOT_FOUND

An error response. All fields other than “errors” are optional

405 - METHOD_NOT_ALLOWED

An error response. All fields other than “errors” are optional

415 - UNSUPPORTED_MEDIA_TYPE

An error response. All fields other than “errors” are optional

500 - INTERNAL_SERVER_ERROR

An error response. All fields other than “errors” are optional

501 - NOT_IMPLEMENTED

An error response. All fields other than “errors” are optional

503 - SERVICE_UNAVAILABLE

An error response. All fields other than “errors” are optional

Example Responses

200 Response

{
  "data": [
    {
      "attributes": {
        "active": true,
        "displayName": "Jane Smith",
        "email": "jane.smith@example.com",
        "firstName": "Jane",
        "lastLogin": null,
        "lastName": "Smith",
        "licenses": [
          "Support"
        ],
        "organizationRoles": [
          "Organization User Admin",
          "Organization Security Admin"
        ],
        "samlId": null,
        "userName": "jane.smith@example.com",
        "workspaceMemberships": [
          {
            "id": "QWNjb3VudB82NzUwMjAwMDc",
            "workspaceName": "Test Workspace",
            "workspaceRoles": []
          }
        ]
      },
      "id": "abc123",
      "type": "orgReportUser"
    }
  ],
  "links": {
    "next": "https://api.wdesk.com/admin/v1/organizations/orgId123-456-789/orgReportUsers?page[size]=1&page[after]=..."
  }
}

400 Response

{
  "errors": [
    {
      "detail": "page[size] must be a positive integer",
      "source": {
        "parameter": "page[size]"
      },
      "status": "400",
      "title": "Invalid Page Size"
    }
  ]
}

401 Response

{
  "errors": [
    {
      "code": "string",
      "detail": "string",
      "id": "string",
      "links": {
        "about": "string"
      },
      "meta": {},
      "source": {
        "parameter": "string",
        "pointer": "string"
      },
      "status": "string",
      "title": "string"
    }
  ],
  "jsonapi": {
    "version": "string"
  },
  "links": {},
  "meta": {}
}