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

# Getting Started

> Base URL, your first authenticated call, pagination, and error handling for the FlowForma Governance API.

The FlowForma Governance API lets you manage app environments, environment requests, process promotion requests, security templates, settings, and API connection credentials across your tenant.

## Base URL

```text theme={null}
https://api.flowforma.com
```

All endpoints are versioned under `/v1`.

## Your first call

After obtaining a bearer token (see [Authentication](/developers/flowforma-governance-api/authentication)), list your environments:

```bash theme={null}
curl "https://api.flowforma.com/v1/environments" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

A successful response is a JSON array of environments:

```json theme={null}
[
  {
    "EnvironmentID": "b1c2d3e4-5717-4562-b3fc-2c963f66afa6",
    "Title": "Finance Production",
    "URL": "https://contoso.sharepoint.com/sites/finance",
    "EnvironmentType": "Production",
    "EnvironmentStatus": "Ready",
    "Created": "2026-01-15T09:30:00Z"
  }
]
```

The environment IDs returned here are what you pass to the process and environment-request endpoints.

## Pagination

List endpoints return 10 records per page. Pass a 1-based `pageNumber` query parameter to move through the pages:

```bash theme={null}
curl "https://api.flowforma.com/v1/environments?pageNumber=2" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"
```

Each list response includes paging metadata in the response headers:

| Header                      | Meaning                        |
| --------------------------- | ------------------------------ |
| `X-Paging-TotalRecordCount` | Total records across all pages |
| `X-Paging-PageCount`        | Total number of pages          |
| `X-Paging-PageNo`           | The page number returned       |
| `X-Paging-PageSize`         | Records per page (always 10)   |

## Errors

Errors are returned with the relevant HTTP status code and a JSON body:

```json theme={null}
{
  "code": "400",
  "message": "Page does not exist."
}
```

| Status | Meaning                                           |
| ------ | ------------------------------------------------- |
| `400`  | The request was invalid or could not be processed |
| `401`  | Authentication failed or the token was missing    |
| `404`  | The requested resource does not exist             |

## Next steps

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/developers/flowforma-governance-api/authentication">
    Get a bearer token or use an integration access token.
  </Card>

  <Card title="API reference" icon="code" href="/developers/flowforma-governance-api/overview">
    Browse every endpoint, with request and response schemas.
  </Card>
</CardGroup>