Skip to main content
List all flows available to your organization.

Endpoint

GET https://app.doclo.ai/api/v1/flows

Authentication

Requires an API key with flows:read scope.
Authorization: Bearer dc_live_your_api_key

Request

No request body required.

Query Parameters

ParameterTypeDescription
limitnumberMaximum flows to return (default: 50, max: 100)
offsetnumberNumber of flows to skip for pagination

Response

Success (200 OK)

{
  "flows": [
    {
      "id": "invoice-extractor",
      "name": "Invoice Extractor",
      "description": "Extract structured data from invoices",
      "version": "1.2.0",
      "createdAt": "2024-01-15T10:30:00Z",
      "updatedAt": "2024-02-20T14:45:00Z"
    },
    {
      "id": "receipt-scanner",
      "name": "Receipt Scanner",
      "description": "Parse receipts and extract line items",
      "version": "1.0.0",
      "createdAt": "2024-02-01T09:00:00Z",
      "updatedAt": "2024-02-01T09:00:00Z"
    }
  ],
  "total": 2,
  "limit": 50,
  "offset": 0
}

Response Fields

FieldTypeDescription
flowsarrayList of flow objects
flows[].idstringUnique flow identifier (used in other endpoints)
flows[].namestringHuman-readable flow name
flows[].descriptionstringFlow description
flows[].versionstringCurrent version (semver)
flows[].createdAtstringISO 8601 creation timestamp
flows[].updatedAtstringISO 8601 last update timestamp
totalnumberTotal number of flows
limitnumberLimit used in this request
offsetnumberOffset used in this request

Examples

cURL

curl https://app.doclo.ai/api/v1/flows \
  -H "Authorization: Bearer dc_live_your_api_key"

TypeScript

const response = await fetch('https://app.doclo.ai/api/v1/flows', {
  headers: {
    'Authorization': `Bearer ${process.env.DOCLO_API_KEY}`
  }
});

const { flows } = await response.json();

for (const flow of flows) {
  console.log(`${flow.name} (${flow.id}) - v${flow.version}`);
}

With Pagination

# Get flows 11-20
curl "https://app.doclo.ai/api/v1/flows?limit=10&offset=10" \
  -H "Authorization: Bearer dc_live_your_api_key"

Errors

StatusCodeDescription
401UNAUTHORIZEDMissing or invalid API key
403FORBIDDENAPI key missing flows:read scope
429RATE_LIMITEDRate limit exceeded

Next Steps