> Markdown versions of all pages of this connector library are available by appending `.md` to the page URL. For the full index of connectors, see [llms.txt](https://connectors.appmixer.com/llms.txt).

# List Supervisory Organizations

- Component: `appmixer.workday.core.ListSupervisoryOrganizations`
- Kind: Action
- Version: 1.0.0
- Visibility: Public
- Connector: [appmixer.workday 1.0.0](https://connectors.appmixer.com/connector/appmixer.workday/1.0.0.md)
- Component page: <https://connectors.appmixer.com/connector/appmixer.workday/1.0.0/component/appmixer.workday.core.ListSupervisoryOrganizations>

Retrieve all active supervisory organizations of the tenant with their name, code, reference ID and managers. Optionally adds the superior organization of each one, which gives the organization hierarchy. Reads every page of the result.

## Input ports

### Port `in`

| Field | Type | Description |
| --- | --- | --- |
| Include Hierarchy (`includeHierarchy`) | toggle | Turn on to add the superior (parent) organization to each organization. A top level organization has none. Takes one extra request per organization. |
| Output Type (`outputType`) | select | Choose whether you want to receive the result set as one complete list, or first item only or one item at a time or stream the items to a file. |

## Output ports

### Port `out`

Variables are loaded dynamically from `/component/appmixer/workday/core/ListSupervisoryOrganizations?outPort=out&ignoreAuth=true`.

## Full metadata (component.json)

```json
{
  "name": "appmixer.workday.core.ListSupervisoryOrganizations",
  "label": "List Supervisory Organizations",
  "description": "Retrieve all active supervisory organizations of the tenant with their name, code, reference ID and managers. Optionally adds the superior organization of each one, which gives the organization hierarchy. Reads every page of the result.",
  "author": "Appmixer <info@appmixer.com>",
  "version": "1.0.0",
  "auth": {
    "service": "appmixer:workday"
  },
  "quota": {
    "manager": "appmixer:workday",
    "resources": "requests",
    "scope": {
      "userId": "{{userId}}"
    }
  },
  "inPorts": [
    {
      "name": "in",
      "schema": {
        "type": "object",
        "properties": {
          "includeHierarchy": {
            "type": "boolean",
            "default": false
          },
          "outputType": {
            "type": "string",
            "default": "array"
          }
        }
      },
      "inspector": {
        "inputs": {
          "includeHierarchy": {
            "type": "toggle",
            "index": 1,
            "label": "Include Hierarchy",
            "defaultValue": false,
            "tooltip": "Turn on to add the superior (parent) organization to each organization. A top level organization has none. Takes one extra request per organization."
          },
          "outputType": {
            "type": "select",
            "label": "Output Type",
            "index": 2,
            "defaultValue": "array",
            "tooltip": "Choose whether you want to receive the result set as one complete list, or first item only or one item at a time or stream the items to a file.",
            "options": [
              {
                "label": "First Item Only",
                "value": "first"
              },
              {
                "label": "All items at once",
                "value": "array"
              },
              {
                "label": "One item at a time",
                "value": "object"
              },
              {
                "label": "Store to CSV file",
                "value": "file"
              }
            ]
          }
        }
      }
    }
  ],
  "outPorts": [
    {
      "name": "out",
      "source": {
        "url": "/component/appmixer/workday/core/ListSupervisoryOrganizations?outPort=out&ignoreAuth=true",
        "data": {
          "properties": {
            "generateOutputPortOptions": true
          },
          "messages": {
            "in/outputType": "inputs/in/outputType"
          }
        }
      }
    }
  ],
  "icon": "(data URI omitted)"
}
```
