Getting Started

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

https://api.flowforma.com

All endpoints are versioned under /v1.

Your first call

After obtaining a bearer token (see Authentication), list your environments:

curl "https://api.flowforma.com/v1/environments" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

A successful response is a JSON array of environments:

[
  {
    "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:

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:

{
  "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

Base URL

Your first call

Errors

Next steps

Authentication

API reference

​Base URL

​Your first call

​Pagination

​Errors

​Next steps

Authentication

API reference

Base URL

Your first call

Pagination

Errors

Next steps