List assignable users
The people you can assign conversations to in one mailbox.
GET https://cotlet.dev/api/v1/freescout/mailbox/{mailbox_id}/users
read
Returns the names in the Assignee dropdown of the mailbox, with their user_id. A mailbox can hide admins from that list with its "Hide from Assign list" permission, so a hidden admin is not returned. Use user_id with assign_conversation.
Parameters
| Name | Type | Description |
|---|---|---|
| mailbox_id integer required | integer | Mailbox ID from list_mailboxes. It is the number at the end of the mailbox settings address. |
Request
curl https://cotlet.dev/api/v1/freescout/mailbox/1/users \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("freescout", "list_users", {"mailbox_id":1})const result = await cotlet.call('freescout', 'list_users', {"mailbox_id":1});cotlet call freescout list_users --data '{"mailbox_id":1}'Example response
{
"users": [
{
"user_id": 2,
"name": "Maya Brown"
},
{
"user_id": 3,
"name": "Sam Okafor"
}
]
}