Developer quickstart

const BASE = "https://my.flowsign.app";
const headers = {
  Authorization: `Bearer ${process.env.FLOWSIGN_API_KEY}`,
  "Content-Type": "application/json",
};

async function call(method, path, body) {
  const res = await fetch(`${BASE}${path}`, {
    method,
    headers,
    body: body ? JSON.stringify(body) : undefined,
  });
  const json = await res.json();
  if (!res.ok) throw new Error(`${res.status} ${json.error}`);
  return json.data;
}

const { templates } = await call("GET", "/api/v1/templates?status=ACTIVE");
const template = templates.find((t) => t.name === "Employment agreement");

const { packageId } = await call("POST", `/api/v1/templates/${template.id}`, {
  recipients: [
    { name: "Ana Reid", email: "[email protected]", roleIndex: 0 },
    { name: "Ben Toa", email: "[email protected]", roleIndex: 1 },
  ],
  mergeFieldValues: { start_date: "1 October 2026" },
});

const sent = await call("PATCH", `/api/v1/packages/${packageId}`, { action: "send" });
console.log(sent.status);

import os

import requests

BASE = "https://my.flowsign.app"

session = requests.Session()
session.headers.update({"Authorization": f"Bearer {os.environ['FLOWSIGN_API_KEY']}"})


def call(method, path, body=None):
    res = session.request(method, f"{BASE}{path}", json=body, timeout=30)
    if not res.ok:
        raise RuntimeError(f"{res.status_code} {res.json()['error']}")
    return res.json()["data"]


templates = call("GET", "/api/v1/templates?status=ACTIVE")["templates"]
template = next(t for t in templates if t["name"] == "Employment agreement")

created = call(
    "POST",
    f"/api/v1/templates/{template['id']}",
    {
        "recipients": [
            {"name": "Ana Reid", "email": "[email protected]", "roleIndex": 0},
            {"name": "Ben Toa", "email": "[email protected]", "roleIndex": 1},
        ],
        "mergeFieldValues": {"start_date": "1 October 2026"},
    },
)

sent = call("PATCH", f"/api/v1/packages/{created['packageId']}", {"action": "send"})
print(sent["status"])

using System.Net.Http.Headers;
using System.Net.Http.Json;
using System.Text.Json;

using var http = new HttpClient { BaseAddress = new Uri("https://my.flowsign.app") };
http.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue(
    "Bearer",
    Environment.GetEnvironmentVariable("FLOWSIGN_API_KEY"));

async Task<JsonElement> CallAsync(HttpMethod method, string path, object? body = null)
{
    using var request = new HttpRequestMessage(method, path);
    if (body is not null) request.Content = JsonContent.Create(body);

    using var response = await http.SendAsync(request);
    var json = await response.Content.ReadFromJsonAsync<JsonElement>();

    if (!response.IsSuccessStatusCode)
    {
        throw new HttpRequestException(
            $"{(int)response.StatusCode} {json.GetProperty("error").GetString()}");
    }

    return json.GetProperty("data");
}

var list = await CallAsync(HttpMethod.Get, "/api/v1/templates?status=ACTIVE");
var template = list.GetProperty("templates").EnumerateArray()
    .First(t => t.GetProperty("name").GetString() == "Employment agreement");

var created = await CallAsync(
    HttpMethod.Post,
    $"/api/v1/templates/{template.GetProperty("id").GetString()}",
    new
    {
        recipients = new[]
        {
            new { name = "Ana Reid", email = "[email protected]", roleIndex = 0 },
            new { name = "Ben Toa", email = "[email protected]", roleIndex = 1 },
        },
        mergeFieldValues = new Dictionary<string, string> { ["start_date"] = "1 October 2026" },
    });

var sent = await CallAsync(
    HttpMethod.Patch,
    $"/api/v1/packages/{created.GetProperty("packageId").GetString()}",
    new { action = "send" });

Console.WriteLine(sent.GetProperty("status").GetString());