> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# List approval resources

GET https://api.moveworks.ai/configurations/v1alpha1/tool/approval/resources

Returns every approval resource in your organization as a JSON array.

Reference: https://docs.moveworks.com/api-reference/configuration-api/approvals/approval-resources/list-approval-resources

## Authentication

- `Authorization` header (bearer token, required) — JWT bearer token authentication. Include the Configuration API key in the Authorization header as 'Bearer \<token>'.

## Response

### 200

The approval resources in your organization

- `list of ApprovalResourceConfig`

## Errors

### 401 Unauthorized Error

Unauthorized - the `Authorization` header is missing or the token is invalid

- `error` (ErrorResponseError, required)

### 403 Forbidden Error

Forbidden - the API key isn't allowed to change this configuration, or the configuration is frozen for your organization

- `error` (ErrorResponseError, required)

### 429 Too Many Requests Error

Too many requests - the organization exceeded the Configuration API rate limit. Back off and retry.

- `error` (ErrorResponseError, required)

### 500 Internal Server Error

Internal server error - retry the request

- `error` (ErrorResponseError, required)

## Types

### ApprovalResourceConfig

Approval settings for one connector and approval record type pair, such as ServiceNow change requests. These take precedence over connector-level and org-wide settings.

- `id` (string, optional) — Unique identifier of this configuration, assigned by the server.
- `connector_id` (string, optional) — The connector these approval settings apply to. Each connector and resource type pair can have only one configuration; cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `resource_type` (enum, optional) — The approval record type these settings apply to, such as REQUEST_ITEM, CHANGE_REQUEST, or TIME_OFF_REQUEST. Cannot be changed after creation.
  - Allowed values: `REQUEST_ITEM`, `SERVICE_REQUEST`, `INCIDENT`, `CHANGE_REQUEST`, `TIME_OFF_REQUEST`, `ACCESS_REVIEW`, `POLICY_EXCEPTION`, `LEAVE_OF_ABSENCE`, `KNOWLEDGE`, `EXPENSE`, `JOB_REQUISITION`, `PURCHASE_REQUISITION`, `INVOICE`, `TIMESHEET`, `TASK`, `HR_CASE`
- `buttons` (list of ButtonSettings, optional) — Buttons shown to the approver, defining the actions they can take or links to external systems.
- `link_strategy` (LinkStrategySettings, optional) — How the approval record links to the external system.
- `mapper_bender` (ApprovalResourceConfigMapperBender, optional) — Data mapping that builds the approval record from external system attributes, controlling how it looks to the approver. If empty, the system defaults are used.
- `augmenter_bender` (ApprovalResourceConfigAugmenterBender, optional) — Data mapping that adds extra details to the approval record. Its input includes the output of mapper_bender and data from augmenting_data_retrievers. If empty, the system defaults are used.
- `augmenting_data_retrievers` (list of DataRetrieverSettings, optional) — Data retrievers that fetch additional details for approval records. Their output is available to augmenter_bender.
- `record_prefilter_dsl` (string, optional) — DSL rule selecting which approval records are processed and stored. Excluded records send no notifications and do not appear in the approver's queue. Leave empty to include all.
- `database_filter_dsl` (string, optional) — DSL rule filtering approval records by their fields. Excluded records send no notifications and do not appear in the approver's queue.
- `notification_filter_dsl` (string, optional) — DSL rule selecting which approval records send a notification to the approver. Records without a notification still appear in the approver's queue.
- `external_resource_keys` (list of string, optional) — External system resource keys that map to this resource type, for systems that have multiple resource types.
- `updated_time` (datetime, optional) — When the configuration was last updated.
- `updated_by` (string, optional) — Who last updated the configuration.
- `version` (Version, optional) — Document version. On update, send back the num from your last read.

### ErrorResponseError

- `code` (string, optional) — A machine-readable error code.
- `message` (string, optional) — What went wrong, and for a rejected field, which rule it broke.

### ButtonSettings

- `type` (string, optional) — Button template, which sets what the button does, e.g. approve_with_comment adds a comment to the approval record.
- `display_info` (ButtonDisplayInfoSettings, optional) — Overrides for the button title or style.
- `item_ref` (string, optional) — Server-assigned row identifier. Leave unset on create; send back the value from your last read on update so the row keeps its identity.

### LinkStrategySettings

- `template` (TemplateLinkSettings, optional) — Link to an external resource built from a URL template. Set this or ticket.
- `ticket` (TicketLinkSettings, optional) — Link to the associated ticket in the external ticketing system. Set this or template.

### ApprovalResourceConfigMapperBender

Data mapping that builds the approval record from external system attributes, controlling how it looks to the approver. If empty, the system defaults are used.

### ApprovalResourceConfigAugmenterBender

Data mapping that adds extra details to the approval record. Its input includes the output of mapper_bender and data from augmenting_data_retrievers. If empty, the system defaults are used.

### DataRetrieverSettings

