Home / API Reference / Users
Resource
Users
Login records of everyone on the account (clients, practitioners, staff, agents and the owner), a user's weekly availability, and the custom fields the account defines.
The user object
Every user record carries these fields in this order, after object, which is always "user".
| Field | Type | Description |
|---|---|---|
id | integer | The login id. It is not the client, practitioner or staff id; use it with /users/{id}/availability. |
username | string, up to 50 characters, nullable | Login name, lower case and unique across every account. Empty or null when the person has no login. |
email | string, up to 510 characters, nullable | One e-mail address or several, comma-separated, lower case. |
Example
{
"object": "user",
"id": 42,
"username": "jane.doe",
"email": "jane.doe@example.com"
} List login records
GET /api/v1/users
Parameters
| Parameter | In | Description |
|---|---|---|
limit | query | Records per page, 1 to 1000 (default 100). |
offset | query | Records to skip (default 0). |
Returns
A list envelope of user records (see Pagination).
Request
curl "https://www.bizstim.com/api/v1/users" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Accept: application/json"<?php
$ch = curl_init('https://www.bizstim.com/api/v1/users');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-API-KEY: YOUR_API_KEY', 'Accept: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);const response = await fetch('https://www.bizstim.com/api/v1/users', {
headers: { 'X-API-KEY': 'YOUR_API_KEY', 'Accept': 'application/json' }
});
const data = await response.json();Response
{
"object": "list",
"total": 2,
"limit": 100,
"offset": 0,
"has_more": false,
"data": [
{
"object": "user",
"id": 42,
"username": "jane.doe",
"email": "jane.doe@example.com"
},
{
"object": "user",
"id": 43,
"username": "jane.doe",
"email": "jane.doe@example.com"
}
]
} Retrieve a login record
GET /api/v1/users/{id}
Parameters
| Parameter | In | Description |
|---|---|---|
id | path | The record's id. |
Returns
One user record, or 404 not_found when no record with that id exists on your account.
Request
curl "https://www.bizstim.com/api/v1/users/42" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Accept: application/json"<?php
$ch = curl_init('https://www.bizstim.com/api/v1/users/42');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-API-KEY: YOUR_API_KEY', 'Accept: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);const response = await fetch('https://www.bizstim.com/api/v1/users/42', {
headers: { 'X-API-KEY': 'YOUR_API_KEY', 'Accept': 'application/json' }
});
const data = await response.json();Response
{
"object": "user",
"id": 42,
"username": "jane.doe",
"email": "jane.doe@example.com"
} Retrieve the weekly availability of the client, practitioner or staff member who owns this login
GET /api/v1/users/{id}/availability
Parameters
| Parameter | In | Description |
|---|---|---|
id | path | The record's id. |
The availability object
| Field | Type | Description |
|---|---|---|
id | integer | |
label | string, up to 20 characters | "Default" for the standing weekly hours. |
start | string, up to 10 characters | "0" on the standing (Default) hours; otherwise the first day they apply, YYYY-MM-DD. |
end | string, up to 10 characters | "0" on the standing (Default) hours; otherwise the last day they apply, YYYY-MM-DD. |
mAvailf | string, up to 25 characters, nullable | Monday start time, 24-hour HH:MM. Empty or null when no hours are set that day. |
mAvailt | string, up to 25 characters, nullable | Monday end time, 24-hour HH:MM. |
tAvailf | string, up to 25 characters, nullable | Tuesday start time, 24-hour HH:MM. Empty or null when no hours are set that day. |
tAvailt | string, up to 25 characters, nullable | Tuesday end time, 24-hour HH:MM. |
wAvailf | string, up to 25 characters, nullable | Wednesday start time, 24-hour HH:MM. Empty or null when no hours are set that day. |
wAvailt | string, up to 25 characters, nullable | Wednesday end time, 24-hour HH:MM. |
rAvailf | string, up to 25 characters, nullable | Thursday start time, 24-hour HH:MM. Empty or null when no hours are set that day. |
rAvailt | string, up to 25 characters, nullable | Thursday end time, 24-hour HH:MM. |
fAvailf | string, up to 25 characters, nullable | Friday start time, 24-hour HH:MM. Empty or null when no hours are set that day. |
fAvailt | string, up to 25 characters, nullable | Friday end time, 24-hour HH:MM. |
satAvailf | string, up to 25 characters, nullable | Saturday start time, 24-hour HH:MM. Empty or null when no hours are set that day. |
satAvailt | string, up to 25 characters, nullable | Saturday end time, 24-hour HH:MM. |
sunAvailf | string, up to 25 characters, nullable | Sunday start time, 24-hour HH:MM. Empty or null when no hours are set that day. |
sunAvailt | string, up to 25 characters, nullable | Sunday end time, 24-hour HH:MM. |
Returns
One availability record, or 404 not_found when no record with that id exists on your account.
Request
curl "https://www.bizstim.com/api/v1/users/42/availability" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Accept: application/json"<?php
$ch = curl_init('https://www.bizstim.com/api/v1/users/42/availability');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-API-KEY: YOUR_API_KEY', 'Accept: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);const response = await fetch('https://www.bizstim.com/api/v1/users/42/availability', {
headers: { 'X-API-KEY': 'YOUR_API_KEY', 'Accept': 'application/json' }
});
const data = await response.json();Response
{
"object": "availability",
"id": 42,
"label": "Weekdays",
"start": "2026-01-15",
"end": "2026-12-31",
"mAvailf": "09:00",
"mAvailt": "17:00",
"tAvailf": "09:00",
"tAvailt": "17:00",
"wAvailf": "09:00",
"wAvailt": "17:00",
"rAvailf": "09:00",
"rAvailt": "17:00",
"fAvailf": "09:00",
"fAvailt": "17:00",
"satAvailf": "09:00",
"satAvailt": "17:00",
"sunAvailf": "09:00",
"sunAvailt": "17:00"
} List the custom fields the account defines
GET /api/v1/custom-fields
Parameters
| Parameter | In | Description |
|---|---|---|
limit | query | Records per page, 1 to 1000 (default 100). |
offset | query | Records to skip (default 0). |
The custom_field object
| Field | Type | Description |
|---|---|---|
id | integer | |
user | string, up to 155 characters | Always "client": custom fields are on client records. |
type | string, up to 155 characters | text, textarea, checkbox, radio or dropdown. |
public | string, up to 7 characters | "public" (can be added to the online booking page and the inquiry form) or "private" (never offered there). |
pract | integer | 1 = practitioners can see the field, 0 = they cannot. |
sales_manager | integer | 1 = shown as a column in the Sales Manager list, 0 = not. |
label | string, up to 255 characters | |
order_custom | integer | Position in the field list, 1 first. |
Returns
A list envelope of custom_field records (see Pagination).
Request
curl "https://www.bizstim.com/api/v1/custom-fields" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Accept: application/json"<?php
$ch = curl_init('https://www.bizstim.com/api/v1/custom-fields');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => ['X-API-KEY: YOUR_API_KEY', 'Accept: application/json'],
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);const response = await fetch('https://www.bizstim.com/api/v1/custom-fields', {
headers: { 'X-API-KEY': 'YOUR_API_KEY', 'Accept': 'application/json' }
});
const data = await response.json();Response
{
"object": "list",
"total": 2,
"limit": 100,
"offset": 0,
"has_more": false,
"data": [
{
"object": "custom_field",
"id": 42,
"user": "text",
"type": "text",
"public": "text",
"pract": 1,
"sales_manager": 1,
"label": "Weekdays",
"order_custom": 1
},
{
"object": "custom_field",
"id": 43,
"user": "text",
"type": "text",
"public": "text",
"pract": 1,
"sales_manager": 1,
"label": "Weekdays",
"order_custom": 1
}
]
}