Flow — API endpoints

Boomi Flow has an in-built client that lets us create API requests. We can access the endpoints from the API tab in the Boomi Flow drawing tool.

The address field offers pre-populated suggestions when we click on it.

All we have to do is select the appropriate endpoint and the method.

You can find the Flow API reference documentation here.

Here is our Swagger definition if you need it: https://flow.manywho.com/swagger/v1/swagger.json


Indicative list of API endpoints

  1. api/admin/1/directory/{directoryId}/user/password?username=
  2. api/admin/1/directory/{directoryId}/user/credentials/{resetToken}?password=
  3. api/admin/1/states
  4. api/admin/1/states/{id}
  5. api/admin/1/states/flow/{id}
  6. api/admin/1/states/flow/{id}/{version}
  7. api/admin/1/tenant
  8. api/admin/1/users
  9. api/admin/1/users/{id}
  10. api/admin/1/users/me
  11. api/run/1/authentication
  12. api/run/1/authentication/{tenantId}
  13. api/run/1/flow/name/{flowName}
  14. api/run/1/flow/{flowid}
  15. api/run/1/flow
  16. api/run/1/response
  17. api/run/1/state/{statedID}
  18. api/run/1/state/package/{stateId}
  19. api/run/1/state/package
  20. api/run/1
  21. api/draw/1/flow/snap/{flowid}
  22. api/draw/1/flow/snap/{flowid}/{flowVersionId}
  23. api/draw/1/flow/snap/{flowid}?filter=
  24. api/draw/1/flow/{flowid}
  25. api/draw/1/flow/activation/{flowid}/{flowVersionId}/{isDefault}/{isActivated}
  26. api/draw/1/flow?filter=
  27. api/draw/1/flow/{flowid}
  28. api/draw/1/element/flow/{flowid}/service/{serviceId}
  29. api/draw/1/element/service/{serviceId}
  30. api/draw/1/element/service?filter=
  31. api/draw/1/element/service
  32. api/draw/1/element/flow/{flowid}/type/{typeId}
  33. api/draw/1/element/type/{typeId}
  34. api/draw/1/element/type?filter=
  35. api/draw/1/element/type
  36. api/draw/1/element/flow/{flowid}/macro/{macroId}
  37. api/draw/1/element/macro/{macroId}
  38. api/draw/1/element/macro?filter=
  39. api/draw/1/element/macro
  40. api/draw/1/element/flow/{flowid}/value/{valueId}
  41. api/draw/1/element/value?filter=
  42. api/draw/1/element/value/{valueId}
  43. api/draw/1/element/value
  44. api/draw/1/element/flow/{flowid}/tag/{tagId}
  45. api/draw/1/element/tag/{tagId}
  46. api/draw/1/element/tag?filter=
  47. api/draw/1/element/tag
  48. api/draw/1/element/flow/{flowid}/page/{pageId}
  49. api/draw/1/element/page/{pageId}
  50. api/draw/1/element/page?filter=
  51. api/draw/1/element/page
  52. api/draw/1/flow
  53. api/draw/1/flow/{flowid}/{editingtoken}/element/navigation/{navigationElementId}
  54. api/draw/1/flow/{flowid}/{editingtoken}/element/navigation?filter=
  55. api/draw/1/flow/{flowid}/{editingtoken}/element/navigation
  56. api/draw/1/flow/{flowid}/{editingtoken}/element/map/{mapElementId}
  57. api/draw/1/flow/{flowid}/{editingtoken}/element/map?filter=
  58. api/draw/1/flow/{flowid}/{editingtoken}/element/map
  59. api/draw/1/flow/{flowid}/{editingtoken}/element/group/{groupElementId}
  60. api/draw/1/flow/{flowid}/{editingtoken}/element/group?filter=
  61. api/draw/1/flow/{flowid}/{editingtoken}/element/group
  62. api/draw/1/flow/revert/{flowid}/{flowVersionId}
  63. api/translate/1/culture/{cultureId}
  64. api/translate/1/culture?filter=
  65. api/translate/1/culture
  66. api/package/1/flow/{flowid}
  67. api/package/1/flow/{flowid}/{flowVersionId}
  68. api/package/1/flow
  69. api/service/1/requests
  70. api/service/1/requests/{requestId}

Note: This list is indicative only, and may not be complete. Please refer to the Flow reference documentation for the most up-to-date information!


Check out the glossary for a definition of terms and key concepts that appear in the Boomi Flow website, drawing tool, technical documentation, blogs, and marketing communications.

If you need to take a closer look, click on the images to enlarge them. Have a question? Click the Help button on the bottom right-hand corner of this page to ask.