- `ticket_approval_data_retriever` (TicketApprovalDataRetrieverSettings, optional) — Retrieves details of the ticket linked to the approval record. Set exactly one retriever type.
- `ariba_approvable_data_retriever` (AribaApprovableDataRetrieverSettings, optional) — Retrieves approvable details from SAP Ariba. Set exactly one retriever type.
- `concur_approvable_data_retriever` (ConcurApprovableDataRetrieverSettings, optional) — Retrieves approvable details from SAP Concur. Set exactly one retriever type.
- `coupa_approvable_data_retriever` (CoupaApprovableDataRetrieverSettings, optional) — Retrieves approvable details from Coupa. Set exactly one retriever type.
- `fieldglass_approvable_data_retriever` (FieldglassApprovableDataRetrieverSettings, optional) — Retrieves approvable details from SAP Fieldglass. Set exactly one retriever type.
- `snow_json_data_retriever` (SnowJsonDataRetrieverSettings, optional) — Retrieves records from a ServiceNow table using the JSON API. Set exactly one retriever type.
- `snow_table_data_retriever` (SnowTableDataRetrieverSettings, optional) — Retrieves records from a ServiceNow table using the Table API. Set exactly one retriever type.
- `workday_absence_management_data_retriever` (WorkdayAbsenceManagementRetrieverSettings, optional) — Retrieves absence management details from Workday. Set exactly one retriever type.
- `workday_report_single_item_retriever` (WorkdayReportSingleItemRetrieverSettings, optional) — Retrieves the first entry of a Workday report for the approval record. Set exactly one retriever type.
- `workday_formatted_time_off_entries_retriever` (WorkdayFormattedTimeOffEntriesRetrieverSettings, optional) — Formats raw Workday time-off entries, already retrieved by another retriever, into readable date ranges. Set exactly one retriever type.
- `item_ref` (string, optional) — Server-assigned row identifier. Leave unset on create; send back the value from your last read on update so the row keeps its identity.

### Version

- `num` (integer, optional) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.
- `change_description` (string, optional) — A short note describing this change. Required on every create and update.

### ButtonDisplayInfoSettings

- `title` (string, optional) — Button title to display. If not set, a default title based on the button type is used.
- `style` (string, optional) — Button style: PRIMARY highlights the button on the approval card; DANGER shows it in red.

### TemplateLinkSettings

- `url_template` (string, optional) — URL template for the link. Fields of the approval record (dot or bracket notation) and the service portal URL can be used as placeholders.

### TicketLinkSettings

### TicketApprovalDataRetrieverSettings

- `cached_tickets_enabled` (boolean, optional) — If true, ticket data is read from the Moveworks cache, which is faster but may be slightly stale. Falls back to the API if the ticket is not cached yet.

### AribaApprovableDataRetrieverSettings

### ConcurApprovableDataRetrieverSettings

### CoupaApprovableDataRetrieverSettings

### FieldglassApprovableDataRetrieverSettings

### SnowJsonDataRetrieverSettings

- `data_key` (string, optional) — Key under which the retrieved data is made available to augmenter_bender.
- `retrieval_config` (SubsourceSettings, optional) — The ServiceNow table, query, and fields to retrieve.
- `prerequisites` (list of string, optional) — Approval record fields that must all have a value for this retriever to run.

### SnowTableDataRetrieverSettings

- `data_key` (string, optional) — Key under which the retrieved data is made available to augmenter_bender.
- `retrieval_config` (SubsourceSettings, optional) — The ServiceNow table, query, and fields to retrieve.
- `prerequisites` (list of string, optional) — Approval record fields that must all have a value for this retriever to run.

### WorkdayAbsenceManagementRetrieverSettings

### WorkdayReportSingleItemRetrieverSettings

- `data_key` (string, optional) — Key under which the retrieved data is made available to augmenter_bender.
- `report_path` (string, optional) — Path of the Workday report to call.
- `meta_field` (string, optional) — Approval record metadata key whose value is passed to the report as the Workday ID. If empty, the approval record's parent ID is used.

### WorkdayFormattedTimeOffEntriesRetrieverSettings

- `data_key` (string, optional) — Key under which the retrieved data is made available to augmenter_bender.
- `input_path` (string, optional) — Path, within previously retrieved data, to the raw time-off entries to format.
- `input_date_format` (string, optional) — Date format of the raw time-off entries, as a strftime-style pattern (e.g. %Y-%m-%d).

### SubsourceSettings

- `source_key` (string, optional) — Name of the source table to query.
- `filter_expression` (string, optional) — Query used to select records, which can reference approval record fields as placeholders, e.g. \{record.parent\_id}.
- `attributes` (list of string, optional) — Fields to return for each retrieved record.

## Examples

**Response**

```json
[
  {
    "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
    "connector_id": "<connector-uuid>",
    "resource_type": "REQUEST_ITEM",
    "buttons": [
      {
        "type": "approve",
        "display_info": {
          "title": "APPROVALS_APPROVE",
          "style": "PRIMARY"
        },
        "item_ref": "<string>"
      }
    ],
    "link_strategy": {
      "template": {
        "url_template": "https://example.com/path"
      }
    },
    "mapper_bender": {},
    "augmenter_bender": {},
    "augmenting_data_retrievers": [
      {
        "ticket_approval_data_retriever": {
          "cached_tickets_enabled": true
        },
        "item_ref": "<string>"
      }
    ],
    "record_prefilter_dsl": "true",
    "database_filter_dsl": "true",
    "updated_time": "2026-11-12T18:04:11Z",
    "updated_by": "admin@example.com",
    "version": {
      "num": 2,
      "change_description": "Initial setup"
    }
  }
]
```

**SDK Code**

```python Approval Resources endpoints_listApprovalResources_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/approval/resources"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript Approval Resources endpoints_listApprovalResources_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/approval/resources';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Approval Resources endpoints_listApprovalResources_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/approval/resources"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Approval Resources endpoints_listApprovalResources_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/approval/resources")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Approval Resources endpoints_listApprovalResources_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.moveworks.ai/configurations/v1alpha1/tool/approval/resources")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Approval Resources endpoints_listApprovalResources_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.moveworks.ai/configurations/v1alpha1/tool/approval/resources', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Approval Resources endpoints_listApprovalResources_example
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/tool/approval/resources");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Approval Resources endpoints_listApprovalResources_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/tool/approval/resources")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```