End-users

End-users are the identities behind softphones; each gets its own extension. Mint a phone token for one to let it place or receive calls.

List end-users

GET /users/

Returns array<EndUser>.

Create an end-user

POST /users/create

Field	Type	Required	Default	Description
email	string	Required	-	Unique per account.
display_name	string	Optional	""	Shown on the softphone.

Returns an EndUser. Errors: 409 duplicate email.

cURL

curl https://api.sautipbx.com/api/users/create \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "email": "agent1@yourapp.com", "display_name": "Agent One" }'

# → 201 Created
# { "uuid": "...", "extension_number": "2001", … }

Node

const res = await fetch("https://api.sautipbx.com/api/users/create", {
  method: "POST",
  headers: {
    Authorization: "Bearer sk_live_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ email: "agent1@yourapp.com", display_name: "Agent One" }),
});
const user = await res.json();

Python

import requests

res = requests.post(
    "https://api.sautipbx.com/api/users/create",
    headers={"Authorization": "Bearer sk_live_..."},
    json={"email": "agent1@yourapp.com", "display_name": "Agent One"},
)
user = res.json()

Update an end-user

POST /users/update

Field	Type	Required	Description
uuid	string	Required	The end-user.
display_name	string, nullable	Optional	New name.
is_active	boolean, nullable	Optional	Enable or disable.

Returns an EndUser.

Delete an end-user

POST /users/delete

Body { uuid: string }. Returns { message: string }.