> For the complete documentation index, see [llms.txt](https://docs.adaptria.locaria.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.adaptria.locaria.com/internal-api/reference/workflows.md).

# 🔄 Workflows

### Workflows

Browse workflow templates and workflow details available to the authenticated API user.

## 🔄 List Workflows

> Internal users only. Client users → 403.

```json
{"openapi":"3.1.0","info":{"title":"Adaptria Public API: Connector","version":"1.0.0"},"tags":[{"name":"🔄 Workflows","description":"## Workflows\n\nBrowse workflow templates and workflow details available to the authenticated API user.\n"}],"servers":[{"url":"https://api.adaptria.locaria.com","description":"Production Environment"}],"security":[{"apiKeyAuth":[]}],"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Api-key","description":"## API Key Authentication\n\nStatic API key obtained from the Adaptria Portal or via `POST /api/credentials/api-keys`.\n\n**How to authenticate**:\n1. Generate an API key from the Adaptria Portal (Settings → API Keys) or ask your admin\n2. Include the key in all requests using the `Api-key` header\n\n**Key format**: `lla_live_<32-character-string>`\n\n**No token exchange needed** — the key is used directly in every request. Revoke or rotate keys from the portal."}},"schemas":{"ListWorkflowsResponse":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"array","items":{"type":"object","additionalProperties":{}}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"limit":{"type":"number"},"total":{"type":"number"},"totalPages":{"type":"number"},"hasNextPage":{"type":"boolean"},"hasPrevPage":{"type":"boolean"}},"required":["page","limit","total","totalPages","hasNextPage","hasPrevPage"]}},"required":["success","data","pagination"]}}},"paths":{"/api/public/v1/workflows":{"get":{"summary":"🔄 List Workflows","description":"Internal users only. Client users → 403.","tags":["🔄 Workflows"],"parameters":[{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"page","in":"query"},{"schema":{"type":"string","pattern":"^\\d+$"},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"search","in":"query"},{"schema":{"type":"string"},"required":false,"name":"sortBy","in":"query"},{"schema":{"type":"string","enum":["asc","desc"]},"required":false,"name":"sortOrder","in":"query"}],"responses":{"200":{"description":"Workflows","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkflowsResponse"}}}},"403":{"description":"Forbidden"}}}}}}
```

## GET /api/public/v1/workflows/{id}

> 🔍 Get Workflow Details

```json
{"openapi":"3.1.0","info":{"title":"Adaptria Public API: Connector","version":"1.0.0"},"tags":[{"name":"🔄 Workflows","description":"## Workflows\n\nBrowse workflow templates and workflow details available to the authenticated API user.\n"}],"servers":[{"url":"https://api.adaptria.locaria.com","description":"Production Environment"}],"security":[{"apiKeyAuth":[]}],"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Api-key","description":"## API Key Authentication\n\nStatic API key obtained from the Adaptria Portal or via `POST /api/credentials/api-keys`.\n\n**How to authenticate**:\n1. Generate an API key from the Adaptria Portal (Settings → API Keys) or ask your admin\n2. Include the key in all requests using the `Api-key` header\n\n**Key format**: `lla_live_<32-character-string>`\n\n**No token exchange needed** — the key is used directly in every request. Revoke or rotate keys from the portal."}},"schemas":{"WorkflowDetailsResponse":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","additionalProperties":{}}},"required":["success","data"]}}},"paths":{"/api/public/v1/workflows/{id}":{"get":{"summary":"🔍 Get Workflow Details","tags":["🔄 Workflows"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Workflow details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDetailsResponse"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not found"}}}}}}
```

## GET /api/public/v1/workflows/available-jobs

> 🔄 Get Available Jobs for Workflow Builder

```json
{"openapi":"3.1.0","info":{"title":"Adaptria Public API: Connector","version":"1.0.0"},"tags":[{"name":"🔄 Workflows","description":"## Workflows\n\nBrowse workflow templates and workflow details available to the authenticated API user.\n"}],"servers":[{"url":"https://api.adaptria.locaria.com","description":"Production Environment"}],"security":[{"apiKeyAuth":[]}],"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Api-key","description":"## API Key Authentication\n\nStatic API key obtained from the Adaptria Portal or via `POST /api/credentials/api-keys`.\n\n**How to authenticate**:\n1. Generate an API key from the Adaptria Portal (Settings → API Keys) or ask your admin\n2. Include the key in all requests using the `Api-key` header\n\n**Key format**: `lla_live_<32-character-string>`\n\n**No token exchange needed** — the key is used directly in every request. Revoke or rotate keys from the portal."}},"schemas":{"WorkflowDetailsResponse":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","additionalProperties":{}}},"required":["success","data"]}}},"paths":{"/api/public/v1/workflows/available-jobs":{"get":{"summary":"🔄 Get Available Jobs for Workflow Builder","tags":["🔄 Workflows"],"responses":{"200":{"description":"Available jobs","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDetailsResponse"}}}},"403":{"description":"Forbidden"}}}}}}
```

## GET /api/public/v1/workflows/available-jobs-by-service

> 🔄 Get Available Jobs Organized by ClientService

```json
{"openapi":"3.1.0","info":{"title":"Adaptria Public API: Connector","version":"1.0.0"},"tags":[{"name":"🔄 Workflows","description":"## Workflows\n\nBrowse workflow templates and workflow details available to the authenticated API user.\n"}],"servers":[{"url":"https://api.adaptria.locaria.com","description":"Production Environment"}],"security":[{"apiKeyAuth":[]}],"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Api-key","description":"## API Key Authentication\n\nStatic API key obtained from the Adaptria Portal or via `POST /api/credentials/api-keys`.\n\n**How to authenticate**:\n1. Generate an API key from the Adaptria Portal (Settings → API Keys) or ask your admin\n2. Include the key in all requests using the `Api-key` header\n\n**Key format**: `lla_live_<32-character-string>`\n\n**No token exchange needed** — the key is used directly in every request. Revoke or rotate keys from the portal."}},"schemas":{"WorkflowDetailsResponse":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","additionalProperties":{}}},"required":["success","data"]}}},"paths":{"/api/public/v1/workflows/available-jobs-by-service":{"get":{"summary":"🔄 Get Available Jobs Organized by ClientService","tags":["🔄 Workflows"],"responses":{"200":{"description":"Available jobs by service","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDetailsResponse"}}}},"403":{"description":"Forbidden"}}}}}}
```

## GET /api/public/v1/workflows/available-services

> 🔄 Get Available Services for Workflow Creation

```json
{"openapi":"3.1.0","info":{"title":"Adaptria Public API: Connector","version":"1.0.0"},"tags":[{"name":"🔄 Workflows","description":"## Workflows\n\nBrowse workflow templates and workflow details available to the authenticated API user.\n"}],"servers":[{"url":"https://api.adaptria.locaria.com","description":"Production Environment"}],"security":[{"apiKeyAuth":[]}],"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Api-key","description":"## API Key Authentication\n\nStatic API key obtained from the Adaptria Portal or via `POST /api/credentials/api-keys`.\n\n**How to authenticate**:\n1. Generate an API key from the Adaptria Portal (Settings → API Keys) or ask your admin\n2. Include the key in all requests using the `Api-key` header\n\n**Key format**: `lla_live_<32-character-string>`\n\n**No token exchange needed** — the key is used directly in every request. Revoke or rotate keys from the portal."}},"schemas":{"WorkflowDetailsResponse":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","additionalProperties":{}}},"required":["success","data"]}}},"paths":{"/api/public/v1/workflows/available-services":{"get":{"summary":"🔄 Get Available Services for Workflow Creation","tags":["🔄 Workflows"],"responses":{"200":{"description":"Available services","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDetailsResponse"}}}},"403":{"description":"Forbidden"}}}}}}
```

## GET /api/public/v1/workflows/filters

> 🔄 Get Workflow Filters

```json
{"openapi":"3.1.0","info":{"title":"Adaptria Public API: Connector","version":"1.0.0"},"tags":[{"name":"🔄 Workflows","description":"## Workflows\n\nBrowse workflow templates and workflow details available to the authenticated API user.\n"}],"servers":[{"url":"https://api.adaptria.locaria.com","description":"Production Environment"}],"security":[{"apiKeyAuth":[]}],"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Api-key","description":"## API Key Authentication\n\nStatic API key obtained from the Adaptria Portal or via `POST /api/credentials/api-keys`.\n\n**How to authenticate**:\n1. Generate an API key from the Adaptria Portal (Settings → API Keys) or ask your admin\n2. Include the key in all requests using the `Api-key` header\n\n**Key format**: `lla_live_<32-character-string>`\n\n**No token exchange needed** — the key is used directly in every request. Revoke or rotate keys from the portal."}},"schemas":{"WorkflowDetailsResponse":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","additionalProperties":{}}},"required":["success","data"]}}},"paths":{"/api/public/v1/workflows/filters":{"get":{"summary":"🔄 Get Workflow Filters","tags":["🔄 Workflows"],"responses":{"200":{"description":"Filters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDetailsResponse"}}}},"403":{"description":"Forbidden"}}}}}}
```

## GET /api/public/v1/workflows/services-by-client-service

> 🔄 Get Services from Workflow Templates

```json
{"openapi":"3.1.0","info":{"title":"Adaptria Public API: Connector","version":"1.0.0"},"tags":[{"name":"🔄 Workflows","description":"## Workflows\n\nBrowse workflow templates and workflow details available to the authenticated API user.\n"}],"servers":[{"url":"https://api.adaptria.locaria.com","description":"Production Environment"}],"security":[{"apiKeyAuth":[]}],"components":{"securitySchemes":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"Api-key","description":"## API Key Authentication\n\nStatic API key obtained from the Adaptria Portal or via `POST /api/credentials/api-keys`.\n\n**How to authenticate**:\n1. Generate an API key from the Adaptria Portal (Settings → API Keys) or ask your admin\n2. Include the key in all requests using the `Api-key` header\n\n**Key format**: `lla_live_<32-character-string>`\n\n**No token exchange needed** — the key is used directly in every request. Revoke or rotate keys from the portal."}},"schemas":{"WorkflowDetailsResponse":{"type":"object","properties":{"success":{"type":"boolean","enum":[true]},"data":{"type":"object","additionalProperties":{}}},"required":["success","data"]}}},"paths":{"/api/public/v1/workflows/services-by-client-service":{"get":{"summary":"🔄 Get Services from Workflow Templates","tags":["🔄 Workflows"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Filter by specific clientService ID"},"required":true,"description":"Filter by specific clientService ID","name":"clientServiceId","in":"query"}],"responses":{"200":{"description":"Services","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowDetailsResponse"}}}},"403":{"description":"Forbidden"}}}}}}
```
