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.

POST/v1/users/{user_id}/exportPackage everything held for the user into one download, for data-rights requests.

Your API key, scope admin or all. On the card: users. Over HTTP it is made from the contract: fill in each {…} and every value.

Request1 field

Path

user_idstringrequiredYour own id for the user, as you named them.

Answers 2005 fields

object"user_export"Always user_export.

urlstringA link to everything Vestra holds for the user, as one JSON file: good for 15 minutes.

expires_atstringWhen the link stops working, as an ISO 8601 time.

bytesintegerThe size of the file, in bytes.

truncatedbooleantrue when the user has more than the 200 tasks it holds: the oldest are left out.

TypeScript

const download = await vestra.user('traveller-42').export();

Python

download = vestra.user("traveller-42").export()

CLI

vestra users export traveller-42

HTTP

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

curl -X POST "$VESTRA_BASE_URL/v1/users/{user_id}/export" \  -H "Authorization: Bearer $VESTRA_API_KEY"