Request URL in the Flow API

Request URL in the Flow API

The request URL is a string representing the URL of the request. The URL syntax for the Customer API looks like:

https://[hostname][api version][customer/core][object][parameter(s)]

Where:

  • Hostname is the URL for the Flow application. This looks like <workspace>.appfireflow.com where <workspace>is unique for each customer workspace. Find this workspace identifier in the URL you use to access Flow.

  • API version refers to the version of the API being accessed. For all Customer API endpoints, this should be v3.

  • /customer/core is always the same.

  • Object is the resource in the Flow API from which you want to extract data. Examples are users, commits, and targets. See our API references for the complete list.

  • Parameter(s) are the filters you use to extract a specific result, such as an Id, or a query parameter to restrict the result to a specific set of data. Parameter passing follows the widely used ?key=value&pattern.

API endpoints for the Flow metrics APIs follow slightly different syntax patterns. Refer to the API references for each endpoint for more details.

Need support? Create a request with our support team.

Copyright © 2005 - 2026 Appfire | All rights reserved.