Re-flow API Documentation

Welcome to the Re-flow API Documentation. Please note that these pages are often updated with new examples and information detailing what you can do with the Re-flow API.

Many of the relational fields in Re-flow require Re-flow Ids so this should be considered in your integration design. For example, when creating a job with an associated Site you will need to pass the Re-flow site Id within your POST request. With this in mind, you may need to GET call our Sites endpoint to locate the correct Id before making your POST request.

The Parameters (GET) section details how you can query endpoints, passing search criteria to help you identify both the records you need and the fields you are interested in getting back from Re-flow.

Many of the Records, Events and Jobs in Re-flow have a default ‘Title’ field which is often, but not always, unique. Re-flow recommend that you use the ‘UUID’ field and populate it with a unique reference from the system you are integrating with Re-flow. This can be done with both POST and PUT methods and will provide you with a unique, familiar reference you can use within your GET requests for retrieving Re-flow Ids. It is important to be aware that ‘Title’ fields could be modified by users within the UI so are not always guaranteed to return the result you are looking for. ‘UUID’ can only be set via the API.