Skip to content
Try For Free
Bizstim
Free tools
Pricing Contact Log in
Try For Free Book Demo
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".

FieldTypeDescription
idintegerThe login id. It is not the client, practitioner or staff id; use it with /users/{id}/availability.
usernamestring, up to 50 characters, nullableLogin name, lower case and unique across every account. Empty or null when the person has no login.
emailstring, up to 510 characters, nullableOne 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

ParameterInDescription
limitqueryRecords per page, 1 to 1000 (default 100).
offsetqueryRecords 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"

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

ParameterInDescription
idpathThe 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"

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

ParameterInDescription
idpathThe record's id.

The availability object

FieldTypeDescription
idinteger
labelstring, up to 20 characters"Default" for the standing weekly hours.
startstring, up to 10 characters"0" on the standing (Default) hours; otherwise the first day they apply, YYYY-MM-DD.
endstring, up to 10 characters"0" on the standing (Default) hours; otherwise the last day they apply, YYYY-MM-DD.
mAvailfstring, up to 25 characters, nullableMonday start time, 24-hour HH:MM. Empty or null when no hours are set that day.
mAvailtstring, up to 25 characters, nullableMonday end time, 24-hour HH:MM.
tAvailfstring, up to 25 characters, nullableTuesday start time, 24-hour HH:MM. Empty or null when no hours are set that day.
tAvailtstring, up to 25 characters, nullableTuesday end time, 24-hour HH:MM.
wAvailfstring, up to 25 characters, nullableWednesday start time, 24-hour HH:MM. Empty or null when no hours are set that day.
wAvailtstring, up to 25 characters, nullableWednesday end time, 24-hour HH:MM.
rAvailfstring, up to 25 characters, nullableThursday start time, 24-hour HH:MM. Empty or null when no hours are set that day.
rAvailtstring, up to 25 characters, nullableThursday end time, 24-hour HH:MM.
fAvailfstring, up to 25 characters, nullableFriday start time, 24-hour HH:MM. Empty or null when no hours are set that day.
fAvailtstring, up to 25 characters, nullableFriday end time, 24-hour HH:MM.
satAvailfstring, up to 25 characters, nullableSaturday start time, 24-hour HH:MM. Empty or null when no hours are set that day.
satAvailtstring, up to 25 characters, nullableSaturday end time, 24-hour HH:MM.
sunAvailfstring, up to 25 characters, nullableSunday start time, 24-hour HH:MM. Empty or null when no hours are set that day.
sunAvailtstring, up to 25 characters, nullableSunday 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"

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

ParameterInDescription
limitqueryRecords per page, 1 to 1000 (default 100).
offsetqueryRecords to skip (default 0).

The custom_field object

FieldTypeDescription
idinteger
userstring, up to 155 charactersAlways "client": custom fields are on client records.
typestring, up to 155 characterstext, textarea, checkbox, radio or dropdown.
publicstring, up to 7 characters"public" (can be added to the online booking page and the inquiry form) or "private" (never offered there).
practinteger1 = practitioners can see the field, 0 = they cannot.
sales_managerinteger1 = shown as a column in the Sales Manager list, 0 = not.
labelstring, up to 255 characters
order_customintegerPosition 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"

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
        }
    ]
}