Create user
curl --request POST \
--url https://breadbox.example.com/api/v1/users \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"email": "<string>"
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"email": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}Users
Create user
Requires full_access scope.
POST
/
api
/
v1
/
users
Create user
curl --request POST \
--url https://breadbox.example.com/api/v1/users \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"email": "<string>"
}
'{
"id": "<string>",
"short_id": "<string>",
"name": "<string>",
"email": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}Documentation Index
Fetch the complete documentation index at: https://docs.breadbox.sh/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Breadbox API key with format bb_<base62>. Carries either read_only
or full_access scope. Write endpoints (and a handful of sensitive
reads — /api-keys, /users/{user_id}/login) require full_access;
endpoints that require it are flagged in their description.
Body
application/json
⌘I