API Reference

List connections

Description

A pageable endpoint to list data connections between features of the Workiva platform

GET /api/v1/connections

🚧

Required OAuth Scopes:

No OAuth scopes are required to use this endpoint.

Parameters

ParameterInTypeRequiredDescription
sourceTypequerystringfalseThe type of file or item the connection pulls data from
destinationTypequerystringfalseThe type of file or item the connection sends data to
sourceIdquerystringfalseThe ID of the file or item the connection pulls data from
destinationIdquerystringfalseThe ID of the file or item the connection sends data to
limitqueryinteger(int32)falseThe number of connections to return, from 1 to 1000; by default, 1000
cursorquerystringfalseA paging cursor; if included, limit is ignored
offsetqueryinteger(int64)falseThe item to start with on the page, greater than or equal to 0; by default, 0

Enumerated Values

ParameterValue
sourceType[spreadsheet
sourceTypespreadsheet_section
sourceTypepresentation
sourceTypepresentation_chart
sourceTypepresentation_embedded_table
sourceTypedocument
sourceTypedocument_chart
sourceTypedocument_embedded_table
sourceTypewdata_query
sourceTypewdata_table
sourceTypewdata_table_dataset
sourceTypereport]
destinationType[spreadsheet
destinationTypespreadsheet_section
destinationTypepresentation
destinationTypepresentation_chart
destinationTypepresentation_embedded_table
destinationTypedocument
destinationTypedocument_chart
destinationTypedocument_embedded_table
destinationTypewdata_query
destinationTypewdata_table
destinationTypewdata_table_dataset
destinationTypereport]

Code Samples

curl -X GET https://h.app.wdesk.com/s/wdata/prep/api/v1/connections  \ 
-H 'Accept: application/json' \ 
-H 'Authorization: Bearer {access-token}'
http GET https://h.app.wdesk.com/s/wdata/prep/api/v1/connections  \ 
Accept:application/json \ 
Authorization:"Bearer {access-token}"
wget --method=GET "https://h.app.wdesk.com/s/wdata/prep/api/v1/connections" \
 --output-document -  \ 
 --header 'Accept: application/json' \ 
 --header 'Authorization: Bearer {access-token}'
import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://h.app.wdesk.com/s/wdata/prep/api/v1/connections', headers = headers)

print(r.json())

Returns

200 - OK

undefined

Example Responses


{
  "body": [
    {
      "connectionId": "string",
      "created": "string",
      "createdBy": "string",
      "description": "string",
      "destinationId": "string",
      "destinationType": "string",
      "lastRunBy": "string",
      "lastRunDate": "string",
      "lastRunDestinationParameters": {},
      "lastRunJobId": "string",
      "lastRunSourceParameters": {},
      "metadata": {},
      "name": "string",
      "sourceId": "string",
      "sourceType": "string"
    }
  ],
  "code": "integer",
  "cursor": "string"
}