Retrieve a list of all users

GET 
/users

Returns a list of all users created in your Embedded account.

Request

Query Parameters

parentWorkflowId string

You can pass a parentWorkflowId if you wish to list users for a specific workflow.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

data

object[]

Array [

userId string

username string

fullName string

]

Example (from schema)

{
  "data": [
    {
      "userId": "6323d7c9122ae69742a5d0a2",
      "username": "gregg",
      "fullName": "Gregg Mojica"
    }
  ]
}

Result

{
    "data": [
        {
            "userId": "6323d7c9122ae69742a5d0a2",
            "username": "gregg",
            "fullName": "Gregg Mojica"
        },
        {
            "userId": "6323d7cf9ae88f59bf66ce63",
            "username": "sara",
            "fullName": "Sara Du"
        },
        {
            "userId": "6323d7e159479ba26d80fcc8",
            "fullName": "William Jackson"
        },
        {
            "userId": "6323d7f090020baf1091b151",
            "username": "izzy@gmail.com",
            "fullName": "Izzy Jackson"
        },
         {
            "userId": "6323d7da4b764bfe02cacaef",
            "username": "jose@example.com",
            "fullName": "Jose Santos"
        }
    ]
}

401

401

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Unauthorized"
}

Result

{
  "message":"Unauthorized"
}

Loading...