Create a custom run with explicit period boundaries (CARF: any whole-day Europe/London range up to 366 days; treasury-statement / transfer-attribution: utc day/month/year). Full agreement may omit the period to compute the month so far
curl --request POST \
--url https://api.range.org/v2/workflows/runs/custom \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"period_start": "2024-01-01T00:00:00Z",
"period_end": "2025-01-01T00:00:00Z"
}
'import requests
url = "https://api.range.org/v2/workflows/runs/custom"
payload = {
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"period_start": "2024-01-01T00:00:00Z",
"period_end": "2025-01-01T00:00:00Z"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
period_start: '2024-01-01T00:00:00Z',
period_end: '2025-01-01T00:00:00Z'
})
};
fetch('https://api.range.org/v2/workflows/runs/custom', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.range.org/v2/workflows/runs/custom",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'period_start' => '2024-01-01T00:00:00Z',
'period_end' => '2025-01-01T00:00:00Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.range.org/v2/workflows/runs/custom"
payload := strings.NewReader("{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"period_start\": \"2024-01-01T00:00:00Z\",\n \"period_end\": \"2025-01-01T00:00:00Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.range.org/v2/workflows/runs/custom")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"period_start\": \"2024-01-01T00:00:00Z\",\n \"period_end\": \"2025-01-01T00:00:00Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.range.org/v2/workflows/runs/custom")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"period_start\": \"2024-01-01T00:00:00Z\",\n \"period_end\": \"2025-01-01T00:00:00Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"occurrence_at": "2023-11-07T05:31:56Z",
"rerun_of": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requested_cutoff": "2023-11-07T05:31:56Z",
"execution_status": "queued",
"tx_sync_status": "not_applicable",
"delivery_status": "not_required",
"review_status": "not_required",
"carf_missing_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"cases": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "execution"
}
],
"period": {
"start": "<string>",
"end": "<string>",
"label": "<string>"
},
"warnings": [
"<string>"
],
"reason": "<string>",
"queued_at": "2023-11-07T05:31:56Z",
"started_at": null
}Workflows
Request a custom workflow run
Request a workflow run with explicit period bounds, or omit both for a full-agreement run for the month so far.
POST
/
v2
/
workflows
/
runs
/
custom
Create a custom run with explicit period boundaries (CARF: any whole-day Europe/London range up to 366 days; treasury-statement / transfer-attribution: utc day/month/year). Full agreement may omit the period to compute the month so far
curl --request POST \
--url https://api.range.org/v2/workflows/runs/custom \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"period_start": "2024-01-01T00:00:00Z",
"period_end": "2025-01-01T00:00:00Z"
}
'import requests
url = "https://api.range.org/v2/workflows/runs/custom"
payload = {
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"period_start": "2024-01-01T00:00:00Z",
"period_end": "2025-01-01T00:00:00Z"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workflow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
period_start: '2024-01-01T00:00:00Z',
period_end: '2025-01-01T00:00:00Z'
})
};
fetch('https://api.range.org/v2/workflows/runs/custom', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.range.org/v2/workflows/runs/custom",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'workflow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'period_start' => '2024-01-01T00:00:00Z',
'period_end' => '2025-01-01T00:00:00Z'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.range.org/v2/workflows/runs/custom"
payload := strings.NewReader("{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"period_start\": \"2024-01-01T00:00:00Z\",\n \"period_end\": \"2025-01-01T00:00:00Z\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.range.org/v2/workflows/runs/custom")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"period_start\": \"2024-01-01T00:00:00Z\",\n \"period_end\": \"2025-01-01T00:00:00Z\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.range.org/v2/workflows/runs/custom")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"period_start\": \"2024-01-01T00:00:00Z\",\n \"period_end\": \"2025-01-01T00:00:00Z\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"occurrence_at": "2023-11-07T05:31:56Z",
"rerun_of": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"requested_cutoff": "2023-11-07T05:31:56Z",
"execution_status": "queued",
"tx_sync_status": "not_applicable",
"delivery_status": "not_required",
"review_status": "not_required",
"carf_missing_count": 123,
"created_at": "2023-11-07T05:31:56Z",
"cases": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "execution"
}
],
"period": {
"start": "<string>",
"end": "<string>",
"label": "<string>"
},
"warnings": [
"<string>"
],
"reason": "<string>",
"queued_at": "2023-11-07T05:31:56Z",
"started_at": null
}Authorizations
AuthorizationAuthorization
Authorization method required to allow user to access the api endpoints.
Body
application/json
Inclusive start with an explicit timezone. Required except for a full-agreement run-now, which omits both bounds and computes the month so far. Template-specific: CARF requires January 1 UTC midnight (year ≥ 1970); treasury-statement requires any UTC midnight day boundary within a ≤366-day half-open interval; transfer-attribution requires one within a ≤31-day half-open interval (a day, a week or a month); full-agreement requires 00:00 UTC on the first of a month, or the current month to mean month-so-far.
Example:
"2024-01-01T00:00:00Z"
Exclusive end with an explicit timezone. Required except for a full-agreement run-now. Template-specific: CARF requires the following January 1 UTC midnight; treasury-statement and transfer-attribution require a later UTC midnight within the supported span; full-agreement requires 00:00 UTC on the first of the next month.
Example:
"2025-01-01T00:00:00Z"
Response
202 - application/json
Inclusive observation bound; period.end is the exclusive end of the stored half-open period.
Available options:
queued, running, succeeded, failed, cancelled, skipped Available options:
not_applicable, waiting, completed, expired Available options:
not_required, pending, sending, sent, failed, cancelled, held CARF review: needs_labels and awaiting_review are held (delivery held); sent once released.
Available options:
not_required, needs_labels, awaiting_review, sent CARF: reported transfers with no type. Null outside CARF review.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
null
Last modified on November 10, 2026
Was this page helpful?