Retrieve a list of organizations#

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 2027-01-31.

Description#

Returns a paginated list of organizations.

For Managed Service Providers only

This endpoint is only for Managed Service Provider (MSP) applications and requires a valid Wk-Service-Provider header. Most customers are not MSPs and do not need this endpoint.

Not an MSP? Retrieve your organization ID directly from the Workiva UI instead. See How to find IDs for Workiva files and items for instructions. Save the organization ID as a variable so you can reuse it in subsequent API calls.

MSP users: Find your Wk-Service-Provider value in the URL of your Service Provider Admin (SPA) screen. After signing in, select your service provider name to open the SPA. The URL will look like https://app.wdesk.com/s/admin/sp-orgs?sp=sp_a1b2c3d4e5f6789012345678abcdef90. The value after sp= (in this example, sp_a1b2c3d4e5f6789012345678abcdef90) is your Wk-Service-Provider header value.

GET /prototype/admin/organizations

Parameters#

Parameter	In	Type	Required	Description
X-Version	header	string	false	Version of the API (2022-01-01)
Wk-Service-Provider	header	string	true	The unique identifier of the service provider
$maxpagesize	query	integer	false	The maximum number of results to retrieve
$next	query	string	false	Pagination cursor for next set of results.
$filter	query	string	false	The properties to filter the results by.
$orderBy	query	string	false	One or more comma-separated expressions to indicate the order in which to sort the results.

Filter Options#

Available logical operators: and, or

Name	Predicates Supported
created	`eq`, `ne`, `gt`, `ge`, `lt`, `le`
modified	`eq`, `ne`, `gt`, `ge`, `lt`, `le`
name	`eq`, `ne`, `gt`, `ge`, `lt`, `le`, `contains`
status	`eq`

Sorting Options#

Name	Orders Supported
modified	`asc`, `desc`
name	`asc`, `desc`

Code Samples#

curl

curl -X GET https://api.app.wdesk.com/prototype/admin/organizations \
    -H 'Accept: application/json' \
    -H 'Wk-Service-Provider: string' \
    -H 'Authorization: Bearer {access-token}' \
    -H 'X-Version: 2022-01-01'

httpie

http GET https://api.app.wdesk.com/prototype/admin/organizations \
    X-Version:2022-01-01 \
    Accept:application/json \
    Wk-Service-Provider:string \
    Authorization:"Bearer {access-token}"

wget

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

python

import requests

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

r = requests.get('https://api.app.wdesk.com/prototype/admin/organizations', headers = headers)

print(r.json())

Returns#

200 - OK#

Returns a JSON object with data and @nextLink properties. data contains a list of Organization objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.