API reference/Endpoints
Data Flows (GDPR Art. 30/35)
GET /data-flows
Lists the tenant's data flows.
Query params: entityId
Response:
{
"data": [
{
"id": "df_abc123",
"name": "CRM → Mailchimp",
"sourceSystem": "CRM",
"targetSystem": "Mailchimp (EUA)",
"dataCategories": ["email", "nome"],
"legalBasis": "LEGITIMATE_INTERESTS",
"riskLevel": "MEDIUM",
"internationalTransfer": true,
"retentionPeriod": "24 meses",
"processingActivity": { "id": "pa_xyz", "name": "Marketing directo" }
}
],
"meta": { "tenantId": "org_abc", "timestamp": "2026-07-02T10:00:00Z" }
}
legalBasis accepts: CONSENT | CONTRACT | LEGAL_OBLIGATION | VITAL_INTERESTS | PUBLIC_TASK | LEGITIMATE_INTERESTS.
POST /data-flows
Create a data flow. Validates entityId and processingActivityId against the tenant, if provided.
Body:
{
"name": "ERP → Contabilidade externa",
"sourceSystem": "ERP",
"targetSystem": "Contabilista externo",
"dataCategories": ["NIF", "salário"],
"legalBasis": "LEGAL_OBLIGATION",
"riskLevel": "HIGH",
"internationalTransfer": false,
"retentionPeriod": "10 anos",
"processingActivityId": "pa_xyz"
}
GET /data-flows/:id
Details of a flow.
PUT /data-flows/:id
Update a flow (not PATCH).
DELETE /data-flows/:id
Delete a flow.
There is no
GET /data-flows/export(CSV) in the public API in this version. There is a portability export of the whole tenant (see the Full Tenant Export section below), but it is not specific to Data Flows.
Coming soonThis page will be available soon.