vCita Staff Member API
The Staff Member API from vCita — 1 operation(s) for staff member.
The Staff Member API from vCita — 1 operation(s) for staff member.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vcita:vcita-staff-member-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Platform_administration Staff Member API
description: Unified OpenAPI specification for platform_administration domain
version: '3.0'
x-generated:
sourceFiles:
- directory.json
- license.json
- operator-portal.json
- legacy_v2_todo.json
- legacy_v1_platform.json
- legacy_v2_settings_businesses.json
- business.json
- staff.json
- staff_member.json
- oauth.json
- online_profiles.json
- partners-api.json
- staff.json
- access_control.json
- accounts.json
pathNormalizations:
- file: license.json
basePath: /v3
transformations:
- original: /license/offerings
normalized: /v3/license/offerings
basePath: /v3
- original: /license/offerings/{uid}
normalized: /v3/license/offerings/{uid}
basePath: /v3
- original: /license/directory_offerings
normalized: /v3/license/directory_offerings
basePath: /v3
- original: /license/directory_offerings/{uid}
normalized: /v3/license/directory_offerings/{uid}
basePath: /v3
- original: /license/bundled_offerings
normalized: /v3/license/bundled_offerings
basePath: /v3
- original: /license/bundled_offerings/bulk
normalized: /v3/license/bundled_offerings/bulk
basePath: /v3
- original: /license/bundled_offerings/{uid}
normalized: /v3/license/bundled_offerings/{uid}
basePath: /v3
- original: /license/subscriptions
normalized: /v3/license/subscriptions
basePath: /v3
- original: /license/subscriptions/bulk
normalized: /v3/license/subscriptions/bulk
basePath: /v3
- original: /license/subscriptions/{uid}
normalized: /v3/license/subscriptions/{uid}
basePath: /v3
- original: /license/business_carts
normalized: /v3/license/business_carts
basePath: /v3
- original: /license/business_carts/{uid}
normalized: /v3/license/business_carts/{uid}
basePath: /v3
- original: /license/skus
normalized: /v3/license/skus
basePath: /v3
- original: /license/features_packages
normalized: /v3/license/features_packages
basePath: /v3
- original: /license/features
normalized: /v3/license/features
basePath: /v3
- original: /license/features/{uid}
normalized: /v3/license/features/{uid}
basePath: /v3
- original: /license/features_packages/{id}
normalized: /v3/license/features_packages/{id}
basePath: /v3
- original: /license/features_packages/add_feature
normalized: /v3/license/features_packages/add_feature
basePath: /v3
- original: /license/quota_consumptions
normalized: /v3/license/quota_consumptions
basePath: /v3
- original: /license/quota_balances
normalized: /v3/license/quota_balances
basePath: /v3
- file: operator-portal.json
basePath: /api/operator_api/v1
transformations:
- original: /packages
normalized: /api/operator_api/v1/packages
basePath: /api/operator_api/v1
- original: /packages/{id}
normalized: /api/operator_api/v1/packages/{id}
basePath: /api/operator_api/v1
- original: /packages/add_feature
normalized: /api/operator_api/v1/packages/add_feature
basePath: /api/operator_api/v1
- original: /features
normalized: /api/operator_api/v1/features
basePath: /api/operator_api/v1
- original: /features/{id}
normalized: /api/operator_api/v1/features/{id}
basePath: /api/operator_api/v1
- file: legacy_v1_platform.json
basePath: /platform/v1
transformations:
- original: /businesses
normalized: /platform/v1/businesses
basePath: /platform/v1
- original: /businesses/validate_login
normalized: /platform/v1/businesses/validate_login
basePath: /platform/v1
- original: /businesses/verify_audience_claim
normalized: /platform/v1/businesses/verify_audience_claim
basePath: /platform/v1
- original: /businesses/{business_uid}
normalized: /platform/v1/businesses/{business_uid}
basePath: /platform/v1
- original: /directory/branding
normalized: /platform/v1/directory/branding
basePath: /platform/v1
- original: /tokens
normalized: /platform/v1/tokens
basePath: /platform/v1
- original: /tokens/revoke
normalized: /platform/v1/tokens/revoke
basePath: /platform/v1
- original: /webhook/subscribe
normalized: /platform/v1/webhook/subscribe
basePath: /platform/v1
- original: /webhook/unsubscribe
normalized: /platform/v1/webhook/unsubscribe
basePath: /platform/v1
- original: /webhooks
normalized: /platform/v1/webhooks
basePath: /platform/v1
- original: /businesses/{business_uid}/features
normalized: /platform/v1/businesses/{business_uid}/features
basePath: /platform/v1
- original: /businesses/{business_uid}/purchased_items
normalized: /platform/v1/businesses/{business_uid}/purchased_items
basePath: /platform/v1
- original: /businesses/{business_uid}/recurly_data
normalized: /platform/v1/businesses/{business_uid}/recurly_data
basePath: /platform/v1
- original: /businesses/{business_uid}/staffs
normalized: /platform/v1/businesses/{business_uid}/staffs
basePath: /platform/v1
- original: /businesses/{business_uid}/staffs/{staff_uid}
normalized: /platform/v1/businesses/{business_uid}/staffs/{staff_uid}
basePath: /platform/v1
- original: /businesses/{business_uid}/staffs/{staff_uid}/sessions
normalized: /platform/v1/businesses/{business_uid}/staffs/{staff_uid}/sessions
basePath: /platform/v1
- original: /businesses/{business_uid}/wizards
normalized: /platform/v1/businesses/{business_uid}/wizards
basePath: /platform/v1
- original: /businesses/{business_uid}/wizards/{wizard_name}
normalized: /platform/v1/businesses/{business_uid}/wizards/{wizard_name}
basePath: /platform/v1
- original: /scheduling/staff
normalized: /platform/v1/scheduling/staff
basePath: /platform/v1
- original: /scheduling/staff/{staff_uid}
normalized: /platform/v1/scheduling/staff/{staff_uid}
basePath: /platform/v1
- original: /business/jobber/flows
normalized: /platform/v1/business/jobber/flows
basePath: /platform/v1
- original: /business/jobber/executions
normalized: /platform/v1/business/jobber/executions
basePath: /platform/v1
- file: staff.json
basePath: /business/staffs
transformations:
- original: /v1/daily_staff_sign_ins
normalized: /business/staffs/v1/daily_staff_sign_ins
basePath: /business/staffs
- original: /v1/staffs/{uid}
normalized: /business/staffs/v1/staffs/{uid}
basePath: /business/staffs
- file: oauth.json
basePath: /oauth
transformations:
- original: /token
normalized: /oauth/token
basePath: /oauth
- original: /userinfo
normalized: /oauth/userinfo
basePath: /oauth
- file: online_profiles.json
basePath: /v3/business_administration
transformations:
- original: /online_profiles/{business_uid}
normalized: /v3/business_administration/online_profiles/{business_uid}
basePath: /v3/business_administration
- original: /online_profiles
normalized: /v3/business_administration/online_profiles
basePath: /v3/business_administration
- original: /online_profiles/{uid}
normalized: /v3/business_administration/online_profiles/{uid}
basePath: /v3/business_administration
- file: accounts.json
basePath: /business/accounts
transformations:
- original: /v1/attributes
normalized: /business/accounts/v1/attributes
basePath: /business/accounts
- original: /v1/branding
normalized: /business/accounts/v1/branding
basePath: /business/accounts
- original: /v1/identities
normalized: /business/accounts/v1/identities
basePath: /business/accounts
- original: /v1/usage/last_3_months_activity
normalized: /business/accounts/v1/usage/last_3_months_activity
basePath: /business/accounts
pathConflicts: []
componentConflicts:
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_license
files:
- merged
- license.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_operator-portal
files:
- merged
- operator-portal.json
- type: schema
name: Paging
resolution: Renamed to Paging_business
files:
- merged
- business.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_online_profiles
files:
- merged
- online_profiles.json
- type: schema
name: ErrorResponse
resolution: Renamed to ErrorResponse_staff
files:
- merged
- staff.json
totalPaths: 85
totalComponents: 54
servers:
- url: https://api.vcita.biz
description: Unified API Gateway server
tags:
- name: Staff Member
paths:
/v3/business_administration/staff_members/{uid}:
get:
summary: Retrieve a StaffMember
description: '## Overview
Retrieve a StaffMember.
Available for **Staff, Directory, and Client tokens**'
tags:
- Staff Member
parameters:
- name: uid
in: path
required: true
description: The unique identifier of the staff member. Must be a valid uid from an existing staff member.
schema:
type: string
x-reference-to: staff_member
responses:
'200':
description: Staff member retrieved successfully
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
required:
- business_uid
- first_name
- email
- role
type: object
properties:
uid:
type: string
readOnly: true
description: The unique identifier of the staff member.
first_name:
type: string
description: The first name of the staff member.
last_name:
type:
- string
- 'null'
description: The last name of the staff member.
display_name:
type:
- string
- 'null'
description: The display name of the staff member used for public facing interfaces.
email:
type: string
description: The email address of the staff member.
professional_title:
type:
- string
- 'null'
description: The professional title or position of the staff member (e.g., "Senior Consultant", "Medical Director").
business_uid:
type: string
readOnly: true
description: The unique identifier of the business the staff member belongs to.
country_name:
type:
- string
- 'null'
description: The country name for the staff member's mobile number (e.g., "United States", "United Kingdom").
mobile_number:
type:
- string
- 'null'
description: The mobile number of the staff member without country code (e.g., "2345678901").
photo_url:
type:
- string
- 'null'
description: The URL to the staff member's profile photo.
default_homepage:
type:
- string
- 'null'
description: The default page to navigate to when the staff member logs in. When null, the system default is used.
enum:
- dashboard
- inbox
- calendar
- clients
- pos
- null
role:
type: string
description: The role or permission level of the staff member (e.g., "admin", "user", "manager", "marketing", "collaborator").
email_signature:
type:
- string
- 'null'
description: The email signature used by the staff member in communications.
business_role_display_name:
type:
- string
- 'null'
description: The display name of the staff member's role within the business.
owner:
type: boolean
readOnly: true
description: Indicates whether the staff member is an owner of the business.
active:
type: boolean
readOnly: true
description: Indicates whether the staff member account is active.
deleted:
type: boolean
readOnly: true
description: Indicates whether the staff member has been soft-deleted. Deleted staff members are retained for historical records but are no longer active.
blocked_at:
type:
- string
- 'null'
format: date-time
readOnly: true
description: The date and time when the staff member was blocked, in ISO 8601 format. Null if the staff member is not blocked.
created_at:
type: string
format: date-time
readOnly: true
description: The date and time when the staff member was created, in ISO 8601 format.
updated_at:
type: string
format: date-time
readOnly: true
description: The date and time when the staff member was last updated, in ISO 8601 format.
example:
uid: staff-12345
first_name: John
last_name: Doe
display_name: Dr. John Doe
email: john.doe@example.com
professional_title: Senior Consultant
business_uid: business-12345
country_name: United States
mobile_number: '2345678901'
photo_url: https://storage.example.com/staff/profile/12345.jpg
default_homepage: dashboard
role: admin
email_signature: 'Best regards,
John Doe
Senior Consultant'
business_role_display_name: Business Administrator
owner: true
active: true
deleted: false
blocked_at: null
created_at: '2023-01-01T12:00:00Z'
updated_at: '2023-01-15T09:30:00Z'
description: Represents a staff member profile within a business, including identity and settings.
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Staff member not found
'500':
description: Internal server error
security:
- Bearer: []
operationId: getV3BusinessAdministrationStaffMembersByUid
x-operation-id-source: derived
put:
summary: Update a StaffMember
description: '## Overview
Update a StaffMember.
**Available for Staff Token**'
tags:
- Staff Member
parameters:
- name: uid
in: path
required: true
description: The unique identifier of the staff member. Must be a valid uid from an existing staff member.
schema:
type: string
x-reference-to: staff_member
requestBody:
required: false
content:
application/json:
schema:
$ref: '#/components/schemas/StaffMemberUpdate'
example:
first_name: Jonathan
last_name: Doe
display_name: Dr. Jonathan Doe
email: jonathan.doe@example.com
professional_title: Senior Medical Consultant
country_name: United Kingdom
mobile_number: '7123456789'
photo_url: https://storage.example.com/staff/profile/12345_new.jpg
default_homepage: calendar
email_signature: 'Kind regards,
Jonathan Doe, MD
Senior Medical Consultant'
responses:
'200':
description: Staff member updated successfully
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Response'
- properties:
data:
required:
- business_uid
- first_name
- email
- role
type: object
properties:
uid:
type: string
readOnly: true
description: The unique identifier of the staff member.
first_name:
type: string
description: The first name of the staff member.
last_name:
type:
- string
- 'null'
description: The last name of the staff member.
display_name:
type:
- string
- 'null'
description: The display name of the staff member used for public facing interfaces.
email:
type: string
description: The email address of the staff member.
professional_title:
type:
- string
- 'null'
description: The professional title or position of the staff member (e.g., "Senior Consultant", "Medical Director").
business_uid:
type: string
readOnly: true
description: The unique identifier of the business the staff member belongs to.
country_name:
type:
- string
- 'null'
description: The country name for the staff member's mobile number (e.g., "United States", "United Kingdom").
mobile_number:
type:
- string
- 'null'
description: The mobile number of the staff member without country code (e.g., "2345678901").
photo_url:
type:
- string
- 'null'
description: The URL to the staff member's profile photo.
default_homepage:
type:
- string
- 'null'
description: The default page to navigate to when the staff member logs in. When null, the system default is used.
enum:
- dashboard
- inbox
- calendar
- clients
- pos
- null
role:
type: string
description: The role or permission level of the staff member (e.g., "admin", "user", "manager", "marketing", "collaborator").
email_signature:
type:
- string
- 'null'
description: The email signature used by the staff member in communications.
business_role_display_name:
type:
- string
- 'null'
description: The display name of the staff member's role within the business.
owner:
type: boolean
readOnly: true
description: Indicates whether the staff member is an owner of the business.
active:
type: boolean
readOnly: true
description: Indicates whether the staff member account is active.
deleted:
type: boolean
readOnly: true
description: Indicates whether the staff member has been soft-deleted. Deleted staff members are retained for historical records but are no longer active.
blocked_at:
type:
- string
- 'null'
format: date-time
readOnly: true
description: The date and time when the staff member was blocked, in ISO 8601 format. Null if the staff member is not blocked.
created_at:
type: string
format: date-time
readOnly: true
description: The date and time when the staff member was created, in ISO 8601 format.
updated_at:
type: string
format: date-time
readOnly: true
description: The date and time when the staff member was last updated, in ISO 8601 format.
example:
uid: staff-12345
first_name: John
last_name: Doe
display_name: Dr. John Doe
email: john.doe@example.com
professional_title: Senior Consultant
business_uid: business-12345
country_name: United States
mobile_number: '2345678901'
photo_url: https://storage.example.com/staff/profile/12345.jpg
default_homepage: dashboard
role: admin
email_signature: 'Best regards,
John Doe
Senior Consultant'
business_role_display_name: Business Administrator
owner: true
active: true
deleted: false
blocked_at: null
created_at: '2023-01-01T12:00:00Z'
updated_at: '2023-01-15T09:30:00Z'
description: Represents a staff member profile within a business, including identity and settings.
'400':
description: Invalid request parameters
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Staff member not found
'409':
description: Email already in use by another staff member
'500':
description: Internal server error
security:
- Bearer: []
operationId: putV3BusinessAdministrationStaffMembersByUid
x-operation-id-source: derived
components:
schemas:
Response:
type: object
properties:
success:
type: boolean
description: Whether the API request was successful
example: true
StaffMemberUpdate:
type: object
description: Request body for updating a staff member's profile information.
properties:
first_name:
type: string
description: The first name of the staff member.
last_name:
type:
- string
- 'null'
description: The last name of the staff member.
display_name:
type:
- string
- 'null'
description: The display name of the staff member used for public facing interfaces.
email:
type: string
description: The email address of the staff member.
professional_title:
type:
- string
- 'null'
description: The professional title of the staff member (e.g., "Senior Consultant", "Medical Director").
country_name:
type:
- string
- 'null'
description: The country name for the staff member's mobile number (e.g., "United States", "United Kingdom").
mobile_number:
type:
- string
- 'null'
description: The mobile number of the staff member without country code (e.g., "2345678901").
photo_url:
type:
- string
- 'null'
description: The URL to the staff member's profile photo.
default_homepage:
type:
- string
- 'null'
description: Default homepage when the staff member logs in. When null, the system default is used.
enum:
- dashboard
- inbox
- calendar
- clients
- pos
- null
email_signature:
type:
- string
- 'null'
description: The email signature of the staff member.
securitySchemes:
Bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
Business:
type: http
scheme: bearer
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {token}'''
Directory:
type: http
scheme: bearer
description: 'Provide a valid bearer token in the Authorization header. Example: ''Authorization: Bearer {app_token}'''
x-provenance:
method: searched
source: https://developers.intandem.tech:443/reference
harvested: '2026-11-15'
tool: harvest-readme-openapi.py
note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
assembled_from:
- https://developers.intandem.tech/reference/account-creation-1.md
- https://developers.intandem.tech/reference/account-manipulation.md
- https://developers.intandem.tech/reference/addfeaturetofeaturespackages.md
- https://developers.intandem.tech/reference/addremove-staff.md
- https://developers.intandem.tech/reference/business-info.md
- https://developers.intandem.tech/reference/close-an-account.md
- https://developers.intandem.tech/reference/createfeaturespackage.md
- https://developers.intandem.tech/reference/createlicensefeature.md
- https://developers.intandem.tech/reference/createonlineprofile.md
- https://developers.intandem.tech/reference/createquotaconsumption.md
- https://developers.intandem.tech/reference/delete_api-operator-api-v1-features-id.md
- https://developers.intandem.tech/reference/delete_api-operator-api-v1-packages-id.md
- https://developers.intandem.tech/reference/delete_business-accounts-v1-identities.md
- https://developers.intandem.tech/reference/delete_platform-v1-businesses-business-uid-staffs-staff-uid-sessions.md
- https://developers.intandem.tech/reference/delete_platform-v1-businesses-business-uid-staffs-staff-uid.md
- https://developers.intandem.tech/reference/delete_v3-access-control-business-roles-uid.md
- https://developers.intandem.tech/reference/delete_v3-access-control-staff-permission-overrides-lists-staff-uid.md
- https://developers.intandem.tech/reference/delete_v3-license-bundled-offerings-uid.md
- https://developers.intandem.tech/reference/delete_v3-license-directory-offerings-uid.md
- https://developers.intandem.tech/reference/delete_v3-license-offerings-uid.md
- https://developers.intandem.tech/reference/deletefeaturespackage.md
- https://developers.intandem.tech/reference/deletelicensefeature.md
- https://developers.intandem.tech/reference/engagements-report.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-features-id.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-features.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-packages-id.md
- https://developers.intandem.tech/reference/get_api-operator-api-v1-packages.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-attributes.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-branding.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-identities.md
- https://developers.intandem.tech/reference/get_business-accounts-v1-usage-last-3-months-activity.md
- https://developers.intandem.tech/reference/get_business-staffs-v1-daily-staff-sign-ins.md
- https://developers.intandem.tech/reference/get_businesses-validate-login.md
- https://developers.intandem.tech/reference/get_businesses.md
- https://developers.intandem.tech/reference/get_oauth-userinfo.md
- https://developers.intandem.tech/reference/get_platform-v1-business-jobber-executions.md
- https://developers.intandem.tech/reference/get_platform-v1-business-jobber-flows.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-features.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-recurly-data.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-staffs-staff-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-staffs.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-wizards-wizard-name.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid-wizards.md
- https://developers.intandem.tech/reference/get_platform-v1-businesses-business-uid.md
- https://developers.intandem.tech/reference/get_platform-v1-directory-branding.md
# --- truncated at 32 KB (49 KB total) ---
# Full source: https://artifacts.apis.io/vcita/openapi/vcita-staff-member-api-openapi.yml