> ## Documentation Index
> Fetch the complete documentation index at: https://help.hoopai.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Workflows Overview

> Manage and retrieve automation workflows in the HoopAI Platform REST API. List active workflows and enroll contacts programmatically.

The Workflows API gives you programmatic access to the automation workflows configured in your HoopAI Platform account. Use it to retrieve workflow metadata such as name, status, and version, and to integrate workflow triggers into your own applications or third-party tools.

## Base URL

```
https://services.leadconnectorhq.com
```

## Authentication

Every request must include a bearer token in the `Authorization` header and the API version in the `Version` header.

```http theme={null}
Authorization: Bearer <access_token>
Version: 2021-07-28
```

Use an access token generated for a **Account** user type, or a Private Integration Token scoped to the account.

## OAuth scopes

| Scope                | Access                                |
| -------------------- | ------------------------------------- |
| `workflows.readonly` | Read workflow metadata for a location |

## Quick start

Retrieve all workflows for a location:

```bash theme={null}
curl -X GET "https://services.leadconnectorhq.com/workflows/?locationId=ve9EPM428h8vShlRW1KT" \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28"
```

## Endpoints

| Method | Path          | Description  |
| ------ | ------------- | ------------ |
| `GET`  | `/workflows/` | Get Workflow |

## Related

* [OAuth 2.0 overview](/api-reference/oauth/overview) — obtain and refresh access tokens
* [Contacts API overview](/api-reference/contacts/overview) — manage contacts that can be enrolled in workflows
* [Automations in HoopAI](/automation/overview) — platform-level guide to building automation workflows