FlowMate API Documentation
  1. User
FlowMate API Documentation
  • Authentication
    • Login
      POST
  • Flows
    • Retrieve all flows
      GET
    • Find Flow by ID
      GET
    • Deletes a flow
      DELETE
    • Update an existing flow
      PATCH
    • Bulk update a number of existing flows
      PATCH
    • Start a flow
      POST
    • Stop a flow
      POST
    • Start multiple flows
      POST
    • Stop multiple flows
      POST
  • User
    • get all users
      GET
    • Create user
      POST
    • get a user by id
      GET
    • get current user
      GET
  • Templates
    • Retrieve all flow templates
      GET
    • Add a new template to the repository
      POST
    • Find Flow Template by ID
      GET
    • Deletes a flow template
      DELETE
    • Update an existing flow template
      PATCH
    • Generate a flow from the flow template
      POST
  • Executions
    • Get Executions
      GET
  • Webhooks
    • Incoming Webhook
      POST
  1. User

get all users

GET
https://api.platform.openintegrationhub.com/api/users
user
This can only be done by a logged in user who has the required privileges.

Request

Query Params
meta
boolean 
optional
Set to true to receive response in data/meta format

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.platform.openintegrationhub.com/api/users?meta'

Responses

🟢200OK
application/json
List all users
Body
array of:
id
string 
optional
User Id
username
string 
required
Username as an email address
firstname
string 
required
firstname
lastname
string 
required
lastname
status
enum<string> 
optional
Allowed values:
ACTIVEPENDINGDISABLED
tenant
string 
optional
roles
array[object (Role) {8}] 
optional
id
string 
optional
name
string 
optional
permissions
array[string]
optional
Allowed values:
alliam.tenant.createiam.tenant.readiam.tenant.updateiam.tenant.deleteiam.secret.createiam.secret.readiam.key.createiam.key.readiam.key.deleteiam.account.createiam.account.readiam.account.updateiam.account.deleteiam.token.createiam.token.updateiam.token.deleteiam.token.introspecttenant.alltenant.membership.createtenant.membership.updatetenant.membership.deletetenant.profile.readtenant.profile.updatetenant.profile.deletetenant.roles.readtenant.roles.createtenant.roles.updatetenant.roles.deletetenant.flows.readtenant.flows.createtenant.flows.updatetenant.flows.delete
scope
string 
optional
createdAt
string 
optional
updatedAt
string 
optional
isGlobal
boolean 
optional
description
string 
optional
permissions
array[string]
optional
Allowed values:
alliam.tenant.createiam.tenant.readiam.tenant.updateiam.tenant.deleteiam.secret.createiam.secret.readiam.key.createiam.key.readiam.key.deleteiam.account.createiam.account.readiam.account.updateiam.account.deleteiam.token.createiam.token.updateiam.token.deleteiam.token.introspecttenant.alltenant.membership.createtenant.membership.updatetenant.membership.deletetenant.profile.readtenant.profile.updatetenant.profile.deletetenant.roles.readtenant.roles.createtenant.roles.updatetenant.roles.deletetenant.flows.readtenant.flows.createtenant.flows.updatetenant.flows.delete
confirmed
boolean 
optional
true, if the confirmation link/email has been triggered
img
string 
optional
url to user image
Example
[
    {
        "id": "string",
        "username": "string",
        "firstname": "string",
        "lastname": "string",
        "status": "ACTIVE",
        "tenant": "string",
        "roles": [
            {
                "id": "string",
                "name": "string",
                "permissions": [
                    "all"
                ],
                "scope": "string",
                "createdAt": "string",
                "updatedAt": "string",
                "isGlobal": true,
                "description": "string"
            }
        ],
        "permissions": [
            "all"
        ],
        "confirmed": true,
        "img": "string"
    }
]
Modified at 2025-01-16 10:19:16
Previous
Stop multiple flows
Next
Create user
Built with