Users

Your users: set one up, read their spend, change their cap, export or erase them.

Send Authorization: Bearer vk_test_... on every call. Every route of Users.

GET/v1/usersList your users.

Your API key, scope runtime or all. On the card: users. Over HTTP it is made from the contract: fill in every value.

Request2 fields

Query

limitintegerHow many items per page, 1 to 100. Default 20.

Type: integer

cursorstringWhere to go on from: the next_cursor of the page before, unchanged. Absent: the first page.

Type: string

Answers 2002 fields

dataobject[]The items on this page.

idstringYour own id for the user.

Example: traveller-42

object"user"Always user.

Type: "user"

namestring | nullThe user's name; null when you gave none.

Type: string | null

emailstring | nullThe user's email address; null when you gave none.

Type: string | null

localestring | nullThe user's language and region (BCP 47); null when you gave none.

Type: string | null

timezonestring | nullThe user's time zone (IANA); null when you gave none, and their routines then run in UTC.

Type: string | null

metadatamap of anyYour own facts about the user; empty when you gave none.

Type: map of any

status"active" | "disabled"active, or disabled: a disabled user's calls are refused (403 user_disabled) until you turn them back on.

Type: "active" | "disabled"

spend_cap_usdnumber | nullThe user's own cap per day, in billed US dollars, never above your company's; null: your company's cap for each user, if any.

Type: number | null

monthly_cap_usdnumber | nullThe user's own cap per calendar month (UTC), in billed US dollars; null: your company's cap for each user, if any.

Type: number | null

default_deploymentstring | nullThe deployment their conversations use when none is named (dep_...); null: your company's default.

Type: string | null

memory_mode"vestra" | "customer" | "none"Where Bash's memory of this user lives: vestra, customer (your memory endpoint), or none.

Type: "vestra" | "customer" | "none"

is_service_userbooleantrue for a user Vestra keeps for itself, such as your company's own Bash; false for your users.

Type: boolean

created_atstringWhen the user was made, as an ISO 8601 time.

Type: string

next_cursorstring | nullSend it as cursor for the next page; null on the last page.

Type: string | null

TypeScript

const users = await vestra.users.list();

Python

users = vestra.users.list()

CLI

vestra users

HTTP

No sample in your language for this route, so here it is over HTTP.

curl "$VESTRA_BASE_URL/v1/users" \  -H "Authorization: Bearer $VESTRA_API_KEY"