Skip to main content
POST
/
action
/
get_user_list
Get User List
curl --request POST \
  --url https://api-lr.agent.ai/v1/action/get_user_list \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input_description": "<string>",
  "input_name": "user_input",
  "delimiter": "<string>",
  "required": true
}
'
{
  "status": 123,
  "response": {}
}

Authorizations

​
Authorization
string
header
required

Bearer token from your account (https://agent.ai/user/integrations#api)

Body

application/json
​
input_description
string
required

Write a clear prompt to guide users on what information is required. For example, 'Please enter your email address' or 'Select your preferred contact method.'

​
input_name
string
default:user_input
required

Assign a unique variable name for the input value, such as 'user_email' or 'preferred_contact', which you can reference later in the workflow.

Pattern: ^[a-zA-Z][a-zA-Z0-9_]*$
​
delimiter
string

This is the character that separates the list items. For example, use a comma (,) for 'item1,item2,item3'. Leave blank to split on newlines.

​
required
boolean
default:true

Mark this checkbox if this input is mandatory. For example, enable it if a response is essential to proceed in the workflow.

Response

Successful response

​
status
integer<int32>

HTTP status code of the action response

​
response
object

Response data from the action